crelate_client 1.0.1

data/docs/CrelateAction.md

@@ -0,0 +1,14 @@
+# CrelateClient::CrelateAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_type** | **Integer** |  | [optional] 
+**sql_statement** | **String** |  | [optional] 
+**sql_parameters** | **Hash<String, Object>** |  | [optional] 
+**entity** | **Hash<String, Object>** |  | [optional] 
+**is_temp_id** | **BOOLEAN** |  | [optional] 
+**skip_dupe_detection** | **BOOLEAN** |  | [optional] 
+**disable_auto_created_or_modified_fields** | **BOOLEAN** |  | [optional] 
+
+

data/docs/CrelateActionPayload.md

@@ -0,0 +1,10 @@
+# CrelateClient::CrelateActionPayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_temp_id_map** | [**Hash<String, CrelateAction>**](CrelateAction.md) |  | [optional] 
+**actions** | [**Array<CrelateAction>**](CrelateAction.md) |  | [optional] 
+**auto_populate_lookups** | **BOOLEAN** |  | [optional] 
+
+

data/docs/CrelateDetails.md

@@ -0,0 +1,10 @@
+# CrelateClient::CrelateDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_id** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/CustomFormCompletedForm.md

@@ -0,0 +1,11 @@
+# CrelateClient::CustomFormCompletedForm
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**experience** | **Hash<String, Object>** |  | [optional] 
+**form_definition** | [**CustomFormDefinition**](CustomFormDefinition.md) |  | [optional] 
+**form** | **Hash<String, Object>** |  | [optional] 
+**form_resposnes** | **Array<Hash<String, Object>>** |  | [optional] 
+
+

data/docs/CustomFormDefinition.md

@@ -0,0 +1,16 @@
+# CrelateClient::CustomFormDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**form_type_id** | [**EntityLookup**](EntityLookup.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**layout** | [**Array<CustomFormLayoutSection>**](CustomFormLayoutSection.md) |  | [optional] 
+**form_field_entities** | **Array<Hash<String, Object>>** |  | [optional] 
+**is_active** | **BOOLEAN** |  | [optional] 
+**color** | **String** |  | [optional] 
+**form_name_prefix** | **String** |  | [optional] 
+**verb_ids** | [**MultiEntityLookup**](MultiEntityLookup.md) |  | [optional] 
+
+

data/docs/CustomFormDefinitionEntities.md

@@ -0,0 +1,9 @@
+# CrelateClient::CustomFormDefinitionEntities
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**form_definition** | **Hash<String, Object>** |  | [optional] 
+**form_fields** | **Array<Hash<String, Object>>** |  | [optional] 
+
+

data/docs/CustomFormFormDefinitionUsage.md

@@ -0,0 +1,10 @@
+# CrelateClient::CustomFormFormDefinitionUsage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobs** | [**Array<CustomFormFormDefintionUsageJobs>**](CustomFormFormDefintionUsageJobs.md) |  | [optional] 
+**verb_ids** | **Array<String>** |  | [optional] 
+**completed_count** | **Integer** |  | [optional] 
+
+

data/docs/CustomFormFormDefintionUsageJobs.md

@@ -0,0 +1,9 @@
+# CrelateClient::CustomFormFormDefintionUsageJobs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/CustomFormFormFieldUsage.md

@@ -0,0 +1,11 @@
+# CrelateClient::CustomFormFormFieldUsage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**form_definitions** | [**Array<CustomFormFormFieldUsageFormDefinition>**](CustomFormFormFieldUsageFormDefinition.md) |  | [optional] 
+**jobs** | [**Array<CustomFormFormDefintionUsageJobs>**](CustomFormFormDefintionUsageJobs.md) |  | [optional] 
+**verb_ids** | **Array<String>** |  | [optional] 
+**completed_count** | **Integer** |  | [optional] 
+
+

data/docs/CustomFormFormFieldUsageFormDefinition.md

@@ -0,0 +1,10 @@
+# CrelateClient::CustomFormFormFieldUsageFormDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**form_type_id** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/CustomFormLayoutSection.md

@@ -0,0 +1,9 @@
+# CrelateClient::CustomFormLayoutSection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**form_fields** | **Array<String>** |  | [optional] 
+
+

data/docs/CustomFormSaveResponse.md

@@ -0,0 +1,12 @@
+# CrelateClient::CustomFormSaveResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**status_code** | **Integer** |  | [optional] 
+**message** | **String** |  | [optional] 
+**usage** | [**CustomFormFormDefinitionUsage**](CustomFormFormDefinitionUsage.md) |  | [optional] 
+**form_responses** | **Array<Hash<String, Object>>** |  | [optional] 
+
+

data/docs/DocumentCollection.md

@@ -0,0 +1,10 @@
+# CrelateClient::DocumentCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attachments** | [**Array<DocumentItem>**](DocumentItem.md) |  | [optional] 
+**applications** | [**Array<DocumentItem>**](DocumentItem.md) |  | [optional] 
+**forms** | [**Array<DocumentItem>**](DocumentItem.md) |  | [optional] 
+
+

data/docs/DocumentItem.md

@@ -0,0 +1,22 @@
+# CrelateClient::DocumentItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**type** | [**EntityLookup**](EntityLookup.md) |  | [optional] 
+**title** | **String** |  | [optional] 
+**created_on** | **DateTime** |  | [optional] 
+**modified_on** | **DateTime** |  | [optional] 
+**file_size** | **Integer** |  | [optional] 
+**is_image** | **BOOLEAN** |  | [optional] 
+**is_document** | **BOOLEAN** |  | [optional] 
+**is_audio** | **BOOLEAN** |  | [optional] 
+**content_type** | **String** |  | [optional] 
+**entity_name** | **String** |  | [optional] 
+**color** | **String** |  | [optional] 
+**text_color** | **String** |  | [optional] 
+**being_edited_by_user** | **String** |  | [optional] 
+**additional_info** | **Hash<String, Object>** |  | [optional] 
+
+

data/docs/DomainApi.md

@@ -0,0 +1,198 @@
+# CrelateClient::DomainApi
+
+All URIs are relative to *https://app.crelate.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**public_api_get_document_types**](DomainApi.md#public_api_get_document_types) | **GET** /api/pub/v1/domain/documentTypes | returns a list of attachment types
+[**public_api_get_domain_category_tags**](DomainApi.md#public_api_get_domain_category_tags) | **GET** /api/pub/v1/domain/tagCategories | get category tags
+[**public_api_get_domain_workflow_statuses**](DomainApi.md#public_api_get_domain_workflow_statuses) | **GET** /api/pub/v1/domain/workflowStatuses | get workflow status information
+[**public_api_get_domain_workflow_types**](DomainApi.md#public_api_get_domain_workflow_types) | **GET** /api/pub/v1/domain/workflowTypes | get workflow types
+
+
+# **public_api_get_document_types**
+> Array<PublicApiDocumentType> public_api_get_document_types(api_key)
+
+returns a list of attachment types
+
+### Example
+```ruby
+# load the gem
+require 'crelate_client'
+
+api_instance = CrelateClient::DomainApi.new
+
+api_key = "api_key_example" # String | crelate api_key
+
+
+begin
+  #returns a list of attachment types
+  result = api_instance.public_api_get_document_types(api_key)
+  p result
+rescue CrelateClient::ApiError => e
+  puts "Exception when calling DomainApi->public_api_get_document_types: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| crelate api_key | 
+
+### Return type
+
+[**Array<PublicApiDocumentType>**](PublicApiDocumentType.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json
+
+
+
+# **public_api_get_domain_category_tags**
+> Array<PublicApiTagCategory> public_api_get_domain_category_tags(api_key)
+
+get category tags
+
+
+
+### Example
+```ruby
+# load the gem
+require 'crelate_client'
+
+api_instance = CrelateClient::DomainApi.new
+
+api_key = "api_key_example" # String | crelate api key
+
+
+begin
+  #get category tags
+  result = api_instance.public_api_get_domain_category_tags(api_key)
+  p result
+rescue CrelateClient::ApiError => e
+  puts "Exception when calling DomainApi->public_api_get_domain_category_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| crelate api key | 
+
+### Return type
+
+[**Array<PublicApiTagCategory>**](PublicApiTagCategory.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json
+
+
+
+# **public_api_get_domain_workflow_statuses**
+> Array<PublicApiWorkflowStatus> public_api_get_domain_workflow_statuses(api_key)
+
+get workflow status information
+
+
+
+### Example
+```ruby
+# load the gem
+require 'crelate_client'
+
+api_instance = CrelateClient::DomainApi.new
+
+api_key = "api_key_example" # String | crelate api key
+
+
+begin
+  #get workflow status information
+  result = api_instance.public_api_get_domain_workflow_statuses(api_key)
+  p result
+rescue CrelateClient::ApiError => e
+  puts "Exception when calling DomainApi->public_api_get_domain_workflow_statuses: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| crelate api key | 
+
+### Return type
+
+[**Array<PublicApiWorkflowStatus>**](PublicApiWorkflowStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json
+
+
+
+# **public_api_get_domain_workflow_types**
+> Array<PublicApiWorkflowType> public_api_get_domain_workflow_types(api_key)
+
+get workflow types
+
+
+
+### Example
+```ruby
+# load the gem
+require 'crelate_client'
+
+api_instance = CrelateClient::DomainApi.new
+
+api_key = "api_key_example" # String | crelate api key
+
+
+begin
+  #get workflow types
+  result = api_instance.public_api_get_domain_workflow_types(api_key)
+  p result
+rescue CrelateClient::ApiError => e
+  puts "Exception when calling DomainApi->public_api_get_domain_workflow_types: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| crelate api key | 
+
+### Return type
+
+[**Array<PublicApiWorkflowType>**](PublicApiWorkflowType.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json
+
+
+

data/docs/EmailAttachment.md

@@ -0,0 +1,9 @@
+# CrelateClient::EmailAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+
+

data/docs/EntityDocumentOptions.md

@@ -0,0 +1,8 @@
+# CrelateClient::EntityDocumentOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timezone_offset_minutes** | **Integer** |  | [optional] 
+
+

data/docs/EntityLookup.md

@@ -0,0 +1,15 @@
+# CrelateClient::EntityLookup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **Integer** |  | [optional] 
+**id** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**details** | **Hash<String, Object>** |  | [optional] 
+**tag_category_id** | **String** |  | [optional] 
+**attachment_type_id** | **String** |  | [optional] 
+**auto_link_to_parent_payload_entity** | **BOOLEAN** |  | [optional] 
+**create_lookup_entity** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ExtIntegrationResponseInterviewResponse.md

@@ -0,0 +1,11 @@
+# CrelateClient::ExtIntegrationResponseInterviewResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **BOOLEAN** |  | [optional] 
+**error** | **BOOLEAN** |  | [optional] 
+**message** | **String** |  | [optional] 
+**data** | [**Array<SparkHireResponseInfoInterviewResponse>**](SparkHireResponseInfoInterviewResponse.md) |  | [optional] 
+
+

data/docs/ExtReferralRequest.md

@@ -0,0 +1,12 @@
+# CrelateClient::ExtReferralRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_name** | **String** |  | [optional] 
+**company_name** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+
+

data/docs/ExtResumeCandidate.md

@@ -0,0 +1,21 @@
+# CrelateClient::ExtResumeCandidate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | [optional] 
+**hometown** | **String** |  | [optional] 
+**latest_job_title** | **String** |  | [optional] 
+**max_salary** | **String** |  | [optional] 
+**min_salary** | **String** |  | [optional] 
+**modified_on** | **DateTime** |  | [optional] 
+**previous_job_titles** | **Array<String>** |  | [optional] 
+**skills** | **Array<String>** |  | [optional] 
+**source** | **Integer** |  | [optional] 
+**source_name** | **String** |  | [optional] 
+**summary** | **String** |  | [optional] 
+**token** | **String** |  | [optional] 
+**unlock_status** | **String** |  | [optional] 
+**willing_to_relocate** | **String** |  | [optional] 
+
+

data/docs/ExtResumeCareerBuilderValidateCredentialsResponse.md

@@ -0,0 +1,9 @@
+# CrelateClient::ExtResumeCareerBuilderValidateCredentialsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fail_reason** | **String** |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ExtResumeOrgState.md

@@ -0,0 +1,27 @@
+# CrelateClient::ExtResumeOrgState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**career_builder_activated** | **BOOLEAN** |  | [optional] 
+**career_builder_password** | **String** |  | [optional] 
+**career_builder_username** | **String** |  | [optional] 
+**credits** | **Integer** |  | [optional] 
+**eligible** | **BOOLEAN** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**last_recharge_on** | **DateTime** |  | [optional] 
+**name** | **String** |  | [optional] 
+**package_activated** | **BOOLEAN** |  | [optional] 
+**package_id** | **String** |  | [optional] 
+**package_status** | **Integer** |  | [optional] 
+**package_status_name** | **String** |  | [optional] 
+**recharge_behavior** | **Integer** |  | [optional] 
+**recharge_behavior_name** | **String** |  | [optional] 
+**recharge_product_id** | **Integer** |  | [optional] 
+**recharge_quantity** | **Integer** |  | [optional] 
+**recharge_total** | **Float** |  | [optional] 
+**remaining_credits** | **Integer** |  | [optional] 
+**used_credits** | **Integer** |  | [optional] 
+
+

data/docs/ExtResumePackagePricing.md

@@ -0,0 +1,11 @@
+# CrelateClient::ExtResumePackagePricing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_id** | **Integer** |  | [optional] 
+**quantity** | **Integer** |  | [optional] 
+**rate** | **Float** |  | [optional] 
+**total** | **Float** |  | [optional] 
+
+

data/docs/ExtResumePackageUpdateRequest.md

@@ -0,0 +1,9 @@
+# CrelateClient::ExtResumePackageUpdateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recharge_behavior** | **Integer** |  | [optional] 
+**recharge_product_id** | **Integer** |  | [optional] 
+
+

data/docs/ExtResumeSearchResponse.md

@@ -0,0 +1,9 @@
+# CrelateClient::ExtResumeSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**candidates** | [**Array<ExtResumeCandidate>**](ExtResumeCandidate.md) |  | [optional] 
+**more** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ExtResumeViewResponse.md

@@ -0,0 +1,30 @@
+# CrelateClient::ExtResumeViewResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** |  | [optional] 
+**desired_job_title** | **String** |  | [optional] 
+**drivers_license** | **BOOLEAN** |  | [optional] 
+**educational_level** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**job_type** | **String** |  | [optional] 
+**last_updated_utc** | **String** |  | [optional] 
+**latest_job_title** | **String** |  | [optional] 
+**latitude** | **Float** |  | [optional] 
+**locality** | **String** |  | [optional] 
+**longitude** | **Float** |  | [optional] 
+**max_expected_salary** | **String** |  | [optional] 
+**min_expected_salary** | **String** |  | [optional] 
+**skills** | **Array<String>** |  | [optional] 
+**source** | **Integer** |  | [optional] 
+**source_name** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**token** | **String** |  | [optional] 
+**willing_to_relocate** | **String** |  | [optional] 
+**willing_to_travel** | **Integer** |  | [optional] 
+**work_experience** | **String** |  | [optional] 
+**zip** | **String** |  | [optional] 
+
+

data/docs/FusebillStateItem.md

@@ -0,0 +1,9 @@
+# CrelateClient::FusebillStateItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/GetDocumentListOptions.md

@@ -0,0 +1,10 @@
+# CrelateClient::GetDocumentListOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**types** | **Array<Integer>** |  | [optional] 
+**attachment_types** | **Array<String>** |  | [optional] 
+**attachments_filter** | **String** |  | [optional] 
+
+

data/docs/InterviewRequest.md

@@ -0,0 +1,9 @@
+# CrelateClient::InterviewRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**interview_request_details** | [**InterviewRequestDetails**](InterviewRequestDetails.md) |  | [optional] 
+**crelate_details** | [**Array<CrelateDetails>**](CrelateDetails.md) |  | [optional] 
+
+

data/docs/InterviewRequestDetails.md

@@ -0,0 +1,15 @@
+# CrelateClient::InterviewRequestDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**scheduled_at** | **DateTime** |  | [optional] 
+**assigned_to** | [**Array<AssignedToRequest>**](AssignedToRequest.md) |  | [optional] 
+**email_message** | **String** |  | [optional] 
+**job_post** | [**JobPostRequest**](JobPostRequest.md) |  | [optional] 
+**questions** | [**Array<Question>**](Question.md) |  | [optional] 
+**interview_question_set** | **String** |  | [optional] 
+**timezone** | **String** |  | [optional] 
+
+

data/docs/InterviewResponse.md

@@ -0,0 +1,18 @@
+# CrelateClient::InterviewResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+**job_post** | [**JobResponse**](JobResponse.md) |  | [optional] 
+**share_link** | [**ShareLink**](ShareLink.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**scheduled_at** | **DateTime** |  | [optional] 
+**completed_at** | **DateTime** |  | [optional] 
+**assigned_to** | [**AssignedTo**](AssignedTo.md) |  | [optional] 
+**uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/JobPostRequest.md

@@ -0,0 +1,9 @@
+# CrelateClient::JobPostRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+