merge_ats_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23c63df72c335784d48e23f7aea503567c63100e27293774cf847a1a3747b2ef
+  data.tar.gz: 307bf07ff463f556b316038fbf601874771864b889f7575bda77084131c40308
+SHA512:
+  metadata.gz: 484cde5e2ac898fbcba0a90c396341993a6ab2682ce0da22e13e225f4eb59d5c72a2e31a031f8052d9d2b53f665370a25e49c794b53a24ccd66d9f0b5d1ccc7e
+  data.tar.gz: 24585fc52b87d4cc4aa698580cb8734b6c20243e1586efc70a5fc715560fb1a0e0c1a430d7ce095545e64476cbc792de127470fff6fd3647cf0c11872a5647fa

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/README.md

@@ -0,0 +1,208 @@
+# merge_ats_client
+
+MergeATSClient - the Ruby gem for the Merge ATS API
+
+The unified API for building rich integrations with multiple Applicant Tracking System 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_ats_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./merge_ats_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./merge_ats_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_ats_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-ats-ruby, then add the following in the Gemfile:
+
+    gem 'merge_ats_client', :git => 'https://github.com/merge-api/merge-ats-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_ats_client'
+
+# Setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::AccountTokenApi.new
+public_token = 'public_token_example' # String | 
+
+begin
+  result = api_instance.account_token_retrieve(public_token)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Exception when calling AccountTokenApi->account_token_retrieve: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MergeATSClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} | 
+*MergeATSClient::ActivitiesApi* | [**activities_list**](docs/ActivitiesApi.md#activities_list) | **GET** /activities | 
+*MergeATSClient::ActivitiesApi* | [**activities_retrieve**](docs/ActivitiesApi.md#activities_retrieve) | **GET** /activities/{id} | 
+*MergeATSClient::ApplicationsApi* | [**applications_create**](docs/ApplicationsApi.md#applications_create) | **POST** /applications | 
+*MergeATSClient::ApplicationsApi* | [**applications_list**](docs/ApplicationsApi.md#applications_list) | **GET** /applications | 
+*MergeATSClient::ApplicationsApi* | [**applications_partial_update**](docs/ApplicationsApi.md#applications_partial_update) | **PATCH** /applications/{id} | 
+*MergeATSClient::ApplicationsApi* | [**applications_retrieve**](docs/ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} | 
+*MergeATSClient::AttachmentsApi* | [**attachments_list**](docs/AttachmentsApi.md#attachments_list) | **GET** /attachments | 
+*MergeATSClient::AttachmentsApi* | [**attachments_retrieve**](docs/AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} | 
+*MergeATSClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | 
+*MergeATSClient::CandidatesApi* | [**candidates_create**](docs/CandidatesApi.md#candidates_create) | **POST** /candidates | 
+*MergeATSClient::CandidatesApi* | [**candidates_list**](docs/CandidatesApi.md#candidates_list) | **GET** /candidates | 
+*MergeATSClient::CandidatesApi* | [**candidates_retrieve**](docs/CandidatesApi.md#candidates_retrieve) | **GET** /candidates/{id} | 
+*MergeATSClient::DepartmentsApi* | [**departments_list**](docs/DepartmentsApi.md#departments_list) | **GET** /departments | 
+*MergeATSClient::DepartmentsApi* | [**departments_retrieve**](docs/DepartmentsApi.md#departments_retrieve) | **GET** /departments/{id} | 
+*MergeATSClient::EeocsApi* | [**eeocs_list**](docs/EeocsApi.md#eeocs_list) | **GET** /eeocs | 
+*MergeATSClient::EeocsApi* | [**eeocs_retrieve**](docs/EeocsApi.md#eeocs_retrieve) | **GET** /eeocs/{id} | 
+*MergeATSClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key | 
+*MergeATSClient::InterviewsApi* | [**interviews_list**](docs/InterviewsApi.md#interviews_list) | **GET** /interviews | 
+*MergeATSClient::InterviewsApi* | [**interviews_retrieve**](docs/InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} | 
+*MergeATSClient::JobInterviewStagesApi* | [**job_interview_stages_list**](docs/JobInterviewStagesApi.md#job_interview_stages_list) | **GET** /job-interview-stages | 
+*MergeATSClient::JobInterviewStagesApi* | [**job_interview_stages_retrieve**](docs/JobInterviewStagesApi.md#job_interview_stages_retrieve) | **GET** /job-interview-stages/{id} | 
+*MergeATSClient::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /jobs | 
+*MergeATSClient::JobsApi* | [**jobs_retrieve**](docs/JobsApi.md#jobs_retrieve) | **GET** /jobs/{id} | 
+*MergeATSClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token | 
+*MergeATSClient::OffersApi* | [**offers_list**](docs/OffersApi.md#offers_list) | **GET** /offers | 
+*MergeATSClient::OffersApi* | [**offers_retrieve**](docs/OffersApi.md#offers_retrieve) | **GET** /offers/{id} | 
+*MergeATSClient::OfficesApi* | [**offices_list**](docs/OfficesApi.md#offices_list) | **GET** /offices | 
+*MergeATSClient::OfficesApi* | [**offices_retrieve**](docs/OfficesApi.md#offices_retrieve) | **GET** /offices/{id} | 
+*MergeATSClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough | 
+*MergeATSClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key | 
+*MergeATSClient::RejectReasonsApi* | [**reject_reasons_list**](docs/RejectReasonsApi.md#reject_reasons_list) | **GET** /reject-reasons | 
+*MergeATSClient::RejectReasonsApi* | [**reject_reasons_retrieve**](docs/RejectReasonsApi.md#reject_reasons_retrieve) | **GET** /reject-reasons/{id} | 
+*MergeATSClient::ScorecardsApi* | [**scorecards_list**](docs/ScorecardsApi.md#scorecards_list) | **GET** /scorecards | 
+*MergeATSClient::ScorecardsApi* | [**scorecards_retrieve**](docs/ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} | 
+*MergeATSClient::SyncStatusApi* | [**sync_status_retrieve**](docs/SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status | 
+*MergeATSClient::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /tags | 
+*MergeATSClient::UsersApi* | [**users_list**](docs/UsersApi.md#users_list) | **GET** /users | 
+*MergeATSClient::UsersApi* | [**users_retrieve**](docs/UsersApi.md#users_retrieve) | **GET** /users/{id} | 
+
+
+## Documentation for Models
+
+ - [MergeATSClient::AccessRoleEnum](docs/AccessRoleEnum.md)
+ - [MergeATSClient::AccountIntegration](docs/AccountIntegration.md)
+ - [MergeATSClient::AccountToken](docs/AccountToken.md)
+ - [MergeATSClient::Activity](docs/Activity.md)
+ - [MergeATSClient::ActivityTypeEnum](docs/ActivityTypeEnum.md)
+ - [MergeATSClient::Application](docs/Application.md)
+ - [MergeATSClient::ApplicationRequest](docs/ApplicationRequest.md)
+ - [MergeATSClient::Attachment](docs/Attachment.md)
+ - [MergeATSClient::AvailableActions](docs/AvailableActions.md)
+ - [MergeATSClient::Candidate](docs/Candidate.md)
+ - [MergeATSClient::CandidateRequest](docs/CandidateRequest.md)
+ - [MergeATSClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
+ - [MergeATSClient::Department](docs/Department.md)
+ - [MergeATSClient::DisabilityStatusEnum](docs/DisabilityStatusEnum.md)
+ - [MergeATSClient::EEOC](docs/EEOC.md)
+ - [MergeATSClient::EmailAddress](docs/EmailAddress.md)
+ - [MergeATSClient::EmailAddressRequest](docs/EmailAddressRequest.md)
+ - [MergeATSClient::EmailAddressTypeEnum](docs/EmailAddressTypeEnum.md)
+ - [MergeATSClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
+ - [MergeATSClient::GenderEnum](docs/GenderEnum.md)
+ - [MergeATSClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
+ - [MergeATSClient::Job](docs/Job.md)
+ - [MergeATSClient::JobInterviewStage](docs/JobInterviewStage.md)
+ - [MergeATSClient::JobStatusEnum](docs/JobStatusEnum.md)
+ - [MergeATSClient::LinkToken](docs/LinkToken.md)
+ - [MergeATSClient::MethodEnum](docs/MethodEnum.md)
+ - [MergeATSClient::ModelOperation](docs/ModelOperation.md)
+ - [MergeATSClient::Offer](docs/Offer.md)
+ - [MergeATSClient::OfferStatusEnum](docs/OfferStatusEnum.md)
+ - [MergeATSClient::Office](docs/Office.md)
+ - [MergeATSClient::OverallRecommendationEnum](docs/OverallRecommendationEnum.md)
+ - [MergeATSClient::PaginatedActivityList](docs/PaginatedActivityList.md)
+ - [MergeATSClient::PaginatedApplicationList](docs/PaginatedApplicationList.md)
+ - [MergeATSClient::PaginatedAttachmentList](docs/PaginatedAttachmentList.md)
+ - [MergeATSClient::PaginatedCandidateList](docs/PaginatedCandidateList.md)
+ - [MergeATSClient::PaginatedDepartmentList](docs/PaginatedDepartmentList.md)
+ - [MergeATSClient::PaginatedEEOCList](docs/PaginatedEEOCList.md)
+ - [MergeATSClient::PaginatedJobInterviewStageList](docs/PaginatedJobInterviewStageList.md)
+ - [MergeATSClient::PaginatedJobList](docs/PaginatedJobList.md)
+ - [MergeATSClient::PaginatedOfferList](docs/PaginatedOfferList.md)
+ - [MergeATSClient::PaginatedOfficeList](docs/PaginatedOfficeList.md)
+ - [MergeATSClient::PaginatedRejectReasonList](docs/PaginatedRejectReasonList.md)
+ - [MergeATSClient::PaginatedRemoteUserList](docs/PaginatedRemoteUserList.md)
+ - [MergeATSClient::PaginatedScheduledInterviewList](docs/PaginatedScheduledInterviewList.md)
+ - [MergeATSClient::PaginatedScorecardList](docs/PaginatedScorecardList.md)
+ - [MergeATSClient::PaginatedTagList](docs/PaginatedTagList.md)
+ - [MergeATSClient::PatchedApplicationRequest](docs/PatchedApplicationRequest.md)
+ - [MergeATSClient::PhoneNumber](docs/PhoneNumber.md)
+ - [MergeATSClient::PhoneNumberRequest](docs/PhoneNumberRequest.md)
+ - [MergeATSClient::PhoneNumberTypeEnum](docs/PhoneNumberTypeEnum.md)
+ - [MergeATSClient::RaceEnum](docs/RaceEnum.md)
+ - [MergeATSClient::RejectReason](docs/RejectReason.md)
+ - [MergeATSClient::RemoteData](docs/RemoteData.md)
+ - [MergeATSClient::RemoteDataRequest](docs/RemoteDataRequest.md)
+ - [MergeATSClient::RemoteKey](docs/RemoteKey.md)
+ - [MergeATSClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
+ - [MergeATSClient::RemoteResponse](docs/RemoteResponse.md)
+ - [MergeATSClient::RemoteUser](docs/RemoteUser.md)
+ - [MergeATSClient::ScheduledInterview](docs/ScheduledInterview.md)
+ - [MergeATSClient::ScheduledInterviewStatusEnum](docs/ScheduledInterviewStatusEnum.md)
+ - [MergeATSClient::Scorecard](docs/Scorecard.md)
+ - [MergeATSClient::SyncStatus](docs/SyncStatus.md)
+ - [MergeATSClient::Tag](docs/Tag.md)
+ - [MergeATSClient::Url](docs/Url.md)
+ - [MergeATSClient::UrlRequest](docs/UrlRequest.md)
+ - [MergeATSClient::UrlTypeEnum](docs/UrlTypeEnum.md)
+ - [MergeATSClient::VeteranStatusEnum](docs/VeteranStatusEnum.md)
+ - [MergeATSClient::VisibilityEnum](docs/VisibilityEnum.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/config.json

@@ -0,0 +1,2 @@
+{"gemName": "merge_ats_client", "moduleName": "MergeATSClient", "gitHost": "github.com", "gitUserId": "merge-api", "gitRepoId": "merge-ats-ruby"}
+

data/docs/AccessRoleEnum.md

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

data/docs/AccountIntegration.md

@@ -0,0 +1,28 @@
+# MergeATSClient::AccountIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Company name. |  |
+| **categories** | **Array<String>** | Category or categories this integration belongs to. | [optional] |
+| **image** | **String** | Company logo in rectangular shape. | [optional] |
+| **square_image** | **String** | Company logo in square shape. | [optional] |
+| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. | [optional] |
+| **slug** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::AccountIntegration.new(
+  name: null,
+  categories: null,
+  image: null,
+  square_image: null,
+  color: null,
+  slug: null
+)
+```
+

data/docs/AccountToken.md

@@ -0,0 +1,18 @@
+# MergeATSClient::AccountToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::AccountToken.new(
+  account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
+)
+```
+

data/docs/AccountTokenApi.md

@@ -0,0 +1,79 @@
+# MergeATSClient::AccountTokenApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_token_retrieve**](AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |  |
+
+
+## account_token_retrieve
+
+> <AccountToken> account_token_retrieve(public_token)
+
+
+
+Returns the account token for the end user with the provided public token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::AccountTokenApi.new
+public_token = 'public_token_example' # String | 
+
+begin
+  
+  result = api_instance.account_token_retrieve(public_token)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve: #{e}"
+end
+```
+
+#### Using the account_token_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountToken>, Integer, Hash)> account_token_retrieve_with_http_info(public_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.account_token_retrieve_with_http_info(public_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountToken>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_token** | **String** |  |  |
+
+### Return type
+
+[**AccountToken**](AccountToken.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ActivitiesApi.md

@@ -0,0 +1,181 @@
+# MergeATSClient::ActivitiesApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activities_list**](ActivitiesApi.md#activities_list) | **GET** /activities |  |
+| [**activities_retrieve**](ActivitiesApi.md#activities_retrieve) | **GET** /activities/{id} |  |
+
+
+## activities_list
+
+> <PaginatedActivityList> activities_list(x_account_token, opts)
+
+
+
+Returns a list of `Activity` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::ActivitiesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  expand: 'user', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
+  user_id: 'user_id_example' # String | If provided, will only return activities done by this user.
+}
+
+begin
+  
+  result = api_instance.activities_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ActivitiesApi->activities_list: #{e}"
+end
+```
+
+#### Using the activities_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedActivityList>, Integer, Hash)> activities_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.activities_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedActivityList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ActivitiesApi->activities_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+| **user_id** | **String** | If provided, will only return activities done by this user. | [optional] |
+
+### Return type
+
+[**PaginatedActivityList**](PaginatedActivityList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## activities_retrieve
+
+> <Activity> activities_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Activity` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::ActivitiesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'user', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.activities_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ActivitiesApi->activities_retrieve: #{e}"
+end
+```
+
+#### Using the activities_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Activity>, Integer, Hash)> activities_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.activities_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Activity>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ActivitiesApi->activities_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Activity**](Activity.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+