Module: CrelateClient

Defined in:
lib/crelate_client/version.rb,
lib/crelate_client.rb,
lib/crelate_client/api_error.rb,
lib/crelate_client/api_client.rb,
lib/crelate_client/api/jobs_api.rb,
lib/crelate_client/api/notes_api.rb,
lib/crelate_client/api/tasks_api.rb,
lib/crelate_client/configuration.rb,
lib/crelate_client/api/domain_api.rb,
lib/crelate_client/models/company.rb,
lib/crelate_client/models/question.rb,
lib/crelate_client/api/contacts_api.rb,
lib/crelate_client/api/companies_api.rb,
lib/crelate_client/models/share_link.rb,
lib/crelate_client/models/wayup_data.rb,
lib/crelate_client/models/assigned_to.rb,
lib/crelate_client/models/job_response.rb,
lib/crelate_client/api/job_postings_api.rb,
lib/crelate_client/models/document_item.rb,
lib/crelate_client/models/entity_lookup.rb,
lib/crelate_client/models/user_response.rb,
lib/crelate_client/models/crelate_action.rb,
lib/crelate_client/models/search_contact.rb,
lib/crelate_client/models/zip_apply_data.rb,
lib/crelate_client/models/crelate_details.rb,
lib/crelate_client/models/board_parameters.rb,
lib/crelate_client/models/email_attachment.rb,
lib/crelate_client/models/job_post_request.rb,
lib/crelate_client/models/broadcast_message.rb,
lib/crelate_client/models/interview_request.rb,
lib/crelate_client/models/interview_response.rb,
lib/crelate_client/models/signup_information.rb,
lib/crelate_client/models/assigned_to_request.rb,
lib/crelate_client/models/document_collection.rb,
lib/crelate_client/models/fusebill_state_item.rb,
lib/crelate_client/models/multi_entity_lookup.rb,
lib/crelate_client/models/org_audit_log_event.rb,
lib/crelate_client/models/send_email_response.rb,
lib/crelate_client/models/ext_referral_request.rb,
lib/crelate_client/models/ext_resume_candidate.rb,
lib/crelate_client/models/ext_resume_org_state.rb,
lib/crelate_client/models/post_purchase_request.rb,
lib/crelate_client/models/question_set_response.rb,
lib/crelate_client/models/send_submittal_detail.rb,
lib/crelate_client/models/crelate_action_payload.rb,
lib/crelate_client/models/custom_form_definition.rb,
lib/crelate_client/models/public_api_id_response.rb,
lib/crelate_client/models/consent_request_payload.rb,
lib/crelate_client/models/entity_document_options.rb,
lib/crelate_client/models/public_api_record_owner.rb,
lib/crelate_client/models/public_api_tag_category.rb,
lib/crelate_client/models/webhook_delete_response.rb,
lib/crelate_client/models/ext_resume_view_response.rb,
lib/crelate_client/models/public_api_document_type.rb,
lib/crelate_client/models/public_api_workflow_type.rb,
lib/crelate_client/models/custom_form_save_response.rb,
lib/crelate_client/models/get_document_list_options.rb,
lib/crelate_client/models/interview_request_details.rb,
lib/crelate_client/models/custom_form_completed_form.rb,
lib/crelate_client/models/custom_form_layout_section.rb,
lib/crelate_client/models/ext_resume_package_pricing.rb,
lib/crelate_client/models/ext_resume_search_response.rb,
lib/crelate_client/models/public_api_get_contact_job.rb,
lib/crelate_client/models/public_api_get_job_contact.rb,
lib/crelate_client/models/public_api_workflow_status.rb,
lib/crelate_client/models/compliance_settings_payload.rb,
lib/crelate_client/models/public_api_get_job_response.rb,
lib/crelate_client/models/public_api_save_job_request.rb,
lib/crelate_client/models/custom_form_form_field_usage.rb,
lib/crelate_client/models/public_api_get_note_response.rb,
lib/crelate_client/models/public_api_get_task_response.rb,
lib/crelate_client/models/public_api_save_note_request.rb,
lib/crelate_client/models/public_api_save_task_request.rb,
lib/crelate_client/models/save_ext_credential_response.rb,
lib/crelate_client/models/public_api_placement_response.rb,
lib/crelate_client/models/public_api_attachment_response.rb,
lib/crelate_client/models/sms_plivo_voice_answer_request.rb,
lib/crelate_client/models/sms_plivo_voice_hangup_request.rb,
lib/crelate_client/models/custom_form_definition_entities.rb,
lib/crelate_client/models/public_api_get_account_response.rb,
lib/crelate_client/models/public_api_get_contact_response.rb,
lib/crelate_client/models/public_api_save_account_request.rb,
lib/crelate_client/models/public_api_save_contact_request.rb,
lib/crelate_client/models/broadcast_message_create_request.rb,
lib/crelate_client/models/public_api_get_job_list_response.rb,
lib/crelate_client/models/custom_form_form_definition_usage.rb,
lib/crelate_client/models/ext_resume_package_update_request.rb,
lib/crelate_client/models/public_api_placement_response_list.rb,
lib/crelate_client/models/public_api_save_attachment_request.rb,
lib/crelate_client/models/sms_plivo_message_received_request.rb,
lib/crelate_client/models/public_api_attachment_response_list.rb,
lib/crelate_client/models/public_api_get_job_posting_response.rb,
lib/crelate_client/models/public_api_save_job_posting_request.rb,
lib/crelate_client/models/public_api_get_account_response_list.rb,
lib/crelate_client/models/public_api_get_contact_response_list.rb,
lib/crelate_client/models/public_api_save_job_request_job_type.rb,
lib/crelate_client/models/custom_form_form_defintion_usage_jobs.rb,
lib/crelate_client/models/spark_hire_response_info_job_response.rb,
lib/crelate_client/models/public_api_save_job_application_request.rb,
lib/crelate_client/models/public_api_get_job_posting_list_response.rb,
lib/crelate_client/models/public_api_get_job_posting_search_result.rb,
lib/crelate_client/models/sms_plivo_message_status_received_request.rb,
lib/crelate_client/models/public_api_get_job_posting_search_response.rb,
lib/crelate_client/models/ext_integration_response_interview_response.rb,
lib/crelate_client/models/spark_hire_response_info_interview_response.rb,
lib/crelate_client/models/custom_form_form_field_usage_form_definition.rb,
lib/crelate_client/models/public_api_save_workflow_item_status_request.rb,
lib/crelate_client/models/spark_hire_response_info_question_set_response.rb,
lib/crelate_client/models/ext_resume_career_builder_validate_credentials_response.rb

Overview

#Crelate API Reference

#No description provided (generated by Swagger Codegen github.com/swagger-api/swagger-codegen)

OpenAPI spec version: v1

Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.3.1

Defined Under Namespace

Classes: ApiClient, ApiError, AssignedTo, AssignedToRequest, BoardParameters, BroadcastMessage, BroadcastMessageCreateRequest, CompaniesApi, Company, ComplianceSettingsPayload, Configuration, ConsentRequestPayload, ContactsApi, CrelateAction, CrelateActionPayload, CrelateDetails, CustomFormCompletedForm, CustomFormDefinition, CustomFormDefinitionEntities, CustomFormFormDefinitionUsage, CustomFormFormDefintionUsageJobs, CustomFormFormFieldUsage, CustomFormFormFieldUsageFormDefinition, CustomFormLayoutSection, CustomFormSaveResponse, DocumentCollection, DocumentItem, DomainApi, EmailAttachment, EntityDocumentOptions, EntityLookup, ExtIntegrationResponseInterviewResponse, ExtReferralRequest, ExtResumeCandidate, ExtResumeCareerBuilderValidateCredentialsResponse, ExtResumeOrgState, ExtResumePackagePricing, ExtResumePackageUpdateRequest, ExtResumeSearchResponse, ExtResumeViewResponse, FusebillStateItem, GetDocumentListOptions, InterviewRequest, InterviewRequestDetails, InterviewResponse, JobPostRequest, JobPostingsApi, JobResponse, JobsApi, MultiEntityLookup, NotesApi, OrgAuditLogEvent, PostPurchaseRequest, PublicApiAttachmentResponse, PublicApiAttachmentResponseList, PublicApiDocumentType, PublicApiGetAccountResponse, PublicApiGetAccountResponseList, PublicApiGetContactJob, PublicApiGetContactResponse, PublicApiGetContactResponseList, PublicApiGetJobContact, PublicApiGetJobListResponse, PublicApiGetJobPostingListResponse, PublicApiGetJobPostingResponse, PublicApiGetJobPostingSearchResponse, PublicApiGetJobPostingSearchResult, PublicApiGetJobResponse, PublicApiGetNoteResponse, PublicApiGetTaskResponse, PublicApiIdResponse, PublicApiPlacementResponse, PublicApiPlacementResponseList, PublicApiRecordOwner, PublicApiSaveAccountRequest, PublicApiSaveAttachmentRequest, PublicApiSaveContactRequest, PublicApiSaveJobApplicationRequest, PublicApiSaveJobPostingRequest, PublicApiSaveJobRequest, PublicApiSaveJobRequestJobType, PublicApiSaveNoteRequest, PublicApiSaveTaskRequest, PublicApiSaveWorkflowItemStatusRequest, PublicApiTagCategory, PublicApiWorkflowStatus, PublicApiWorkflowType, Question, QuestionSetResponse, SaveExtCredentialResponse, SearchContact, SendEmailResponse, SendSubmittalDetail, ShareLink, SignupInformation, SmsPlivoMessageReceivedRequest, SmsPlivoMessageStatusReceivedRequest, SmsPlivoVoiceAnswerRequest, SmsPlivoVoiceHangupRequest, SparkHireResponseInfoInterviewResponse, SparkHireResponseInfoJobResponse, SparkHireResponseInfoQuestionSetResponse, TasksApi, UserResponse, WayupData, WebhookDeleteResponse, ZipApplyData

Constant Summary collapse

VERSION = 
"1.0.6"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

CrelateClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



135
136
137
138
139
140
141
 
# File 'lib/crelate_client.rb', line 135

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end