Module: Crisphive

Defined in:
lib/crisphive/version.rb,
lib/crisphive.rb,
lib/crisphive/api_error.rb,
lib/crisphive/api_client.rb,
lib/crisphive/models/skill.rb,
lib/crisphive/configuration.rb,
lib/crisphive/models/vehicle.rb,
lib/crisphive/api/vehicle_api.rb,
lib/crisphive/models/customer.rb,
lib/crisphive/models/job_date.rb,
lib/crisphive/models/job_type.rb,
lib/crisphive/api/customer_api.rb,
lib/crisphive/api/job_types_api.rb,
lib/crisphive/models/pagination.rb,
lib/crisphive/models/skill_list.rb,
lib/crisphive/models/technician.rb,
lib/crisphive/api/technician_api.rb,
lib/crisphive/models/job_request.rb,
lib/crisphive/models/service_area.rb,
lib/crisphive/models/vehicle_list.rb,
lib/crisphive/api/service_area_api.rb,
lib/crisphive/models/customer_list.rb,
lib/crisphive/models/skill_summary.rb,
lib/crisphive/models/vehicle_owner.rb,
lib/crisphive/models/skill_category.rb,
lib/crisphive/api/business_skill_api.rb,
lib/crisphive/models/job_date_period.rb,
lib/crisphive/models/technician_list.rb,
lib/crisphive/models/customer_address.rb,
lib/crisphive/models/customer_contact.rb,
lib/crisphive/models/customer_profile.rb,
lib/crisphive/models/job_request_list.rb,
lib/crisphive/models/technician_skill.rb,
lib/crisphive/models/customer_spending.rb,
lib/crisphive/models/nearby_technician.rb,
lib/crisphive/models/response_envelope.rb,
lib/crisphive/models/service_area_list.rb,
lib/crisphive/models/technician_status.rb,
lib/crisphive/models/customer_list_item.rb,
lib/crisphive/models/job_request_period.rb,
lib/crisphive/models/nearby_technicians.rb,
lib/crisphive/models/technician_address.rb,
lib/crisphive/models/job_request_changes.rb,
lib/crisphive/models/job_request_session.rb,
lib/crisphive/models/skill_category_list.rb,
lib/crisphive/models/technician_lead_ref.rb,
lib/crisphive/models/technician_schedule.rb,
lib/crisphive/models/job_request_schedule.rb,
lib/crisphive/models/job_request_timeline.rb,
lib/crisphive/api/job_request_business_api.rb,
lib/crisphive/models/job_date_period_entry.rb,
lib/crisphive/models/job_request_move_plan.rb,
lib/crisphive/models/technician_skill_list.rb,
lib/crisphive/models/customer_tier_progress.rb,
lib/crisphive/models/skill_by_category_list.rb,
lib/crisphive/models/customer_create_request.rb,
lib/crisphive/models/customer_update_request.rb,
lib/crisphive/models/get_vehicle200_response.rb,
lib/crisphive/models/job_date_business_range.rb,
lib/crisphive/models/job_request_crew_change.rb,
lib/crisphive/models/job_request_crew_member.rb,
lib/crisphive/models/job_request_day_windows.rb,
lib/crisphive/models/job_request_move_member.rb,
lib/crisphive/models/list_skills200_response.rb,
lib/crisphive/models/customer_address_request.rb,
lib/crisphive/models/customer_create_response.rb,
lib/crisphive/models/get_customer200_response.rb,
lib/crisphive/models/get_job_type200_response.rb,
lib/crisphive/models/job_request_move_warning.rb,
lib/crisphive/models/technician_address_input.rb,
lib/crisphive/models/technician_leads_request.rb,
lib/crisphive/models/job_request_quote_request.rb,
lib/crisphive/models/job_request_quote_summary.rb,
lib/crisphive/models/job_request_skill_summary.rb,
lib/crisphive/models/job_request_time_segments.rb,
lib/crisphive/models/list_vehicles200_response.rb,
lib/crisphive/models/technician_create_request.rb,
lib/crisphive/models/technician_schedule_block.rb,
lib/crisphive/models/technician_skills_request.rb,
lib/crisphive/models/technician_update_request.rb,
lib/crisphive/models/get_technician200_response.rb,
lib/crisphive/models/job_request_action_summary.rb,
lib/crisphive/models/job_request_arrival_window.rb,
lib/crisphive/models/job_request_create_request.rb,
lib/crisphive/models/job_request_emergency_plan.rb,
lib/crisphive/models/job_request_lead_candidate.rb,
lib/crisphive/models/job_request_rating_summary.rb,
lib/crisphive/models/job_request_reschedule_day.rb,
lib/crisphive/models/job_request_status_summary.rb,
lib/crisphive/models/job_request_tech_candidate.rb,
lib/crisphive/models/job_request_timeline_event.rb,
lib/crisphive/models/list_customers200_response.rb,
lib/crisphive/models/list_job_types200_response.rb,
lib/crisphive/models/technician_buddies_request.rb,
lib/crisphive/models/technician_create_response.rb,
lib/crisphive/models/create_customer200_response.rb,
lib/crisphive/models/get_job_request200_response.rb,
lib/crisphive/models/job_request_action_audit_by.rb,
lib/crisphive/models/job_request_address_summary.rb,
lib/crisphive/models/job_request_archive_summary.rb,
lib/crisphive/models/job_request_booking_windows.rb,
lib/crisphive/models/job_request_confirm_request.rb,
lib/crisphive/models/job_request_create_response.rb,
lib/crisphive/models/job_request_crew_candidates.rb,
lib/crisphive/models/job_request_move_commit_req.rb,
lib/crisphive/models/job_request_reschedule_move.rb,
lib/crisphive/models/job_request_technician_info.rb,
lib/crisphive/models/job_request_timeline_action.rb,
lib/crisphive/models/technician_schedule_session.rb,
lib/crisphive/models/technician_service_area_ref.rb,
lib/crisphive/models/technician_vehicles_request.rb,
lib/crisphive/models/get_service_area200_response.rb,
lib/crisphive/models/job_request_assigned_vehicle.rb,
lib/crisphive/models/job_request_customer_summary.rb,
lib/crisphive/models/job_request_job_date_request.rb,
lib/crisphive/models/job_request_move_preview_req.rb,
lib/crisphive/models/list_technicians200_response.rb,
lib/crisphive/models/create_technician200_response.rb,
lib/crisphive/models/job_request_attention_summary.rb,
lib/crisphive/models/job_request_available_vehicle.rb,
lib/crisphive/models/job_request_crew_member_input.rb,
lib/crisphive/models/job_request_time_segments_day.rb,
lib/crisphive/models/list_job_requests200_response.rb,
lib/crisphive/models/create_job_request200_response.rb,
lib/crisphive/models/job_request_action_audit_entry.rb,
lib/crisphive/models/job_request_assignment_summary.rb,
lib/crisphive/models/job_request_time_segments_slot.rb,
lib/crisphive/models/list_service_areas200_response.rb,
lib/crisphive/models/job_request_business_time_range.rb,
lib/crisphive/models/job_request_crew_recommendation.rb,
lib/crisphive/models/job_request_emergency_candidate.rb,
lib/crisphive/models/list_matching_slots200_response.rb,
lib/crisphive/models/job_request_emergency_candidates.rb,
lib/crisphive/models/job_request_time_segments_worker.rb,
lib/crisphive/models/list_crew_candidates200_response.rb,
lib/crisphive/models/technician_service_areas_request.rb,
lib/crisphive/models/job_request_buddy_slot_candidates.rb,
lib/crisphive/models/list_skill_categories200_response.rb,
lib/crisphive/models/technician_service_areas_response.rb,
lib/crisphive/models/list_technician_skills200_response.rb,
lib/crisphive/models/commit_job_request_move200_response.rb,
lib/crisphive/models/get_technician_schedule200_response.rb,
lib/crisphive/models/job_request_job_date_period_request.rb,
lib/crisphive/models/job_request_reschedule_reassignment.rb,
lib/crisphive/models/job_request_update_priority_request.rb,
lib/crisphive/models/list_nearby_technicians200_response.rb,
lib/crisphive/models/list_skills_by_category200_response.rb,
lib/crisphive/models/get_job_request_timeline200_response.rb,
lib/crisphive/models/job_request_emergency_commit_request.rb,
lib/crisphive/models/list_job_request_changes200_response.rb,
lib/crisphive/models/job_request_emergency_preview_request.rb,
lib/crisphive/models/list_emergency_candidates200_response.rb,
lib/crisphive/models/commit_emergency_reschedule200_response.rb,
lib/crisphive/models/job_request_time_segments_business_time.rb,
lib/crisphive/models/job_request_emergency_candidates_request.rb,
lib/crisphive/models/job_request_job_date_business_range_request.rb,
lib/crisphive/models/list_job_request_booking_windows200_response.rb,
lib/crisphive/models/replace_technician_service_areas200_response.rb

Overview

#Crisphive Developer API

#Public REST API for integrating Crisphive from your own backend. Authenticate every request with a secret API key as a Bearer token (Authorization: Bearer chsk_live_…). The key prefix selects the data environment: chsk_live_… → production (live), chsk_test_… → sandbox (isolated test). Key scopes (restricted keys). A key is either full-access (can call every endpoint below) or restricted to a set of permission codes chosen at creation — the same codes as the dashboard permission grid (e.g. customers_view, job_create, team_manage). A restricted key calling an endpoint outside its scope gets 403. The full code list is the permission catalog (GET /permission/modules on the dashboard API). Create, scope, and revoke keys from the business dashboard. Every response is wrapped in the envelope { \"error_code\": 0, \"message\": \"Success\", \"data\": <payload> }.

The version of the OpenAPI document: 1.0

Generated by: https://openapi-generator.tech Generator version: 7.11.0

Defined Under Namespace

Classes: ApiClient, ApiError, BusinessSkillApi, CommitEmergencyReschedule200Response, CommitJobRequestMove200Response, Configuration, CreateCustomer200Response, CreateJobRequest200Response, CreateTechnician200Response, Customer, CustomerAddress, CustomerAddressRequest, CustomerApi, CustomerContact, CustomerCreateRequest, CustomerCreateResponse, CustomerList, CustomerListItem, CustomerProfile, CustomerSpending, CustomerTierProgress, CustomerUpdateRequest, GetCustomer200Response, GetJobRequest200Response, GetJobRequestTimeline200Response, GetJobType200Response, GetServiceArea200Response, GetTechnician200Response, GetTechnicianSchedule200Response, GetVehicle200Response, JobDate, JobDateBusinessRange, JobDatePeriod, JobDatePeriodEntry, JobRequest, JobRequestActionAuditBy, JobRequestActionAuditEntry, JobRequestActionSummary, JobRequestAddressSummary, JobRequestArchiveSummary, JobRequestArrivalWindow, JobRequestAssignedVehicle, JobRequestAssignmentSummary, JobRequestAttentionSummary, JobRequestAvailableVehicle, JobRequestBookingWindows, JobRequestBuddySlotCandidates, JobRequestBusinessApi, JobRequestBusinessTimeRange, JobRequestChanges, JobRequestConfirmRequest, JobRequestCreateRequest, JobRequestCreateResponse, JobRequestCrewCandidates, JobRequestCrewChange, JobRequestCrewMember, JobRequestCrewMemberInput, JobRequestCrewRecommendation, JobRequestCustomerSummary, JobRequestDayWindows, JobRequestEmergencyCandidate, JobRequestEmergencyCandidates, JobRequestEmergencyCandidatesRequest, JobRequestEmergencyCommitRequest, JobRequestEmergencyPlan, JobRequestEmergencyPreviewRequest, JobRequestJobDateBusinessRangeRequest, JobRequestJobDatePeriodRequest, JobRequestJobDateRequest, JobRequestLeadCandidate, JobRequestList, JobRequestMoveCommitReq, JobRequestMoveMember, JobRequestMovePlan, JobRequestMovePreviewReq, JobRequestMoveWarning, JobRequestPeriod, JobRequestQuoteRequest, JobRequestQuoteSummary, JobRequestRatingSummary, JobRequestRescheduleDay, JobRequestRescheduleMove, JobRequestRescheduleReassignment, JobRequestSchedule, JobRequestSession, JobRequestSkillSummary, JobRequestStatusSummary, JobRequestTechCandidate, JobRequestTechnicianInfo, JobRequestTimeSegments, JobRequestTimeSegmentsBusinessTime, JobRequestTimeSegmentsDay, JobRequestTimeSegmentsSlot, JobRequestTimeSegmentsWorker, JobRequestTimeline, JobRequestTimelineAction, JobRequestTimelineEvent, JobRequestUpdatePriorityRequest, JobType, JobTypesApi, ListCrewCandidates200Response, ListCustomers200Response, ListEmergencyCandidates200Response, ListJobRequestBookingWindows200Response, ListJobRequestChanges200Response, ListJobRequests200Response, ListJobTypes200Response, ListMatchingSlots200Response, ListNearbyTechnicians200Response, ListServiceAreas200Response, ListSkillCategories200Response, ListSkills200Response, ListSkillsByCategory200Response, ListTechnicianSkills200Response, ListTechnicians200Response, ListVehicles200Response, NearbyTechnician, NearbyTechnicians, Pagination, ReplaceTechnicianServiceAreas200Response, ResponseEnvelope, ServiceArea, ServiceAreaApi, ServiceAreaList, Skill, SkillByCategoryList, SkillCategory, SkillCategoryList, SkillList, SkillSummary, Technician, TechnicianAddress, TechnicianAddressInput, TechnicianApi, TechnicianBuddiesRequest, TechnicianCreateRequest, TechnicianCreateResponse, TechnicianLeadRef, TechnicianLeadsRequest, TechnicianList, TechnicianSchedule, TechnicianScheduleBlock, TechnicianScheduleSession, TechnicianServiceAreaRef, TechnicianServiceAreasRequest, TechnicianServiceAreasResponse, TechnicianSkill, TechnicianSkillList, TechnicianSkillsRequest, TechnicianStatus, TechnicianUpdateRequest, TechnicianVehiclesRequest, Vehicle, VehicleApi, VehicleList, VehicleOwner

Constant Summary collapse

VERSION = 
'0.2.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. Crisphive.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



184
185
186
187
188
189
190
 
# File 'lib/crisphive.rb', line 184

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