Module: SmartRecruiters

Defined in:
lib/smart_recruiters.rb,
lib/smart_recruiters/version.rb,
lib/smart_recruiters/api_error.rb,
lib/smart_recruiters/api_client.rb,
lib/smart_recruiters/models/job.rb,
lib/smart_recruiters/models/web.rb,
lib/smart_recruiters/models/jobs.rb,
lib/smart_recruiters/models/path.rb,
lib/smart_recruiters/models/user.rb,
lib/smart_recruiters/models/uuid.rb,
lib/smart_recruiters/api/jobs_api.rb,
lib/smart_recruiters/models/error.rb,
lib/smart_recruiters/models/event.rb,
lib/smart_recruiters/models/users.rb,
lib/smart_recruiters/api/users_api.rb,
lib/smart_recruiters/authorization.rb,
lib/smart_recruiters/configuration.rb,
lib/smart_recruiters/models/action.rb,
lib/smart_recruiters/models/job_ad.rb,
lib/smart_recruiters/models/source.rb,
lib/smart_recruiters/models/actions.rb,
lib/smart_recruiters/models/context.rb,
lib/smart_recruiters/models/job_ads.rb,
lib/smart_recruiters/models/job_job.rb,
lib/smart_recruiters/models/labeled.rb,
lib/smart_recruiters/models/message.rb,
lib/smart_recruiters/models/sources.rb,
lib/smart_recruiters/models/user_id.rb,
lib/smart_recruiters/models/industry.rb,
lib/smart_recruiters/models/job_note.rb,
lib/smart_recruiters/models/language.rb,
lib/smart_recruiters/models/location.rb,
lib/smart_recruiters/models/property.rb,
lib/smart_recruiters/models/timeslot.rb,
lib/smart_recruiters/models/user_ids.rb,
lib/smart_recruiters/api/messages_api.rb,
lib/smart_recruiters/api/statuses_api.rb,
lib/smart_recruiters/models/candidate.rb,
lib/smart_recruiters/models/education.rb,
lib/smart_recruiters/models/interview.rb,
lib/smart_recruiters/models/job_input.rb,
lib/smart_recruiters/models/timeslots.rb,
lib/smart_recruiters/api/timeslots_api.rb,
lib/smart_recruiters/models/assignment.rb,
lib/smart_recruiters/models/attachment.rb,
lib/smart_recruiters/models/candidates.rb,
lib/smart_recruiters/models/department.rb,
lib/smart_recruiters/models/employment.rb,
lib/smart_recruiters/models/event_name.rb,
lib/smart_recruiters/models/experience.rb,
lib/smart_recruiters/models/job_status.rb,
lib/smart_recruiters/models/json_patch.rb,
lib/smart_recruiters/models/model_when.rb,
lib/smart_recruiters/models/properties.rb,
lib/smart_recruiters/models/share_with.rb,
lib/smart_recruiters/models/visibility.rb,
lib/smart_recruiters/api/candidates_api.rb,
lib/smart_recruiters/api/interviews_api.rb,
lib/smart_recruiters/models/application.rb,
lib/smart_recruiters/models/attachments.rb,
lib/smart_recruiters/models/departments.rb,
lib/smart_recruiters/models/field_value.rb,
lib/smart_recruiters/models/interviewer.rb,
lib/smart_recruiters/models/job_ad_item.rb,
lib/smart_recruiters/models/job_details.rb,
lib/smart_recruiters/models/job_summary.rb,
lib/smart_recruiters/models/publication.rb,
lib/smart_recruiters/models/user_entity.rb,
lib/smart_recruiters/models/web_profile.rb,
lib/smart_recruiters/api/application_api.rb,
lib/smart_recruiters/models/answer_field.rb,
lib/smart_recruiters/models/applications.rb,
lib/smart_recruiters/models/callback_url.rb,
lib/smart_recruiters/models/compensation.rb,
lib/smart_recruiters/models/identifiable.rb,
lib/smart_recruiters/models/interviewers.rb,
lib/smart_recruiters/models/job_ad_input.rb,
lib/smart_recruiters/models/job_approval.rb,
lib/smart_recruiters/models/job_position.rb,
lib/smart_recruiters/models/job_property.rb,
lib/smart_recruiters/models/json_pointer.rb,
lib/smart_recruiters/models/message_view.rb,
lib/smart_recruiters/models/salary_range.rb,
lib/smart_recruiters/models/source_types.rb,
lib/smart_recruiters/models/subscription.rb,
lib/smart_recruiters/models/answer_record.rb,
lib/smart_recruiters/models/candidate_job.rb,
lib/smart_recruiters/models/consent_scope.rb,
lib/smart_recruiters/models/email_address.rb,
lib/smart_recruiters/models/job_ad_videos.rb,
lib/smart_recruiters/models/job_positions.rb,
lib/smart_recruiters/models/language_code.rb,
lib/smart_recruiters/models/messages_view.rb,
lib/smart_recruiters/models/subscriptions.rb,
lib/smart_recruiters/models/user_identity.rb,
lib/smart_recruiters/models/user_language.rb,
lib/smart_recruiters/api/configuration_api.rb,
lib/smart_recruiters/api/subscriptions_api.rb,
lib/smart_recruiters/models/apply_settings.rb,
lib/smart_recruiters/models/candidate_tags.rb,
lib/smart_recruiters/models/consent_status.rb,
lib/smart_recruiters/models/error_response.rb,
lib/smart_recruiters/models/hiring_process.rb,
lib/smart_recruiters/models/interview_type.rb,
lib/smart_recruiters/models/job_ad_content.rb,
lib/smart_recruiters/models/job_ad_section.rb,
lib/smart_recruiters/models/posting_status.rb,
lib/smart_recruiters/models/privacy_policy.rb,
lib/smart_recruiters/models/source_actions.rb,
lib/smart_recruiters/models/source_details.rb,
lib/smart_recruiters/models/user_list_item.rb,
lib/smart_recruiters/models/uuid_read_only.rb,
lib/smart_recruiters/models/application_url.rb,
lib/smart_recruiters/models/apply_api_error.rb,
lib/smart_recruiters/models/attendee_status.rb,
lib/smart_recruiters/models/candidate_input.rb,
lib/smart_recruiters/models/consent_request.rb,
lib/smart_recruiters/models/interview_types.rb,
lib/smart_recruiters/models/interviews_list.rb,
lib/smart_recruiters/models/job_ad_language.rb,
lib/smart_recruiters/models/job_ad_sections.rb,
lib/smart_recruiters/models/job_application.rb,
lib/smart_recruiters/models/job_job_actions.rb,
lib/smart_recruiters/models/message_details.rb,
lib/smart_recruiters/api/interview_types_api.rb,
lib/smart_recruiters/models/callback_request.rb,
lib/smart_recruiters/models/candidate_source.rb,
lib/smart_recruiters/models/candidate_status.rb,
lib/smart_recruiters/models/consent_decision.rb,
lib/smart_recruiters/models/hiring_processes.rb,
lib/smart_recruiters/models/personal_details.rb,
lib/smart_recruiters/models/publication_list.rb,
lib/smart_recruiters/models/screening_answer.rb,
lib/smart_recruiters/models/valid_job_status.rb,
lib/smart_recruiters/api/job_applications_api.rb,
lib/smart_recruiters/models/apply_api_request.rb,
lib/smart_recruiters/models/callback_requests.rb,
lib/smart_recruiters/models/candidate_actions.rb,
lib/smart_recruiters/models/candidate_consent.rb,
lib/smart_recruiters/models/candidate_details.rb,
lib/smart_recruiters/models/job_status_update.rb,
lib/smart_recruiters/models/label_translation.rb,
lib/smart_recruiters/models/onboarding_status.rb,
lib/smart_recruiters/models/screening_answers.rb,
lib/smart_recruiters/models/source_definition.rb,
lib/smart_recruiters/models/answer_field_value.rb,
lib/smart_recruiters/models/apply_api_response.rb,
lib/smart_recruiters/models/assignment_actions.rb,
lib/smart_recruiters/models/attachment_actions.rb,
lib/smart_recruiters/models/candidate_location.rb,
lib/smart_recruiters/models/candidate_property.rb,
lib/smart_recruiters/models/hiring_team_member.rb,
lib/smart_recruiters/models/job_location_input.rb,
lib/smart_recruiters/models/job_position_input.rb,
lib/smart_recruiters/models/job_property_input.rb,
lib/smart_recruiters/models/job_property_value.rb,
lib/smart_recruiters/models/job_status_history.rb,
lib/smart_recruiters/models/label_translations.rb,
lib/smart_recruiters/models/screening_question.rb,
lib/smart_recruiters/models/secret_key_payload.rb,
lib/smart_recruiters/models/user_language_code.rb,
lib/smart_recruiters/models/apply_configuration.rb,
lib/smart_recruiters/models/callback_basic_auth.rb,
lib/smart_recruiters/models/hiring_team_members.rb,
lib/smart_recruiters/models/id_attachments_body.rb,
lib/smart_recruiters/models/job_ad_item_actions.rb,
lib/smart_recruiters/models/job_details_actions.rb,
lib/smart_recruiters/models/job_webhook_payload.rb,
lib/smart_recruiters/models/callback_header_auth.rb,
lib/smart_recruiters/models/candidate_properties.rb,
lib/smart_recruiters/models/source_types_actions.rb,
lib/smart_recruiters/models/source_types_content.rb,
lib/smart_recruiters/models/subscription_request.rb,
lib/smart_recruiters/models/attendee_status_value.rb,
lib/smart_recruiters/models/callback_o_auth2_auth.rb,
lib/smart_recruiters/models/candidate_status_enum.rb,
lib/smart_recruiters/models/company_configuration.rb,
lib/smart_recruiters/models/job_approval_position.rb,
lib/smart_recruiters/models/offer_webhook_payload.rb,
lib/smart_recruiters/models/publication_list_item.rb,
lib/smart_recruiters/models/dependent_job_property.rb,
lib/smart_recruiters/models/job_ad_webhook_payload.rb,
lib/smart_recruiters/models/job_application_status.rb,
lib/smart_recruiters/models/review_webhook_payload.rb,
lib/smart_recruiters/models/application_status_info.rb,
lib/smart_recruiters/models/callback_authentication.rb,
lib/smart_recruiters/models/callback_request_status.rb,
lib/smart_recruiters/models/candidate_property_type.rb,
lib/smart_recruiters/models/consent_decision_status.rb,
lib/smart_recruiters/models/headcount_patch_request.rb,
lib/smart_recruiters/models/hiring_team_member_role.rb,
lib/smart_recruiters/models/job_id_attachments_body.rb,
lib/smart_recruiters/models/job_property_definition.rb,
lib/smart_recruiters/models/one_of_json_patch_items.rb,
lib/smart_recruiters/models/candidate_consent_status.rb,
lib/smart_recruiters/models/candidate_property_value.rb,
lib/smart_recruiters/models/consent_requests_results.rb,
lib/smart_recruiters/models/dependent_job_properties.rb,
lib/smart_recruiters/models/position_webhook_payload.rb,
lib/smart_recruiters/models/screening_question_field.rb,
lib/smart_recruiters/models/candidate_details_actions.rb,
lib/smart_recruiters/models/candidate_property_filter.rb,
lib/smart_recruiters/models/candidate_webhook_payload.rb,
lib/smart_recruiters/models/consent_request_scheduled.rb,
lib/smart_recruiters/models/headcount_update_accepted.rb,
lib/smart_recruiters/models/interview_to_update_input.rb,
lib/smart_recruiters/models/offer_properties_category.rb,
lib/smart_recruiters/models/offer_property_definition.rb,
lib/smart_recruiters/models/screening_question_answer.rb,
lib/smart_recruiters/models/user_entity_access_groups.rb,
lib/smart_recruiters/models/candidate_property_actions.rb,
lib/smart_recruiters/models/job_ad_unpublish_scheduled.rb,
lib/smart_recruiters/models/job_status_history_actions.rb,
lib/smart_recruiters/models/job_status_history_content.rb,
lib/smart_recruiters/models/application_webhook_payload.rb,
lib/smart_recruiters/models/candidate_consent_decisions.rb,
lib/smart_recruiters/models/consent_request_unavailable.rb,
lib/smart_recruiters/models/hiring_process_sub_statuses.rb,
lib/smart_recruiters/models/hiring_team_member_response.rb,
lib/smart_recruiters/models/offer_properties_definition.rb,
lib/smart_recruiters/models/relation_job_property_value.rb,
lib/smart_recruiters/models/candidate_attachment_for_job.rb,
lib/smart_recruiters/models/candidate_primary_assignment.rb,
lib/smart_recruiters/models/dependent_job_properties_ids.rb,
lib/smart_recruiters/models/dependent_job_property_value.rb,
lib/smart_recruiters/models/job_ad_publication_scheduled.rb,
lib/smart_recruiters/models/job_approval_webhook_payload.rb,
lib/smart_recruiters/models/job_property_definition_list.rb,
lib/smart_recruiters/models/user_list_item_access_groups.rb,
lib/smart_recruiters/models/candidate_attachments_for_job.rb,
lib/smart_recruiters/models/candidate_property_definition.rb,
lib/smart_recruiters/models/candidate_property_value_list.rb,
lib/smart_recruiters/models/candidate_status_history_list.rb,
lib/smart_recruiters/models/dependent_job_property_values.rb,
lib/smart_recruiters/models/job_property_value_definition.rb,
lib/smart_recruiters/models/candidate_property_input_value.rb,
lib/smart_recruiters/models/candidate_property_value_label.rb,
lib/smart_recruiters/models/consent_request_scheduled_body.rb,
lib/smart_recruiters/models/offer_approval_webhook_payload.rb,
lib/smart_recruiters/models/candidate_attendee_status_value.rb,
lib/smart_recruiters/models/candidate_property_availability.rb,
lib/smart_recruiters/models/candidate_secondary_assignments.rb,
lib/smart_recruiters/models/job_ad_postings_webhook_payload.rb,
lib/smart_recruiters/models/one_of_candidate_property_value.rb,
lib/smart_recruiters/models/callback_request_request_details.rb,
lib/smart_recruiters/models/candidate_primary_assignment_job.rb,
lib/smart_recruiters/models/candidate_property_filter_values.rb,
lib/smart_recruiters/models/candidate_property_definition_list.rb,
lib/smart_recruiters/models/candidate_status_history_list_elem.rb,
lib/smart_recruiters/models/job_property_value_definition_list.rb,
lib/smart_recruiters/models/onboarding_process_webhook_payload.rb,
lib/smart_recruiters/models/hiring_team_member_response_actions.rb,
lib/smart_recruiters/models/candidate_attachment_for_job_actions.rb,
lib/smart_recruiters/models/application_attachment_webhook_payload.rb,
lib/smart_recruiters/models/dependent_job_property_values_relation.rb,
lib/smart_recruiters/models/dependent_job_property_values_relations.rb,
lib/smart_recruiters/models/candidate_primary_assignment_job_actions.rb,
lib/smart_recruiters/models/job_property_definition_creation_request.rb,
lib/smart_recruiters/models/all_of_candidate_details_primary_assignment.rb,
lib/smart_recruiters/models/screening_questions_answers_webhook_payload.rb,
lib/smart_recruiters/models/one_of_consent_requests_results_results_items.rb,
lib/smart_recruiters/models/onboarding_assignments_completed_webhook_payload.rb,
lib/smart_recruiters/models/all_of_candidate_details_secondary_assignments_items.rb,
lib/smart_recruiters/models/onboarding_high_priority_assignments_completed_webhook_payload.rb

Defined Under Namespace

Classes: Action, Actions, AllOfCandidateDetailsPrimaryAssignment, AllOfCandidateDetailsSecondaryAssignmentsItems, AnswerField, AnswerFieldValue, AnswerRecord, ApiClient, ApiError, Application, ApplicationApi, ApplicationAttachmentWebhookPayload, ApplicationStatusInfo, ApplicationUrl, ApplicationWebhookPayload, Applications, ApplyApiError, ApplyApiRequest, ApplyApiResponse, ApplyConfiguration, ApplySettings, Assignment, AssignmentActions, Attachment, AttachmentActions, Attachments, AttendeeStatus, AttendeeStatusValue, Authorization, CallbackAuthentication, CallbackBasicAuth, CallbackHeaderAuth, CallbackOAuth2Auth, CallbackRequest, CallbackRequestRequestDetails, CallbackRequestStatus, CallbackRequests, CallbackUrl, Candidate, CandidateActions, CandidateAttachmentForJob, CandidateAttachmentForJobActions, CandidateAttachmentsForJob, CandidateAttendeeStatusValue, CandidateConsent, CandidateConsentDecisions, CandidateConsentStatus, CandidateDetails, CandidateDetailsActions, CandidateInput, CandidateJob, CandidateLocation, CandidatePrimaryAssignment, CandidatePrimaryAssignmentJob, CandidatePrimaryAssignmentJobActions, CandidateProperties, CandidateProperty, CandidatePropertyActions, CandidatePropertyAvailability, CandidatePropertyDefinition, CandidatePropertyDefinitionList, CandidatePropertyFilter, CandidatePropertyFilterValues, CandidatePropertyInputValue, CandidatePropertyType, CandidatePropertyValue, CandidatePropertyValueLabel, CandidatePropertyValueList, CandidateSecondaryAssignments, CandidateSource, CandidateStatus, CandidateStatusEnum, CandidateStatusHistoryList, CandidateStatusHistoryListElem, CandidateTags, CandidateWebhookPayload, Candidates, CandidatesApi, CompanyConfiguration, Compensation, Configuration, ConfigurationApi, ConsentDecision, ConsentDecisionStatus, ConsentRequest, ConsentRequestScheduled, ConsentRequestScheduledBody, ConsentRequestUnavailable, ConsentRequestsResults, ConsentScope, ConsentStatus, Context, Department, Departments, DependentJobProperties, DependentJobPropertiesIds, DependentJobProperty, DependentJobPropertyValue, DependentJobPropertyValues, DependentJobPropertyValuesRelation, DependentJobPropertyValuesRelations, Education, EmailAddress, Employment, Error, ErrorResponse, Event, EventName, Experience, FieldValue, HeadcountPatchRequest, HeadcountUpdateAccepted, HiringProcess, HiringProcessSubStatuses, HiringProcesses, HiringTeamMember, HiringTeamMemberResponse, HiringTeamMemberResponseActions, HiringTeamMemberRole, HiringTeamMembers, IdAttachmentsBody, Identifiable, Industry, Interview, InterviewToUpdateInput, InterviewType, InterviewTypes, InterviewTypesApi, Interviewer, Interviewers, InterviewsApi, InterviewsList, JSONPatch, Job, JobAd, JobAdContent, JobAdInput, JobAdItem, JobAdItemActions, JobAdLanguage, JobAdPostingsWebhookPayload, JobAdPublicationScheduled, JobAdSection, JobAdSections, JobAdUnpublishScheduled, JobAdVideos, JobAdWebhookPayload, JobAds, JobApplication, JobApplicationStatus, JobApplicationsApi, JobApproval, JobApprovalPosition, JobApprovalWebhookPayload, JobDetails, JobDetailsActions, JobIdAttachmentsBody, JobInput, JobJob, JobJobActions, JobLocationInput, JobNote, JobPosition, JobPositionInput, JobPositions, JobProperty, JobPropertyDefinition, JobPropertyDefinitionCreationRequest, JobPropertyDefinitionList, JobPropertyInput, JobPropertyValue, JobPropertyValueDefinition, JobPropertyValueDefinitionList, JobStatus, JobStatusHistory, JobStatusHistoryActions, JobStatusHistoryContent, JobStatusUpdate, JobSummary, JobWebhookPayload, Jobs, JobsApi, JsonPointer, LabelTranslation, LabelTranslations, Labeled, Language, LanguageCode, Location, Message, MessageDetails, MessageView, MessagesApi, MessagesView, ModelWhen, OfferApprovalWebhookPayload, OfferPropertiesCategory, OfferPropertiesDefinition, OfferPropertyDefinition, OfferWebhookPayload, OnboardingAssignmentsCompletedWebhookPayload, OnboardingHighPriorityAssignmentsCompletedWebhookPayload, OnboardingProcessWebhookPayload, OnboardingStatus, OneOfCandidatePropertyValue, OneOfConsentRequestsResultsResultsItems, OneOfJSONPatchItems, Path, PersonalDetails, PositionWebhookPayload, PostingStatus, PrivacyPolicy, Properties, Property, Publication, PublicationList, PublicationListItem, RelationJobPropertyValue, ReviewWebhookPayload, SalaryRange, ScreeningAnswer, ScreeningAnswers, ScreeningQuestion, ScreeningQuestionAnswer, ScreeningQuestionField, ScreeningQuestionsAnswersWebhookPayload, SecretKeyPayload, ShareWith, Source, SourceActions, SourceDefinition, SourceDetails, SourceTypes, SourceTypesActions, SourceTypesContent, Sources, StatusesApi, Subscription, SubscriptionRequest, Subscriptions, SubscriptionsApi, Timeslot, Timeslots, TimeslotsApi, User, UserEntity, UserEntityAccessGroups, UserId, UserIdentity, UserIds, UserLanguage, UserLanguageCode, UserListItem, UserListItemAccessGroups, Users, UsersApi, Uuid, UuidReadOnly, ValidJobStatus, Visibility, Web, WebProfile

Constant Summary collapse

VERSION =
"0.2.12"

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

SmartRecruiters.configure do |config|
  config.client_id = "xxx"
  config.client_secret = "xxx"
end

If no block given, return the default Configuration object.



22
23
24
25
26
27
28
# File 'lib/smart_recruiters.rb', line 22

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