crelate_client 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/README.md +267 -0
- data/Rakefile +8 -0
- data/crelate_client-1.0.0.gem +0 -0
- data/crelate_client.gemspec +45 -0
- data/docs/AssignedTo.md +11 -0
- data/docs/AssignedToRequest.md +9 -0
- data/docs/BoardParameters.md +9 -0
- data/docs/BroadcastMessage.md +15 -0
- data/docs/BroadcastMessageCreateRequest.md +9 -0
- data/docs/CompaniesApi.md +921 -0
- data/docs/Company.md +11 -0
- data/docs/ComplianceSettingsPayload.md +8 -0
- data/docs/ConsentRequestPayload.md +9 -0
- data/docs/ContactsApi.md +1246 -0
- data/docs/CrelateAction.md +14 -0
- data/docs/CrelateActionPayload.md +10 -0
- data/docs/CrelateDetails.md +10 -0
- data/docs/CustomFormCompletedForm.md +11 -0
- data/docs/CustomFormDefinition.md +16 -0
- data/docs/CustomFormDefinitionEntities.md +9 -0
- data/docs/CustomFormFormDefinitionUsage.md +10 -0
- data/docs/CustomFormFormDefintionUsageJobs.md +9 -0
- data/docs/CustomFormFormFieldUsage.md +11 -0
- data/docs/CustomFormFormFieldUsageFormDefinition.md +10 -0
- data/docs/CustomFormLayoutSection.md +9 -0
- data/docs/CustomFormSaveResponse.md +12 -0
- data/docs/DocumentCollection.md +10 -0
- data/docs/DocumentItem.md +22 -0
- data/docs/DomainApi.md +198 -0
- data/docs/EmailAttachment.md +9 -0
- data/docs/EntityDocumentOptions.md +8 -0
- data/docs/EntityLookup.md +15 -0
- data/docs/ExtIntegrationResponseInterviewResponse.md +11 -0
- data/docs/ExtReferralRequest.md +12 -0
- data/docs/ExtResumeCandidate.md +21 -0
- data/docs/ExtResumeCareerBuilderValidateCredentialsResponse.md +9 -0
- data/docs/ExtResumeOrgState.md +27 -0
- data/docs/ExtResumePackagePricing.md +11 -0
- data/docs/ExtResumePackageUpdateRequest.md +9 -0
- data/docs/ExtResumeSearchResponse.md +9 -0
- data/docs/ExtResumeViewResponse.md +30 -0
- data/docs/FusebillStateItem.md +9 -0
- data/docs/GetDocumentListOptions.md +10 -0
- data/docs/InterviewRequest.md +9 -0
- data/docs/InterviewRequestDetails.md +15 -0
- data/docs/InterviewResponse.md +18 -0
- data/docs/JobPostRequest.md +9 -0
- data/docs/JobPostingsApi.md +378 -0
- data/docs/JobResponse.md +15 -0
- data/docs/JobsApi.md +1197 -0
- data/docs/MultiEntityLookup.md +8 -0
- data/docs/NotesApi.md +215 -0
- data/docs/OrgAuditLogEvent.md +22 -0
- data/docs/PostPurchaseRequest.md +12 -0
- data/docs/PublicApiAttachmentResponse.md +19 -0
- data/docs/PublicApiAttachmentResponseList.md +9 -0
- data/docs/PublicApiDocumentType.md +10 -0
- data/docs/PublicApiGetAccountResponse.md +85 -0
- data/docs/PublicApiGetAccountResponseList.md +9 -0
- data/docs/PublicApiGetContactJob.md +13 -0
- data/docs/PublicApiGetContactResponse.md +151 -0
- data/docs/PublicApiGetContactResponseList.md +9 -0
- data/docs/PublicApiGetJobContact.md +13 -0
- data/docs/PublicApiGetJobListResponse.md +9 -0
- data/docs/PublicApiGetJobPostingListResponse.md +9 -0
- data/docs/PublicApiGetJobPostingResponse.md +29 -0
- data/docs/PublicApiGetJobPostingSearchResponse.md +8 -0
- data/docs/PublicApiGetJobPostingSearchResult.md +18 -0
- data/docs/PublicApiGetJobResponse.md +127 -0
- data/docs/PublicApiGetNoteResponse.md +21 -0
- data/docs/PublicApiGetTaskResponse.md +23 -0
- data/docs/PublicApiIdResponse.md +8 -0
- data/docs/PublicApiPlacementResponse.md +32 -0
- data/docs/PublicApiPlacementResponseList.md +9 -0
- data/docs/PublicApiRecordOwner.md +10 -0
- data/docs/PublicApiSaveAccountRequest.md +74 -0
- data/docs/PublicApiSaveAttachmentRequest.md +13 -0
- data/docs/PublicApiSaveContactRequest.md +139 -0
- data/docs/PublicApiSaveJobApplicationRequest.md +13 -0
- data/docs/PublicApiSaveJobPostingRequest.md +19 -0
- data/docs/PublicApiSaveJobRequest.md +95 -0
- data/docs/PublicApiSaveJobRequestJobType.md +9 -0
- data/docs/PublicApiSaveNoteRequest.md +11 -0
- data/docs/PublicApiSaveTaskRequest.md +13 -0
- data/docs/PublicApiSaveWorkflowItemStatusRequest.md +9 -0
- data/docs/PublicApiTagCategory.md +9 -0
- data/docs/PublicApiWorkflowStatus.md +12 -0
- data/docs/PublicApiWorkflowType.md +9 -0
- data/docs/Question.md +13 -0
- data/docs/QuestionSetResponse.md +12 -0
- data/docs/SaveExtCredentialResponse.md +10 -0
- data/docs/SearchContact.md +11 -0
- data/docs/SendEmailResponse.md +13 -0
- data/docs/SendSubmittalDetail.md +11 -0
- data/docs/ShareLink.md +13 -0
- data/docs/SignupInformation.md +19 -0
- data/docs/SmsPlivoMessageReceivedRequest.md +15 -0
- data/docs/SmsPlivoMessageStatusReceivedRequest.md +17 -0
- data/docs/SmsPlivoVoiceAnswerRequest.md +13 -0
- data/docs/SmsPlivoVoiceHangupRequest.md +19 -0
- data/docs/SparkHireResponseInfoInterviewResponse.md +11 -0
- data/docs/SparkHireResponseInfoJobResponse.md +11 -0
- data/docs/SparkHireResponseInfoQuestionSetResponse.md +11 -0
- data/docs/TasksApi.md +215 -0
- data/docs/UserResponse.md +12 -0
- data/docs/WayupData.md +15 -0
- data/docs/WebhookDeleteResponse.md +8 -0
- data/docs/ZipApplyData.md +15 -0
- data/git_push.sh +55 -0
- data/lib/.DS_Store +0 -0
- data/lib/crelate_client/.DS_Store +0 -0
- data/lib/crelate_client/api/companies_api.rb +1151 -0
- data/lib/crelate_client/api/contacts_api.rb +1552 -0
- data/lib/crelate_client/api/domain_api.rb +239 -0
- data/lib/crelate_client/api/job_postings_api.rb +467 -0
- data/lib/crelate_client/api/jobs_api.rb +1494 -0
- data/lib/crelate_client/api/notes_api.rb +273 -0
- data/lib/crelate_client/api/tasks_api.rb +273 -0
- data/lib/crelate_client/api_client.rb +388 -0
- data/lib/crelate_client/api_error.rb +38 -0
- data/lib/crelate_client/configuration.rb +202 -0
- data/lib/crelate_client/models/assigned_to.rb +215 -0
- data/lib/crelate_client/models/assigned_to_request.rb +197 -0
- data/lib/crelate_client/models/board_parameters.rb +199 -0
- data/lib/crelate_client/models/broadcast_message.rb +284 -0
- data/lib/crelate_client/models/broadcast_message_create_request.rb +197 -0
- data/lib/crelate_client/models/company.rb +215 -0
- data/lib/crelate_client/models/compliance_settings_payload.rb +188 -0
- data/lib/crelate_client/models/consent_request_payload.rb +197 -0
- data/lib/crelate_client/models/crelate_action.rb +279 -0
- data/lib/crelate_client/models/crelate_action_payload.rb +210 -0
- data/lib/crelate_client/models/crelate_details.rb +206 -0
- data/lib/crelate_client/models/custom_form_completed_form.rb +221 -0
- data/lib/crelate_client/models/custom_form_definition.rb +264 -0
- data/lib/crelate_client/models/custom_form_definition_entities.rb +201 -0
- data/lib/crelate_client/models/custom_form_form_definition_usage.rb +210 -0
- data/lib/crelate_client/models/custom_form_form_defintion_usage_jobs.rb +197 -0
- data/lib/crelate_client/models/custom_form_form_field_usage.rb +221 -0
- data/lib/crelate_client/models/custom_form_form_field_usage_form_definition.rb +206 -0
- data/lib/crelate_client/models/custom_form_layout_section.rb +199 -0
- data/lib/crelate_client/models/custom_form_save_response.rb +259 -0
- data/lib/crelate_client/models/document_collection.rb +212 -0
- data/lib/crelate_client/models/document_item.rb +316 -0
- data/lib/crelate_client/models/email_attachment.rb +213 -0
- data/lib/crelate_client/models/entity_document_options.rb +188 -0
- data/lib/crelate_client/models/entity_lookup.rb +286 -0
- data/lib/crelate_client/models/ext_integration_response_interview_response.rb +217 -0
- data/lib/crelate_client/models/ext_referral_request.rb +224 -0
- data/lib/crelate_client/models/ext_resume_candidate.rb +342 -0
- data/lib/crelate_client/models/ext_resume_career_builder_validate_credentials_response.rb +197 -0
- data/lib/crelate_client/models/ext_resume_org_state.rb +404 -0
- data/lib/crelate_client/models/ext_resume_package_pricing.rb +215 -0
- data/lib/crelate_client/models/ext_resume_package_update_request.rb +230 -0
- data/lib/crelate_client/models/ext_resume_search_response.rb +199 -0
- data/lib/crelate_client/models/ext_resume_view_response.rb +421 -0
- data/lib/crelate_client/models/fusebill_state_item.rb +197 -0
- data/lib/crelate_client/models/get_document_list_options.rb +231 -0
- data/lib/crelate_client/models/interview_request.rb +199 -0
- data/lib/crelate_client/models/interview_request_details.rb +255 -0
- data/lib/crelate_client/models/interview_response.rb +311 -0
- data/lib/crelate_client/models/job_post_request.rb +197 -0
- data/lib/crelate_client/models/job_response.rb +251 -0
- data/lib/crelate_client/models/multi_entity_lookup.rb +190 -0
- data/lib/crelate_client/models/org_audit_log_event.rb +314 -0
- data/lib/crelate_client/models/post_purchase_request.rb +224 -0
- data/lib/crelate_client/models/public_api_attachment_response.rb +287 -0
- data/lib/crelate_client/models/public_api_attachment_response_list.rb +199 -0
- data/lib/crelate_client/models/public_api_document_type.rb +208 -0
- data/lib/crelate_client/models/public_api_get_account_response.rb +889 -0
- data/lib/crelate_client/models/public_api_get_account_response_list.rb +199 -0
- data/lib/crelate_client/models/public_api_get_contact_job.rb +233 -0
- data/lib/crelate_client/models/public_api_get_contact_response.rb +1485 -0
- data/lib/crelate_client/models/public_api_get_contact_response_list.rb +199 -0
- data/lib/crelate_client/models/public_api_get_job_contact.rb +233 -0
- data/lib/crelate_client/models/public_api_get_job_list_response.rb +199 -0
- data/lib/crelate_client/models/public_api_get_job_posting_list_response.rb +199 -0
- data/lib/crelate_client/models/public_api_get_job_posting_response.rb +379 -0
- data/lib/crelate_client/models/public_api_get_job_posting_search_response.rb +190 -0
- data/lib/crelate_client/models/public_api_get_job_posting_search_result.rb +278 -0
- data/lib/crelate_client/models/public_api_get_job_response.rb +1267 -0
- data/lib/crelate_client/models/public_api_get_note_response.rb +307 -0
- data/lib/crelate_client/models/public_api_get_task_response.rb +325 -0
- data/lib/crelate_client/models/public_api_id_response.rb +188 -0
- data/lib/crelate_client/models/public_api_placement_response.rb +404 -0
- data/lib/crelate_client/models/public_api_placement_response_list.rb +199 -0
- data/lib/crelate_client/models/public_api_record_owner.rb +206 -0
- data/lib/crelate_client/models/public_api_save_account_request.rb +786 -0
- data/lib/crelate_client/models/public_api_save_attachment_request.rb +233 -0
- data/lib/crelate_client/models/public_api_save_contact_request.rb +1373 -0
- data/lib/crelate_client/models/public_api_save_job_application_request.rb +233 -0
- data/lib/crelate_client/models/public_api_save_job_posting_request.rb +287 -0
- data/lib/crelate_client/models/public_api_save_job_request.rb +975 -0
- data/lib/crelate_client/models/public_api_save_job_request_job_type.rb +197 -0
- data/lib/crelate_client/models/public_api_save_note_request.rb +215 -0
- data/lib/crelate_client/models/public_api_save_task_request.rb +233 -0
- data/lib/crelate_client/models/public_api_save_workflow_item_status_request.rb +197 -0
- data/lib/crelate_client/models/public_api_tag_category.rb +197 -0
- data/lib/crelate_client/models/public_api_workflow_status.rb +224 -0
- data/lib/crelate_client/models/public_api_workflow_type.rb +197 -0
- data/lib/crelate_client/models/question.rb +233 -0
- data/lib/crelate_client/models/question_set_response.rb +226 -0
- data/lib/crelate_client/models/save_ext_credential_response.rb +206 -0
- data/lib/crelate_client/models/search_contact.rb +215 -0
- data/lib/crelate_client/models/send_email_response.rb +235 -0
- data/lib/crelate_client/models/send_submittal_detail.rb +217 -0
- data/lib/crelate_client/models/share_link.rb +266 -0
- data/lib/crelate_client/models/signup_information.rb +287 -0
- data/lib/crelate_client/models/sms_plivo_message_received_request.rb +251 -0
- data/lib/crelate_client/models/sms_plivo_message_status_received_request.rb +269 -0
- data/lib/crelate_client/models/sms_plivo_voice_answer_request.rb +233 -0
- data/lib/crelate_client/models/sms_plivo_voice_hangup_request.rb +287 -0
- data/lib/crelate_client/models/spark_hire_response_info_interview_response.rb +215 -0
- data/lib/crelate_client/models/spark_hire_response_info_job_response.rb +215 -0
- data/lib/crelate_client/models/spark_hire_response_info_question_set_response.rb +215 -0
- data/lib/crelate_client/models/user_response.rb +224 -0
- data/lib/crelate_client/models/wayup_data.rb +267 -0
- data/lib/crelate_client/models/webhook_delete_response.rb +188 -0
- data/lib/crelate_client/models/zip_apply_data.rb +267 -0
- data/lib/crelate_client/version.rb +15 -0
- data/lib/crelate_client.rb +143 -0
- data/spec/api/companies_api_spec.rb +273 -0
- data/spec/api/contacts_api_spec.rb +358 -0
- data/spec/api/domain_api_spec.rb +83 -0
- data/spec/api/job_postings_api_spec.rb +131 -0
- data/spec/api/jobs_api_spec.rb +346 -0
- data/spec/api/notes_api_spec.rb +88 -0
- data/spec/api/tasks_api_spec.rb +88 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/assigned_to_request_spec.rb +48 -0
- data/spec/models/assigned_to_spec.rb +60 -0
- data/spec/models/board_parameters_spec.rb +48 -0
- data/spec/models/broadcast_message_create_request_spec.rb +48 -0
- data/spec/models/broadcast_message_spec.rb +88 -0
- data/spec/models/company_spec.rb +60 -0
- data/spec/models/compliance_settings_payload_spec.rb +42 -0
- data/spec/models/consent_request_payload_spec.rb +48 -0
- data/spec/models/crelate_action_payload_spec.rb +54 -0
- data/spec/models/crelate_action_spec.rb +82 -0
- data/spec/models/crelate_details_spec.rb +54 -0
- data/spec/models/custom_form_completed_form_spec.rb +60 -0
- data/spec/models/custom_form_definition_entities_spec.rb +48 -0
- data/spec/models/custom_form_definition_spec.rb +90 -0
- data/spec/models/custom_form_form_definition_usage_spec.rb +54 -0
- data/spec/models/custom_form_form_defintion_usage_jobs_spec.rb +48 -0
- data/spec/models/custom_form_form_field_usage_form_definition_spec.rb +54 -0
- data/spec/models/custom_form_form_field_usage_spec.rb +60 -0
- data/spec/models/custom_form_layout_section_spec.rb +48 -0
- data/spec/models/custom_form_save_response_spec.rb +70 -0
- data/spec/models/document_collection_spec.rb +54 -0
- data/spec/models/document_item_spec.rb +126 -0
- data/spec/models/email_attachment_spec.rb +48 -0
- data/spec/models/entity_document_options_spec.rb +42 -0
- data/spec/models/entity_lookup_spec.rb +88 -0
- data/spec/models/ext_integration_response_interview_response_spec.rb +60 -0
- data/spec/models/ext_referral_request_spec.rb +66 -0
- data/spec/models/ext_resume_candidate_spec.rb +124 -0
- data/spec/models/ext_resume_career_builder_validate_credentials_response_spec.rb +48 -0
- data/spec/models/ext_resume_org_state_spec.rb +164 -0
- data/spec/models/ext_resume_package_pricing_spec.rb +60 -0
- data/spec/models/ext_resume_package_update_request_spec.rb +52 -0
- data/spec/models/ext_resume_search_response_spec.rb +48 -0
- data/spec/models/ext_resume_view_response_spec.rb +178 -0
- data/spec/models/fusebill_state_item_spec.rb +48 -0
- data/spec/models/get_document_list_options_spec.rb +58 -0
- data/spec/models/interview_request_details_spec.rb +84 -0
- data/spec/models/interview_request_spec.rb +48 -0
- data/spec/models/interview_response_spec.rb +106 -0
- data/spec/models/job_post_request_spec.rb +48 -0
- data/spec/models/job_response_spec.rb +84 -0
- data/spec/models/multi_entity_lookup_spec.rb +42 -0
- data/spec/models/org_audit_log_event_spec.rb +126 -0
- data/spec/models/post_purchase_request_spec.rb +66 -0
- data/spec/models/public_api_attachment_response_list_spec.rb +48 -0
- data/spec/models/public_api_attachment_response_spec.rb +108 -0
- data/spec/models/public_api_document_type_spec.rb +54 -0
- data/spec/models/public_api_get_account_response_list_spec.rb +48 -0
- data/spec/models/public_api_get_account_response_spec.rb +504 -0
- data/spec/models/public_api_get_contact_job_spec.rb +72 -0
- data/spec/models/public_api_get_contact_response_list_spec.rb +48 -0
- data/spec/models/public_api_get_contact_response_spec.rb +900 -0
- data/spec/models/public_api_get_job_contact_spec.rb +72 -0
- data/spec/models/public_api_get_job_list_response_spec.rb +48 -0
- data/spec/models/public_api_get_job_posting_list_response_spec.rb +48 -0
- data/spec/models/public_api_get_job_posting_response_spec.rb +168 -0
- data/spec/models/public_api_get_job_posting_search_response_spec.rb +42 -0
- data/spec/models/public_api_get_job_posting_search_result_spec.rb +102 -0
- data/spec/models/public_api_get_job_response_spec.rb +756 -0
- data/spec/models/public_api_get_note_response_spec.rb +120 -0
- data/spec/models/public_api_get_task_response_spec.rb +132 -0
- data/spec/models/public_api_id_response_spec.rb +42 -0
- data/spec/models/public_api_placement_response_list_spec.rb +48 -0
- data/spec/models/public_api_placement_response_spec.rb +186 -0
- data/spec/models/public_api_record_owner_spec.rb +54 -0
- data/spec/models/public_api_save_account_request_spec.rb +438 -0
- data/spec/models/public_api_save_attachment_request_spec.rb +72 -0
- data/spec/models/public_api_save_contact_request_spec.rb +828 -0
- data/spec/models/public_api_save_job_application_request_spec.rb +72 -0
- data/spec/models/public_api_save_job_posting_request_spec.rb +108 -0
- data/spec/models/public_api_save_job_request_job_type_spec.rb +48 -0
- data/spec/models/public_api_save_job_request_spec.rb +564 -0
- data/spec/models/public_api_save_note_request_spec.rb +60 -0
- data/spec/models/public_api_save_task_request_spec.rb +72 -0
- data/spec/models/public_api_save_workflow_item_status_request_spec.rb +48 -0
- data/spec/models/public_api_tag_category_spec.rb +48 -0
- data/spec/models/public_api_workflow_status_spec.rb +66 -0
- data/spec/models/public_api_workflow_type_spec.rb +48 -0
- data/spec/models/question_set_response_spec.rb +66 -0
- data/spec/models/question_spec.rb +72 -0
- data/spec/models/save_ext_credential_response_spec.rb +54 -0
- data/spec/models/search_contact_spec.rb +60 -0
- data/spec/models/send_email_response_spec.rb +72 -0
- data/spec/models/send_submittal_detail_spec.rb +60 -0
- data/spec/models/share_link_spec.rb +76 -0
- data/spec/models/signup_information_spec.rb +108 -0
- data/spec/models/sms_plivo_message_received_request_spec.rb +84 -0
- data/spec/models/sms_plivo_message_status_received_request_spec.rb +96 -0
- data/spec/models/sms_plivo_voice_answer_request_spec.rb +72 -0
- data/spec/models/sms_plivo_voice_hangup_request_spec.rb +108 -0
- data/spec/models/spark_hire_response_info_interview_response_spec.rb +60 -0
- data/spec/models/spark_hire_response_info_job_response_spec.rb +60 -0
- data/spec/models/spark_hire_response_info_question_set_response_spec.rb +60 -0
- data/spec/models/user_response_spec.rb +66 -0
- data/spec/models/wayup_data_spec.rb +84 -0
- data/spec/models/webhook_delete_response_spec.rb +42 -0
- data/spec/models/zip_apply_data_spec.rb +84 -0
- data/spec/spec_helper.rb +111 -0
- metadata +654 -0
data/docs/NotesApi.md
ADDED
@@ -0,0 +1,215 @@
|
|
1
|
+
# CrelateClient::NotesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://app.crelate.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**public_api_delete_note**](NotesApi.md#public_api_delete_note) | **DELETE** /api/pub/v1/notes/{noteId} | delete a note
|
8
|
+
[**public_api_get_note**](NotesApi.md#public_api_get_note) | **GET** /api/pub/v1/notes/{noteId} | retrieve a note
|
9
|
+
[**public_api_post_note**](NotesApi.md#public_api_post_note) | **POST** /api/pub/v1/notes | create a note
|
10
|
+
[**public_api_put_note**](NotesApi.md#public_api_put_note) | **PUT** /api/pub/v1/notes/{noteId} | update a note
|
11
|
+
|
12
|
+
|
13
|
+
# **public_api_delete_note**
|
14
|
+
> Object public_api_delete_note(note_id, api_key)
|
15
|
+
|
16
|
+
delete a note
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'crelate_client'
|
24
|
+
|
25
|
+
api_instance = CrelateClient::NotesApi.new
|
26
|
+
|
27
|
+
note_id = "note_id_example" # String | identifier
|
28
|
+
|
29
|
+
api_key = "api_key_example" # String | crelate api key
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#delete a note
|
34
|
+
result = api_instance.public_api_delete_note(note_id, api_key)
|
35
|
+
p result
|
36
|
+
rescue CrelateClient::ApiError => e
|
37
|
+
puts "Exception when calling NotesApi->public_api_delete_note: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**note_id** | [**String**](.md)| identifier |
|
46
|
+
**api_key** | **String**| crelate api key |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
**Object**
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
No authorization required
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: Not defined
|
59
|
+
- **Accept**: application/json, text/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **public_api_get_note**
|
64
|
+
> PublicApiGetNoteResponse public_api_get_note(note_id, api_key)
|
65
|
+
|
66
|
+
retrieve a note
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'crelate_client'
|
74
|
+
|
75
|
+
api_instance = CrelateClient::NotesApi.new
|
76
|
+
|
77
|
+
note_id = "note_id_example" # String | identifier
|
78
|
+
|
79
|
+
api_key = "api_key_example" # String | crelate api key
|
80
|
+
|
81
|
+
|
82
|
+
begin
|
83
|
+
#retrieve a note
|
84
|
+
result = api_instance.public_api_get_note(note_id, api_key)
|
85
|
+
p result
|
86
|
+
rescue CrelateClient::ApiError => e
|
87
|
+
puts "Exception when calling NotesApi->public_api_get_note: #{e}"
|
88
|
+
end
|
89
|
+
```
|
90
|
+
|
91
|
+
### Parameters
|
92
|
+
|
93
|
+
Name | Type | Description | Notes
|
94
|
+
------------- | ------------- | ------------- | -------------
|
95
|
+
**note_id** | [**String**](.md)| identifier |
|
96
|
+
**api_key** | **String**| crelate api key |
|
97
|
+
|
98
|
+
### Return type
|
99
|
+
|
100
|
+
[**PublicApiGetNoteResponse**](PublicApiGetNoteResponse.md)
|
101
|
+
|
102
|
+
### Authorization
|
103
|
+
|
104
|
+
No authorization required
|
105
|
+
|
106
|
+
### HTTP request headers
|
107
|
+
|
108
|
+
- **Content-Type**: Not defined
|
109
|
+
- **Accept**: application/json, text/json
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
# **public_api_post_note**
|
114
|
+
> PublicApiIdResponse public_api_post_note(api_key, request)
|
115
|
+
|
116
|
+
create a note
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
### Example
|
121
|
+
```ruby
|
122
|
+
# load the gem
|
123
|
+
require 'crelate_client'
|
124
|
+
|
125
|
+
api_instance = CrelateClient::NotesApi.new
|
126
|
+
|
127
|
+
api_key = "api_key_example" # String | crelate api key
|
128
|
+
|
129
|
+
request = CrelateClient::PublicApiSaveNoteRequest.new # PublicApiSaveNoteRequest |
|
130
|
+
|
131
|
+
|
132
|
+
begin
|
133
|
+
#create a note
|
134
|
+
result = api_instance.public_api_post_note(api_key, request)
|
135
|
+
p result
|
136
|
+
rescue CrelateClient::ApiError => e
|
137
|
+
puts "Exception when calling NotesApi->public_api_post_note: #{e}"
|
138
|
+
end
|
139
|
+
```
|
140
|
+
|
141
|
+
### Parameters
|
142
|
+
|
143
|
+
Name | Type | Description | Notes
|
144
|
+
------------- | ------------- | ------------- | -------------
|
145
|
+
**api_key** | **String**| crelate api key |
|
146
|
+
**request** | [**PublicApiSaveNoteRequest**](PublicApiSaveNoteRequest.md)| |
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
[**PublicApiIdResponse**](PublicApiIdResponse.md)
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
No authorization required
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: application/json, text/json, application/x-www-form-urlencoded
|
159
|
+
- **Accept**: application/json, text/json
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
# **public_api_put_note**
|
164
|
+
> Object public_api_put_note(note_id, api_key, request)
|
165
|
+
|
166
|
+
update a note
|
167
|
+
|
168
|
+
Replaces all fields. To partially update a note, first retrieve it using the GET method, apply changes and submit to the PUT method.
|
169
|
+
|
170
|
+
### Example
|
171
|
+
```ruby
|
172
|
+
# load the gem
|
173
|
+
require 'crelate_client'
|
174
|
+
|
175
|
+
api_instance = CrelateClient::NotesApi.new
|
176
|
+
|
177
|
+
note_id = "note_id_example" # String | identifier
|
178
|
+
|
179
|
+
api_key = "api_key_example" # String | crelate api key
|
180
|
+
|
181
|
+
request = CrelateClient::PublicApiSaveNoteRequest.new # PublicApiSaveNoteRequest |
|
182
|
+
|
183
|
+
|
184
|
+
begin
|
185
|
+
#update a note
|
186
|
+
result = api_instance.public_api_put_note(note_id, api_key, request)
|
187
|
+
p result
|
188
|
+
rescue CrelateClient::ApiError => e
|
189
|
+
puts "Exception when calling NotesApi->public_api_put_note: #{e}"
|
190
|
+
end
|
191
|
+
```
|
192
|
+
|
193
|
+
### Parameters
|
194
|
+
|
195
|
+
Name | Type | Description | Notes
|
196
|
+
------------- | ------------- | ------------- | -------------
|
197
|
+
**note_id** | [**String**](.md)| identifier |
|
198
|
+
**api_key** | **String**| crelate api key |
|
199
|
+
**request** | [**PublicApiSaveNoteRequest**](PublicApiSaveNoteRequest.md)| |
|
200
|
+
|
201
|
+
### Return type
|
202
|
+
|
203
|
+
**Object**
|
204
|
+
|
205
|
+
### Authorization
|
206
|
+
|
207
|
+
No authorization required
|
208
|
+
|
209
|
+
### HTTP request headers
|
210
|
+
|
211
|
+
- **Content-Type**: application/json, text/json, application/x-www-form-urlencoded
|
212
|
+
- **Accept**: application/json, text/json
|
213
|
+
|
214
|
+
|
215
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# CrelateClient::OrgAuditLogEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**action** | **Integer** | | [optional]
|
7
|
+
**action_display_name** | **String** | | [optional]
|
8
|
+
**details** | **String** | | [optional]
|
9
|
+
**ip_address** | **String** | | [optional]
|
10
|
+
**record_id** | **String** | | [optional]
|
11
|
+
**record_title** | **String** | | [optional]
|
12
|
+
**record_type** | **String** | | [optional]
|
13
|
+
**record_type_display_name** | **String** | | [optional]
|
14
|
+
**user_display_name** | **String** | | [optional]
|
15
|
+
**user_email** | **String** | | [optional]
|
16
|
+
**user_id** | **String** | | [optional]
|
17
|
+
**partition_key** | **String** | | [optional]
|
18
|
+
**row_key** | **String** | | [optional]
|
19
|
+
**timestamp** | **DateTime** | | [optional]
|
20
|
+
**e_tag** | **String** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CrelateClient::PostPurchaseRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**annual_license_count** | **Integer** | | [optional]
|
7
|
+
**monthly_license_count** | **Integer** | | [optional]
|
8
|
+
**payment_method_id** | **Integer** | | [optional]
|
9
|
+
**plan** | **String** | | [optional]
|
10
|
+
**referral_code** | **String** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# CrelateClient::PublicApiAttachmentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**content_length** | **Integer** | | [optional]
|
7
|
+
**content_type** | **String** | | [optional]
|
8
|
+
**created_by_id** | **String** | | [optional]
|
9
|
+
**created_by_name** | **String** | | [optional]
|
10
|
+
**created_on** | **DateTime** | | [optional]
|
11
|
+
**file_name** | **String** | | [optional]
|
12
|
+
**id** | **String** | | [optional]
|
13
|
+
**modified_by_id** | **String** | | [optional]
|
14
|
+
**modified_by_name** | **String** | | [optional]
|
15
|
+
**modified_on** | **DateTime** | | [optional]
|
16
|
+
**type_id** | **String** | | [optional]
|
17
|
+
**type_name** | **String** | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CrelateClient::PublicApiAttachmentResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**more_records** | **BOOLEAN** | | [optional]
|
7
|
+
**results** | [**Array<PublicApiAttachmentResponse>**](PublicApiAttachmentResponse.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CrelateClient::PublicApiDocumentType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**allowed_on** | **Array<String>** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,85 @@
|
|
1
|
+
# CrelateClient::PublicApiGetAccountResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**attachments** | [**Array<PublicApiAttachmentResponse>**](PublicApiAttachmentResponse.md) | | [optional]
|
7
|
+
**created_by_id** | **String** | | [optional]
|
8
|
+
**created_by_name** | **String** | | [optional]
|
9
|
+
**created_on** | **DateTime** | | [optional]
|
10
|
+
**id** | **String** | | [optional]
|
11
|
+
**modified_by_id** | **String** | | [optional]
|
12
|
+
**modified_by_name** | **String** | | [optional]
|
13
|
+
**modified_on** | **DateTime** | | [optional]
|
14
|
+
**owners** | [**Array<PublicApiRecordOwner>**](PublicApiRecordOwner.md) | | [optional]
|
15
|
+
**status_id** | **String** | | [optional]
|
16
|
+
**status_name** | **String** | | [optional]
|
17
|
+
**additional_contact_billing_first_name** | **String** | | [optional]
|
18
|
+
**additional_contact_billing_id** | **String** | | [optional]
|
19
|
+
**additional_contact_billing_is_primary** | **BOOLEAN** | | [optional]
|
20
|
+
**additional_contact_billing_last_name** | **String** | | [optional]
|
21
|
+
**additional_contact_other_first_name** | **String** | | [optional]
|
22
|
+
**additional_contact_other_id** | **String** | | [optional]
|
23
|
+
**additional_contact_other_is_primary** | **BOOLEAN** | | [optional]
|
24
|
+
**additional_contact_other_last_name** | **String** | | [optional]
|
25
|
+
**address_business_city** | **String** | | [optional]
|
26
|
+
**address_business_country** | **String** | | [optional]
|
27
|
+
**address_business_is_primary** | **BOOLEAN** | | [optional]
|
28
|
+
**address_business_line1** | **String** | | [optional]
|
29
|
+
**address_business_state** | **String** | | [optional]
|
30
|
+
**address_business_zip_code** | **String** | | [optional]
|
31
|
+
**address_headquarters_city** | **String** | | [optional]
|
32
|
+
**address_headquarters_country** | **String** | | [optional]
|
33
|
+
**address_headquarters_is_primary** | **BOOLEAN** | | [optional]
|
34
|
+
**address_headquarters_line1** | **String** | | [optional]
|
35
|
+
**address_headquarters_state** | **String** | | [optional]
|
36
|
+
**address_headquarters_zip_code** | **String** | | [optional]
|
37
|
+
**address_other_city** | **String** | | [optional]
|
38
|
+
**address_other_country** | **String** | | [optional]
|
39
|
+
**address_other_is_primary** | **BOOLEAN** | | [optional]
|
40
|
+
**address_other_line1** | **String** | | [optional]
|
41
|
+
**address_other_state** | **String** | | [optional]
|
42
|
+
**address_other_zip_code** | **String** | | [optional]
|
43
|
+
**description** | **String** | | [optional]
|
44
|
+
**email_address_other** | **String** | | [optional]
|
45
|
+
**email_address_other_is_primary** | **BOOLEAN** | | [optional]
|
46
|
+
**email_address_sales** | **String** | | [optional]
|
47
|
+
**email_address_sales_is_primary** | **BOOLEAN** | | [optional]
|
48
|
+
**email_address_support** | **String** | | [optional]
|
49
|
+
**email_address_support_is_primary** | **BOOLEAN** | | [optional]
|
50
|
+
**external_primary_key** | **String** | | [optional]
|
51
|
+
**name** | **String** | | [optional]
|
52
|
+
**parent_account_id** | **String** | | [optional]
|
53
|
+
**parent_account_name** | **String** | | [optional]
|
54
|
+
**phone_number_fax** | **String** | | [optional]
|
55
|
+
**phone_number_fax_extension** | **String** | | [optional]
|
56
|
+
**phone_number_fax_is_primary** | **BOOLEAN** | | [optional]
|
57
|
+
**phone_number_main** | **String** | | [optional]
|
58
|
+
**phone_number_main_extension** | **String** | | [optional]
|
59
|
+
**phone_number_main_is_primary** | **BOOLEAN** | | [optional]
|
60
|
+
**phone_number_other** | **String** | | [optional]
|
61
|
+
**phone_number_other_extension** | **String** | | [optional]
|
62
|
+
**phone_number_other_is_primary** | **BOOLEAN** | | [optional]
|
63
|
+
**phone_number_sales** | **String** | | [optional]
|
64
|
+
**phone_number_sales_extension** | **String** | | [optional]
|
65
|
+
**phone_number_sales_is_primary** | **BOOLEAN** | | [optional]
|
66
|
+
**phone_number_skype** | **String** | | [optional]
|
67
|
+
**phone_number_skype_extension** | **String** | | [optional]
|
68
|
+
**phone_number_skype_is_primary** | **BOOLEAN** | | [optional]
|
69
|
+
**phone_number_support** | **String** | | [optional]
|
70
|
+
**phone_number_support_extension** | **String** | | [optional]
|
71
|
+
**phone_number_support_is_primary** | **BOOLEAN** | | [optional]
|
72
|
+
**record_type** | **Array<String>** | | [optional]
|
73
|
+
**tags** | **Hash<String, Array<String>>** | | [optional]
|
74
|
+
**website_blog** | **String** | | [optional]
|
75
|
+
**website_blog_is_primary** | **BOOLEAN** | | [optional]
|
76
|
+
**website_business** | **String** | | [optional]
|
77
|
+
**website_business_is_primary** | **BOOLEAN** | | [optional]
|
78
|
+
**website_facebook** | **String** | | [optional]
|
79
|
+
**website_facebook_is_primary** | **BOOLEAN** | | [optional]
|
80
|
+
**website_linked_in** | **String** | | [optional]
|
81
|
+
**website_linked_in_is_primary** | **BOOLEAN** | | [optional]
|
82
|
+
**website_other** | **String** | | [optional]
|
83
|
+
**website_other_is_primary** | **BOOLEAN** | | [optional]
|
84
|
+
|
85
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CrelateClient::PublicApiGetAccountResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**more_records** | **BOOLEAN** | | [optional]
|
7
|
+
**results** | [**Array<PublicApiGetAccountResponse>**](PublicApiGetAccountResponse.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CrelateClient::PublicApiGetContactJob
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**stage_id** | **String** | | [optional]
|
9
|
+
**stage_name** | **String** | | [optional]
|
10
|
+
**workflow_type_id** | **String** | | [optional]
|
11
|
+
**workflow_type_name** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,151 @@
|
|
1
|
+
# CrelateClient::PublicApiGetContactResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**attachments** | [**Array<PublicApiAttachmentResponse>**](PublicApiAttachmentResponse.md) | | [optional]
|
7
|
+
**created_by_id** | **String** | | [optional]
|
8
|
+
**created_by_name** | **String** | | [optional]
|
9
|
+
**created_on** | **DateTime** | | [optional]
|
10
|
+
**id** | **String** | | [optional]
|
11
|
+
**modified_by_id** | **String** | | [optional]
|
12
|
+
**modified_by_name** | **String** | | [optional]
|
13
|
+
**modified_on** | **DateTime** | | [optional]
|
14
|
+
**name** | **String** | | [optional]
|
15
|
+
**owners** | [**Array<PublicApiRecordOwner>**](PublicApiRecordOwner.md) | | [optional]
|
16
|
+
**status_id** | **String** | | [optional]
|
17
|
+
**status_name** | **String** | | [optional]
|
18
|
+
**address_business_city** | **String** | | [optional]
|
19
|
+
**address_business_country** | **String** | | [optional]
|
20
|
+
**address_business_is_primary** | **BOOLEAN** | | [optional]
|
21
|
+
**address_business_line1** | **String** | | [optional]
|
22
|
+
**address_business_state** | **String** | | [optional]
|
23
|
+
**address_business_zip_code** | **String** | | [optional]
|
24
|
+
**address_home_city** | **String** | | [optional]
|
25
|
+
**address_home_country** | **String** | | [optional]
|
26
|
+
**address_home_is_primary** | **BOOLEAN** | | [optional]
|
27
|
+
**address_home_line1** | **String** | | [optional]
|
28
|
+
**address_home_state** | **String** | | [optional]
|
29
|
+
**address_home_zip_code** | **String** | | [optional]
|
30
|
+
**address_other_city** | **String** | | [optional]
|
31
|
+
**address_other_country** | **String** | | [optional]
|
32
|
+
**address_other_is_primary** | **BOOLEAN** | | [optional]
|
33
|
+
**address_other_line1** | **String** | | [optional]
|
34
|
+
**address_other_state** | **String** | | [optional]
|
35
|
+
**address_other_zip_code** | **String** | | [optional]
|
36
|
+
**current_position_company_id** | **String** | | [optional]
|
37
|
+
**current_position_company_name** | **String** | | [optional]
|
38
|
+
**current_position_title** | **String** | | [optional]
|
39
|
+
**current_position_when_end** | **DateTime** | | [optional]
|
40
|
+
**current_position_when_start** | **DateTime** | | [optional]
|
41
|
+
**description** | **String** | | [optional]
|
42
|
+
**education_accreditation_id** | **String** | | [optional]
|
43
|
+
**education_accreditation_name** | **String** | | [optional]
|
44
|
+
**education_honors** | **Array<String>** | | [optional]
|
45
|
+
**education_institution_id** | **String** | | [optional]
|
46
|
+
**education_institution_name** | **String** | | [optional]
|
47
|
+
**education_when_end** | **DateTime** | | [optional]
|
48
|
+
**education_when_start** | **DateTime** | | [optional]
|
49
|
+
**email_address_other** | **String** | | [optional]
|
50
|
+
**email_address_other_is_primary** | **BOOLEAN** | | [optional]
|
51
|
+
**email_address_personal** | **String** | | [optional]
|
52
|
+
**email_address_personal_is_primary** | **BOOLEAN** | | [optional]
|
53
|
+
**email_address_work** | **String** | | [optional]
|
54
|
+
**email_address_work_is_primary** | **BOOLEAN** | | [optional]
|
55
|
+
**ethnicity_id** | **String** | | [optional]
|
56
|
+
**ethnicity_name** | **String** | | [optional]
|
57
|
+
**external_primary_key** | **String** | | [optional]
|
58
|
+
**first_name** | **String** | | [optional]
|
59
|
+
**gender_id** | **String** | | [optional]
|
60
|
+
**gender_name** | **String** | | [optional]
|
61
|
+
**key_date_anniversary** | **DateTime** | | [optional]
|
62
|
+
**key_date_birthday** | **DateTime** | | [optional]
|
63
|
+
**key_date_other** | **DateTime** | | [optional]
|
64
|
+
**last_name** | **String** | | [optional]
|
65
|
+
**middle_name** | **String** | | [optional]
|
66
|
+
**nick_name** | **String** | | [optional]
|
67
|
+
**phone_number_fax** | **String** | | [optional]
|
68
|
+
**phone_number_fax_extension** | **String** | | [optional]
|
69
|
+
**phone_number_fax_is_primary** | **BOOLEAN** | | [optional]
|
70
|
+
**phone_number_home** | **String** | | [optional]
|
71
|
+
**phone_number_home_extension** | **String** | | [optional]
|
72
|
+
**phone_number_home_is_primary** | **BOOLEAN** | | [optional]
|
73
|
+
**phone_number_mobile** | **String** | | [optional]
|
74
|
+
**phone_number_mobile_extension** | **String** | | [optional]
|
75
|
+
**phone_number_mobile_is_primary** | **BOOLEAN** | | [optional]
|
76
|
+
**phone_number_other** | **String** | | [optional]
|
77
|
+
**phone_number_other_extension** | **String** | | [optional]
|
78
|
+
**phone_number_other_is_primary** | **BOOLEAN** | | [optional]
|
79
|
+
**phone_number_skype** | **String** | | [optional]
|
80
|
+
**phone_number_skype_extension** | **String** | | [optional]
|
81
|
+
**phone_number_skype_is_primary** | **BOOLEAN** | | [optional]
|
82
|
+
**phone_number_work_direct** | **String** | | [optional]
|
83
|
+
**phone_number_work_direct_extension** | **String** | | [optional]
|
84
|
+
**phone_number_work_direct_is_primary** | **BOOLEAN** | | [optional]
|
85
|
+
**phone_number_work_main** | **String** | | [optional]
|
86
|
+
**phone_number_work_main_extension** | **String** | | [optional]
|
87
|
+
**phone_number_work_main_is_primary** | **BOOLEAN** | | [optional]
|
88
|
+
**preferred_contact_method_type_id** | **String** | | [optional]
|
89
|
+
**preferred_contact_method_type_name** | **String** | | [optional]
|
90
|
+
**record_type** | **Array<String>** | | [optional]
|
91
|
+
**related_contact_assistant_first_name** | **String** | | [optional]
|
92
|
+
**related_contact_assistant_id** | **String** | | [optional]
|
93
|
+
**related_contact_assistant_is_primary** | **BOOLEAN** | | [optional]
|
94
|
+
**related_contact_assistant_last_name** | **String** | | [optional]
|
95
|
+
**related_contact_client_first_name** | **String** | | [optional]
|
96
|
+
**related_contact_client_id** | **String** | | [optional]
|
97
|
+
**related_contact_client_is_primary** | **BOOLEAN** | | [optional]
|
98
|
+
**related_contact_client_last_name** | **String** | | [optional]
|
99
|
+
**related_contact_other_first_name** | **String** | | [optional]
|
100
|
+
**related_contact_other_id** | **String** | | [optional]
|
101
|
+
**related_contact_other_is_primary** | **BOOLEAN** | | [optional]
|
102
|
+
**related_contact_other_last_name** | **String** | | [optional]
|
103
|
+
**related_contact_referred_by_first_name** | **String** | | [optional]
|
104
|
+
**related_contact_referred_by_id** | **String** | | [optional]
|
105
|
+
**related_contact_referred_by_is_primary** | **BOOLEAN** | | [optional]
|
106
|
+
**related_contact_referred_by_last_name** | **String** | | [optional]
|
107
|
+
**related_contact_spouse_first_name** | **String** | | [optional]
|
108
|
+
**related_contact_spouse_id** | **String** | | [optional]
|
109
|
+
**related_contact_spouse_is_primary** | **BOOLEAN** | | [optional]
|
110
|
+
**related_contact_spouse_last_name** | **String** | | [optional]
|
111
|
+
**salary** | **Float** | | [optional]
|
112
|
+
**salary_details** | **String** | | [optional]
|
113
|
+
**salutation_id** | **String** | | [optional]
|
114
|
+
**salutation_name** | **String** | | [optional]
|
115
|
+
**social_aim** | **String** | | [optional]
|
116
|
+
**social_aim_is_primary** | **BOOLEAN** | | [optional]
|
117
|
+
**social_facebook_chat** | **String** | | [optional]
|
118
|
+
**social_facebook_chat_is_primary** | **BOOLEAN** | | [optional]
|
119
|
+
**social_face_time** | **String** | | [optional]
|
120
|
+
**social_face_time_is_primary** | **BOOLEAN** | | [optional]
|
121
|
+
**social_google_talk** | **String** | | [optional]
|
122
|
+
**social_google_talk_is_primary** | **BOOLEAN** | | [optional]
|
123
|
+
**social_icq** | **String** | | [optional]
|
124
|
+
**social_icq_is_primary** | **BOOLEAN** | | [optional]
|
125
|
+
**social_other** | **String** | | [optional]
|
126
|
+
**social_other_is_primary** | **BOOLEAN** | | [optional]
|
127
|
+
**social_skype** | **String** | | [optional]
|
128
|
+
**social_skype_is_primary** | **BOOLEAN** | | [optional]
|
129
|
+
**social_twitter** | **String** | | [optional]
|
130
|
+
**social_twitter_is_primary** | **BOOLEAN** | | [optional]
|
131
|
+
**social_yahoo_msg** | **String** | | [optional]
|
132
|
+
**social_yahoo_msg_is_primary** | **BOOLEAN** | | [optional]
|
133
|
+
**source_id** | **String** | | [optional]
|
134
|
+
**source_name** | **String** | | [optional]
|
135
|
+
**suffix_id** | **String** | | [optional]
|
136
|
+
**suffix_name** | **String** | | [optional]
|
137
|
+
**tags** | **Hash<String, Array<String>>** | | [optional]
|
138
|
+
**website_blog** | **String** | | [optional]
|
139
|
+
**website_blog_is_primary** | **BOOLEAN** | | [optional]
|
140
|
+
**website_business** | **String** | | [optional]
|
141
|
+
**website_business_is_primary** | **BOOLEAN** | | [optional]
|
142
|
+
**website_facebook** | **String** | | [optional]
|
143
|
+
**website_facebook_is_primary** | **BOOLEAN** | | [optional]
|
144
|
+
**website_linked_in** | **String** | | [optional]
|
145
|
+
**website_linked_in_is_primary** | **BOOLEAN** | | [optional]
|
146
|
+
**website_other** | **String** | | [optional]
|
147
|
+
**website_other_is_primary** | **BOOLEAN** | | [optional]
|
148
|
+
**website_personal** | **String** | | [optional]
|
149
|
+
**website_personal_is_primary** | **BOOLEAN** | | [optional]
|
150
|
+
|
151
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CrelateClient::PublicApiGetContactResponseList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**more_records** | **BOOLEAN** | | [optional]
|
7
|
+
**results** | [**Array<PublicApiGetContactResponse>**](PublicApiGetContactResponse.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobContact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | | [optional]
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
**stage_id** | **String** | | [optional]
|
9
|
+
**stage_name** | **String** | | [optional]
|
10
|
+
**workflow_type_id** | **String** | | [optional]
|
11
|
+
**workflow_type_name** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**more_records** | **BOOLEAN** | | [optional]
|
7
|
+
**results** | [**Array<PublicApiGetJobResponse>**](PublicApiGetJobResponse.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobPostingListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**more_records** | **BOOLEAN** | | [optional]
|
7
|
+
**results** | [**Array<PublicApiGetJobPostingResponse>**](PublicApiGetJobPostingResponse.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobPostingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created_by_id** | **String** | | [optional]
|
7
|
+
**created_by_name** | **String** | | [optional]
|
8
|
+
**created_on** | **DateTime** | | [optional]
|
9
|
+
**id** | **String** | | [optional]
|
10
|
+
**last_posted_on** | **DateTime** | | [optional]
|
11
|
+
**modified_by_id** | **String** | | [optional]
|
12
|
+
**modified_by_name** | **String** | | [optional]
|
13
|
+
**primary_owner_name** | **String** | | [optional]
|
14
|
+
**modified_on** | **DateTime** | | [optional]
|
15
|
+
**owners** | [**Array<PublicApiRecordOwner>**](PublicApiRecordOwner.md) | | [optional]
|
16
|
+
**city** | **String** | | [optional]
|
17
|
+
**company_name** | **String** | | [optional]
|
18
|
+
**compensation** | **String** | | [optional]
|
19
|
+
**country_id** | **String** | | [optional]
|
20
|
+
**country_name** | **String** | | [optional]
|
21
|
+
**description** | **String** | | [optional]
|
22
|
+
**external_primay_key** | **String** | | [optional]
|
23
|
+
**job_code** | **String** | | [optional]
|
24
|
+
**state** | **String** | | [optional]
|
25
|
+
**title** | **String** | | [optional]
|
26
|
+
**url_slug** | **String** | | [optional]
|
27
|
+
**zip** | **String** | | [optional]
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobPostingSearchResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<PublicApiGetJobPostingSearchResult>**](PublicApiGetJobPostingSearchResult.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# CrelateClient::PublicApiGetJobPostingSearchResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**city** | **String** | | [optional]
|
7
|
+
**company_name** | **String** | | [optional]
|
8
|
+
**description** | **String** | | [optional]
|
9
|
+
**id** | **String** | | [optional]
|
10
|
+
**job_code** | **String** | | [optional]
|
11
|
+
**job_num** | **Integer** | | [optional]
|
12
|
+
**last_posted_on** | **DateTime** | | [optional]
|
13
|
+
**state** | **String** | | [optional]
|
14
|
+
**title** | **String** | | [optional]
|
15
|
+
**zip** | **String** | | [optional]
|
16
|
+
**primary_owner_name** | **String** | | [optional]
|
17
|
+
|
18
|
+
|