crisphive 0.1.0 → 0.2.0
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 +4 -4
- data/README.md +90 -11
- data/crisphive.gemspec +5 -5
- data/lib/crisphive/api/business_skill_api.rb +154 -8
- data/lib/crisphive/api/customer_api.rb +15 -12
- data/lib/crisphive/api/job_request_business_api.rb +1002 -112
- data/lib/crisphive/api/job_types_api.rb +6 -2
- data/lib/crisphive/api/service_area_api.rb +6 -6
- data/lib/crisphive/api/technician_api.rb +510 -6
- data/lib/crisphive/api/vehicle_api.rb +6 -6
- data/lib/crisphive/api_client.rb +2 -2
- data/lib/crisphive/api_error.rb +2 -2
- data/lib/crisphive/configuration.rb +3 -3
- data/lib/crisphive/models/commit_emergency_reschedule200_response.rb +253 -0
- data/lib/crisphive/models/commit_job_request_move200_response.rb +253 -0
- data/lib/crisphive/models/create_customer200_response.rb +5 -2
- data/lib/crisphive/models/create_job_request200_response.rb +5 -2
- data/lib/crisphive/models/create_technician200_response.rb +253 -0
- data/lib/crisphive/models/customer.rb +2 -2
- data/lib/crisphive/models/customer_address.rb +2 -2
- data/lib/crisphive/models/customer_address_request.rb +11 -2
- data/lib/crisphive/models/customer_contact.rb +2 -2
- data/lib/crisphive/models/customer_create_request.rb +2 -2
- data/lib/crisphive/models/customer_create_response.rb +2 -2
- data/lib/crisphive/models/customer_list.rb +3 -3
- data/lib/crisphive/models/customer_list_item.rb +2 -2
- data/lib/crisphive/models/customer_profile.rb +2 -2
- data/lib/crisphive/models/customer_spending.rb +2 -2
- data/lib/crisphive/models/customer_tier_progress.rb +2 -2
- data/lib/crisphive/models/customer_update_request.rb +2 -2
- data/lib/crisphive/models/get_customer200_response.rb +5 -2
- data/lib/crisphive/models/get_job_request200_response.rb +5 -2
- data/lib/crisphive/models/get_job_request_timeline200_response.rb +5 -2
- data/lib/crisphive/models/get_job_type200_response.rb +5 -2
- data/lib/crisphive/models/get_service_area200_response.rb +5 -2
- data/lib/crisphive/models/get_technician200_response.rb +5 -2
- data/lib/crisphive/models/get_technician_schedule200_response.rb +253 -0
- data/lib/crisphive/models/get_vehicle200_response.rb +5 -2
- data/lib/crisphive/models/job_date.rb +5 -3
- data/lib/crisphive/models/job_date_business_range.rb +7 -3
- data/lib/crisphive/models/job_date_period.rb +2 -2
- data/lib/crisphive/models/job_date_period_entry.rb +4 -2
- data/lib/crisphive/models/job_request.rb +46 -6
- data/lib/crisphive/models/job_request_action_audit_by.rb +2 -2
- data/lib/crisphive/models/job_request_action_audit_entry.rb +3 -3
- data/lib/crisphive/models/job_request_action_summary.rb +2 -2
- data/lib/crisphive/models/job_request_address_summary.rb +2 -2
- data/lib/crisphive/models/job_request_archive_summary.rb +2 -2
- data/lib/crisphive/models/job_request_arrival_window.rb +4 -4
- data/lib/crisphive/models/job_request_assigned_vehicle.rb +2 -2
- data/lib/crisphive/models/job_request_assignment_summary.rb +2 -2
- data/lib/crisphive/models/job_request_attention_summary.rb +259 -0
- data/lib/crisphive/models/job_request_available_vehicle.rb +235 -0
- data/lib/crisphive/models/job_request_booking_windows.rb +2 -2
- data/lib/crisphive/models/job_request_buddy_slot_candidates.rb +239 -0
- data/lib/crisphive/models/job_request_business_time_range.rb +3 -3
- data/lib/crisphive/models/job_request_changes.rb +2 -2
- data/lib/crisphive/models/job_request_confirm_request.rb +245 -0
- data/lib/crisphive/models/job_request_create_request.rb +60 -6
- data/lib/crisphive/models/job_request_create_response.rb +2 -2
- data/lib/crisphive/models/job_request_crew_candidates.rb +227 -0
- data/lib/crisphive/models/job_request_crew_change.rb +299 -0
- data/lib/crisphive/models/job_request_crew_member.rb +7 -4
- data/lib/crisphive/models/job_request_crew_member_input.rb +284 -0
- data/lib/crisphive/models/job_request_crew_recommendation.rb +255 -0
- data/lib/crisphive/models/job_request_customer_summary.rb +2 -2
- data/lib/crisphive/models/job_request_day_windows.rb +3 -3
- data/lib/crisphive/models/job_request_emergency_candidate.rb +297 -0
- data/lib/crisphive/models/job_request_emergency_candidates.rb +311 -0
- data/lib/crisphive/models/job_request_emergency_candidates_request.rb +328 -0
- data/lib/crisphive/models/job_request_emergency_commit_request.rb +351 -0
- data/lib/crisphive/models/job_request_emergency_plan.rb +345 -0
- data/lib/crisphive/models/job_request_emergency_preview_request.rb +329 -0
- data/lib/crisphive/models/job_request_job_date_business_range_request.rb +3 -3
- data/lib/crisphive/models/job_request_job_date_period_request.rb +2 -2
- data/lib/crisphive/models/job_request_job_date_request.rb +3 -3
- data/lib/crisphive/models/job_request_lead_candidate.rb +311 -0
- data/lib/crisphive/models/job_request_list.rb +2 -2
- data/lib/crisphive/models/job_request_move_commit_req.rb +343 -0
- data/lib/crisphive/models/job_request_move_member.rb +299 -0
- data/lib/crisphive/models/job_request_move_plan.rb +377 -0
- data/lib/crisphive/models/job_request_move_preview_req.rb +290 -0
- data/lib/crisphive/models/job_request_move_warning.rb +311 -0
- data/lib/crisphive/models/job_request_period.rb +2 -2
- data/lib/crisphive/models/job_request_quote_request.rb +340 -0
- data/lib/crisphive/models/job_request_quote_summary.rb +2 -2
- data/lib/crisphive/models/job_request_rating_summary.rb +2 -2
- data/lib/crisphive/models/job_request_reschedule_day.rb +227 -0
- data/lib/crisphive/models/job_request_reschedule_move.rb +319 -0
- data/lib/crisphive/models/job_request_reschedule_reassignment.rb +339 -0
- data/lib/crisphive/models/job_request_schedule.rb +2 -2
- data/lib/crisphive/models/job_request_session.rb +8 -7
- data/lib/crisphive/models/job_request_skill_summary.rb +2 -2
- data/lib/crisphive/models/job_request_status_summary.rb +2 -2
- data/lib/crisphive/models/job_request_tech_candidate.rb +287 -0
- data/lib/crisphive/models/job_request_technician_info.rb +2 -2
- data/lib/crisphive/models/job_request_time_segments.rb +287 -0
- data/lib/crisphive/models/job_request_time_segments_business_time.rb +321 -0
- data/lib/crisphive/models/job_request_time_segments_day.rb +247 -0
- data/lib/crisphive/models/job_request_time_segments_slot.rb +375 -0
- data/lib/crisphive/models/job_request_time_segments_worker.rb +295 -0
- data/lib/crisphive/models/job_request_timeline.rb +2 -2
- data/lib/crisphive/models/job_request_timeline_action.rb +2 -2
- data/lib/crisphive/models/job_request_timeline_event.rb +2 -2
- data/lib/crisphive/models/job_request_update_priority_request.rb +295 -0
- data/lib/crisphive/models/job_type.rb +2 -2
- data/lib/crisphive/models/list_crew_candidates200_response.rb +253 -0
- data/lib/crisphive/models/list_customers200_response.rb +5 -2
- data/lib/crisphive/models/list_emergency_candidates200_response.rb +253 -0
- data/lib/crisphive/models/list_job_request_booking_windows200_response.rb +5 -2
- data/lib/crisphive/models/list_job_request_changes200_response.rb +5 -2
- data/lib/crisphive/models/list_job_requests200_response.rb +5 -2
- data/lib/crisphive/models/list_job_types200_response.rb +5 -2
- data/lib/crisphive/models/list_matching_slots200_response.rb +253 -0
- data/lib/crisphive/models/list_nearby_technicians200_response.rb +253 -0
- data/lib/crisphive/models/list_service_areas200_response.rb +5 -2
- data/lib/crisphive/models/list_skill_categories200_response.rb +5 -2
- data/lib/crisphive/models/list_skills200_response.rb +5 -2
- data/lib/crisphive/models/list_skills_by_category200_response.rb +5 -2
- data/lib/crisphive/models/list_technician_skills200_response.rb +253 -0
- data/lib/crisphive/models/list_technicians200_response.rb +5 -2
- data/lib/crisphive/models/list_vehicles200_response.rb +5 -2
- data/lib/crisphive/models/nearby_technician.rb +319 -0
- data/lib/crisphive/models/nearby_technicians.rb +237 -0
- data/lib/crisphive/models/pagination.rb +7 -2
- data/lib/crisphive/models/replace_technician_service_areas200_response.rb +253 -0
- data/lib/crisphive/models/response_envelope.rb +6 -2
- data/lib/crisphive/models/service_area.rb +2 -2
- data/lib/crisphive/models/service_area_list.rb +2 -2
- data/lib/crisphive/models/skill.rb +9 -2
- data/lib/crisphive/models/skill_by_category_list.rb +4 -2
- data/lib/crisphive/models/skill_category.rb +7 -2
- data/lib/crisphive/models/skill_category_list.rb +4 -2
- data/lib/crisphive/models/skill_list.rb +2 -2
- data/lib/crisphive/models/skill_summary.rb +2 -2
- data/lib/crisphive/models/technician.rb +2 -2
- data/lib/crisphive/models/technician_address.rb +2 -2
- data/lib/crisphive/models/technician_address_input.rb +408 -0
- data/lib/crisphive/models/technician_buddies_request.rb +236 -0
- data/lib/crisphive/models/technician_create_request.rb +600 -0
- data/lib/crisphive/models/technician_create_response.rb +215 -0
- data/lib/crisphive/models/technician_lead_ref.rb +2 -2
- data/lib/crisphive/models/technician_leads_request.rb +236 -0
- data/lib/crisphive/models/technician_list.rb +3 -3
- data/lib/crisphive/models/technician_schedule.rb +279 -0
- data/lib/crisphive/models/technician_schedule_block.rb +225 -0
- data/lib/crisphive/models/technician_schedule_session.rb +311 -0
- data/lib/crisphive/models/technician_service_area_ref.rb +2 -2
- data/lib/crisphive/models/technician_service_areas_request.rb +236 -0
- data/lib/crisphive/models/technician_service_areas_response.rb +217 -0
- data/lib/crisphive/models/technician_skill.rb +265 -0
- data/lib/crisphive/models/technician_skill_list.rb +227 -0
- data/lib/crisphive/models/technician_skills_request.rb +236 -0
- data/lib/crisphive/models/technician_status.rb +2 -2
- data/lib/crisphive/models/technician_update_request.rb +507 -0
- data/lib/crisphive/models/technician_vehicles_request.rb +236 -0
- data/lib/crisphive/models/vehicle.rb +26 -4
- data/lib/crisphive/models/vehicle_list.rb +2 -2
- data/lib/crisphive/models/vehicle_owner.rb +2 -2
- data/lib/crisphive/version.rb +3 -3
- data/lib/crisphive.rb +60 -2
- data/spec/spec_helper.rb +2 -2
- metadata +63 -5
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Crisphive Developer API
|
|
3
|
+
|
|
4
|
+
#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> }`.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.11.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Crisphive
|
|
17
|
+
class GetTechnicianSchedule200Response
|
|
18
|
+
attr_accessor :data
|
|
19
|
+
|
|
20
|
+
# 0 on success; a stable string error code (e.g. \"VALIDATION_ERROR\") on failure.
|
|
21
|
+
attr_accessor :error_code
|
|
22
|
+
|
|
23
|
+
# Field-level validation details; present only for VALIDATION_ERROR responses.
|
|
24
|
+
attr_accessor :errors
|
|
25
|
+
|
|
26
|
+
# Human-readable message (\"Success\" or an error description), localized via the X-Locale header.
|
|
27
|
+
attr_accessor :message
|
|
28
|
+
|
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
30
|
+
def self.attribute_map
|
|
31
|
+
{
|
|
32
|
+
:'data' => :'data',
|
|
33
|
+
:'error_code' => :'error_code',
|
|
34
|
+
:'errors' => :'errors',
|
|
35
|
+
:'message' => :'message'
|
|
36
|
+
}
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Returns all the JSON keys this model knows about
|
|
40
|
+
def self.acceptable_attributes
|
|
41
|
+
attribute_map.values
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Attribute type mapping.
|
|
45
|
+
def self.openapi_types
|
|
46
|
+
{
|
|
47
|
+
:'data' => :'TechnicianSchedule',
|
|
48
|
+
:'error_code' => :'Object',
|
|
49
|
+
:'errors' => :'Object',
|
|
50
|
+
:'message' => :'String'
|
|
51
|
+
}
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# List of attributes with nullable: true
|
|
55
|
+
def self.openapi_nullable
|
|
56
|
+
Set.new([
|
|
57
|
+
:'error_code',
|
|
58
|
+
:'errors',
|
|
59
|
+
])
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# List of class defined in allOf (OpenAPI v3)
|
|
63
|
+
def self.openapi_all_of
|
|
64
|
+
[
|
|
65
|
+
:'ResponseEnvelope'
|
|
66
|
+
]
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Initializes the object
|
|
70
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
71
|
+
def initialize(attributes = {})
|
|
72
|
+
if (!attributes.is_a?(Hash))
|
|
73
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Crisphive::GetTechnicianSchedule200Response` initialize method"
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
77
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
78
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
79
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Crisphive::GetTechnicianSchedule200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
80
|
+
end
|
|
81
|
+
h[k.to_sym] = v
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
if attributes.key?(:'data')
|
|
85
|
+
self.data = attributes[:'data']
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
if attributes.key?(:'error_code')
|
|
89
|
+
self.error_code = attributes[:'error_code']
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
if attributes.key?(:'errors')
|
|
93
|
+
self.errors = attributes[:'errors']
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
if attributes.key?(:'message')
|
|
97
|
+
self.message = attributes[:'message']
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
102
|
+
# @return Array for valid properties with the reasons
|
|
103
|
+
def list_invalid_properties
|
|
104
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
105
|
+
invalid_properties = Array.new
|
|
106
|
+
invalid_properties
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Check to see if the all the properties in the model are valid
|
|
110
|
+
# @return true if the model is valid
|
|
111
|
+
def valid?
|
|
112
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
113
|
+
true
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Checks equality by comparing each attribute.
|
|
117
|
+
# @param [Object] Object to be compared
|
|
118
|
+
def ==(o)
|
|
119
|
+
return true if self.equal?(o)
|
|
120
|
+
self.class == o.class &&
|
|
121
|
+
data == o.data &&
|
|
122
|
+
error_code == o.error_code &&
|
|
123
|
+
errors == o.errors &&
|
|
124
|
+
message == o.message
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# @see the `==` method
|
|
128
|
+
# @param [Object] Object to be compared
|
|
129
|
+
def eql?(o)
|
|
130
|
+
self == o
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Calculates hash code according to all attributes.
|
|
134
|
+
# @return [Integer] Hash code
|
|
135
|
+
def hash
|
|
136
|
+
[data, error_code, errors, message].hash
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Builds the object from hash
|
|
140
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
141
|
+
# @return [Object] Returns the model itself
|
|
142
|
+
def self.build_from_hash(attributes)
|
|
143
|
+
return nil unless attributes.is_a?(Hash)
|
|
144
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
145
|
+
transformed_hash = {}
|
|
146
|
+
openapi_types.each_pair do |key, type|
|
|
147
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
148
|
+
transformed_hash["#{key}"] = nil
|
|
149
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
150
|
+
# check to ensure the input is an array given that the attribute
|
|
151
|
+
# is documented as an array but the input is not
|
|
152
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
153
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
154
|
+
end
|
|
155
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
156
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
new(transformed_hash)
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# Deserializes the data based on type
|
|
163
|
+
# @param string type Data type
|
|
164
|
+
# @param string value Value to be deserialized
|
|
165
|
+
# @return [Object] Deserialized data
|
|
166
|
+
def self._deserialize(type, value)
|
|
167
|
+
case type.to_sym
|
|
168
|
+
when :Time
|
|
169
|
+
Time.parse(value)
|
|
170
|
+
when :Date
|
|
171
|
+
Date.parse(value)
|
|
172
|
+
when :String
|
|
173
|
+
value.to_s
|
|
174
|
+
when :Integer
|
|
175
|
+
value.to_i
|
|
176
|
+
when :Float
|
|
177
|
+
value.to_f
|
|
178
|
+
when :Boolean
|
|
179
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
180
|
+
true
|
|
181
|
+
else
|
|
182
|
+
false
|
|
183
|
+
end
|
|
184
|
+
when :Object
|
|
185
|
+
# generic object (usually a Hash), return directly
|
|
186
|
+
value
|
|
187
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
188
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
189
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
190
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
191
|
+
k_type = Regexp.last_match[:k_type]
|
|
192
|
+
v_type = Regexp.last_match[:v_type]
|
|
193
|
+
{}.tap do |hash|
|
|
194
|
+
value.each do |k, v|
|
|
195
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
else # model
|
|
199
|
+
# models (e.g. Pet) or oneOf
|
|
200
|
+
klass = Crisphive.const_get(type)
|
|
201
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Returns the string representation of the object
|
|
206
|
+
# @return [String] String presentation of the object
|
|
207
|
+
def to_s
|
|
208
|
+
to_hash.to_s
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
212
|
+
# @return [Hash] Returns the object in the form of hash
|
|
213
|
+
def to_body
|
|
214
|
+
to_hash
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Returns the object in the form of hash
|
|
218
|
+
# @return [Hash] Returns the object in the form of hash
|
|
219
|
+
def to_hash
|
|
220
|
+
hash = {}
|
|
221
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
222
|
+
value = self.send(attr)
|
|
223
|
+
if value.nil?
|
|
224
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
225
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
hash[param] = _to_hash(value)
|
|
229
|
+
end
|
|
230
|
+
hash
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
# Outputs non-array value in the form of hash
|
|
234
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
235
|
+
# @param [Object] value Any valid value
|
|
236
|
+
# @return [Hash] Returns the value in the form of hash
|
|
237
|
+
def _to_hash(value)
|
|
238
|
+
if value.is_a?(Array)
|
|
239
|
+
value.compact.map { |v| _to_hash(v) }
|
|
240
|
+
elsif value.is_a?(Hash)
|
|
241
|
+
{}.tap do |hash|
|
|
242
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
243
|
+
end
|
|
244
|
+
elsif value.respond_to? :to_hash
|
|
245
|
+
value.to_hash
|
|
246
|
+
else
|
|
247
|
+
value
|
|
248
|
+
end
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -17,10 +17,13 @@ module Crisphive
|
|
|
17
17
|
class GetVehicle200Response
|
|
18
18
|
attr_accessor :data
|
|
19
19
|
|
|
20
|
+
# 0 on success; a stable string error code (e.g. \"VALIDATION_ERROR\") on failure.
|
|
20
21
|
attr_accessor :error_code
|
|
21
22
|
|
|
23
|
+
# Field-level validation details; present only for VALIDATION_ERROR responses.
|
|
22
24
|
attr_accessor :errors
|
|
23
25
|
|
|
26
|
+
# Human-readable message (\"Success\" or an error description), localized via the X-Locale header.
|
|
24
27
|
attr_accessor :message
|
|
25
28
|
|
|
26
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -15,8 +15,10 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module Crisphive
|
|
17
17
|
class JobDate
|
|
18
|
+
# Requested calendar day (YYYY-MM-DD), customer-local.
|
|
18
19
|
attr_accessor :date
|
|
19
20
|
|
|
21
|
+
# Time-of-day periods picked on this date.
|
|
20
22
|
attr_accessor :periods
|
|
21
23
|
|
|
22
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -35,7 +37,7 @@ module Crisphive
|
|
|
35
37
|
# Attribute type mapping.
|
|
36
38
|
def self.openapi_types
|
|
37
39
|
{
|
|
38
|
-
:'date' => :'
|
|
40
|
+
:'date' => :'Date',
|
|
39
41
|
:'periods' => :'Array<JobDatePeriodEntry>'
|
|
40
42
|
}
|
|
41
43
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -15,12 +15,16 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module Crisphive
|
|
17
17
|
class JobDateBusinessRange
|
|
18
|
+
# Calendar day (YYYY-MM-DD) this range falls on, business-local.
|
|
18
19
|
attr_accessor :date
|
|
19
20
|
|
|
21
|
+
# Range end as minutes since business-local midnight (0–1440); 1440 = end of day.
|
|
20
22
|
attr_accessor :end_minute
|
|
21
23
|
|
|
24
|
+
# Time-of-day period this range backs.
|
|
22
25
|
attr_accessor :period
|
|
23
26
|
|
|
27
|
+
# Range start as minutes since business-local midnight (0–1440).
|
|
24
28
|
attr_accessor :start_minute
|
|
25
29
|
|
|
26
30
|
class EnumAttributeValidator
|
|
@@ -63,7 +67,7 @@ module Crisphive
|
|
|
63
67
|
# Attribute type mapping.
|
|
64
68
|
def self.openapi_types
|
|
65
69
|
{
|
|
66
|
-
:'date' => :'
|
|
70
|
+
:'date' => :'Date',
|
|
67
71
|
:'end_minute' => :'Integer',
|
|
68
72
|
:'period' => :'JobDatePeriod',
|
|
69
73
|
:'start_minute' => :'Integer'
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -15,8 +15,10 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module Crisphive
|
|
17
17
|
class JobDatePeriodEntry
|
|
18
|
+
# Business-local minute ranges that back this period selection.
|
|
18
19
|
attr_accessor :business_view
|
|
19
20
|
|
|
21
|
+
# Time-of-day period the customer picked.
|
|
20
22
|
attr_accessor :period
|
|
21
23
|
|
|
22
24
|
class EnumAttributeValidator
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -30,6 +30,9 @@ module Crisphive
|
|
|
30
30
|
# Who/what is assigned to the job.
|
|
31
31
|
attr_accessor :assignment
|
|
32
32
|
|
|
33
|
+
# Attention is the dispatch-board \"needs attention\" marker (exception tray); null when the job needs no attention.
|
|
34
|
+
attr_accessor :attention
|
|
35
|
+
|
|
33
36
|
# UUID of the owning business.
|
|
34
37
|
attr_accessor :business_id
|
|
35
38
|
|
|
@@ -72,7 +75,7 @@ module Crisphive
|
|
|
72
75
|
# The action(s) the job is currently waiting on. Omitted in a terminal status.
|
|
73
76
|
attr_accessor :next_actions
|
|
74
77
|
|
|
75
|
-
#
|
|
78
|
+
# Scheduling priority. p0=emergency (interrupt-driven), p1=top (displaced only by p0), p2=standard, p3=deferrable (first candidate for displacement).
|
|
76
79
|
attr_accessor :priority
|
|
77
80
|
|
|
78
81
|
# The time-bundle quoted for the job.
|
|
@@ -90,6 +93,15 @@ module Crisphive
|
|
|
90
93
|
# Desired skills for the job (resolved id+name).
|
|
91
94
|
attr_accessor :skills
|
|
92
95
|
|
|
96
|
+
# SLA deadline (UTC) armed on a p1 job; omitted when no SLA.
|
|
97
|
+
attr_accessor :sla_deadline
|
|
98
|
+
|
|
99
|
+
# When the SLA sweep auto-escalated this job to p0 (UTC); omitted if never.
|
|
100
|
+
attr_accessor :sla_escalated_at
|
|
101
|
+
|
|
102
|
+
# When the sweep fired the one-shot pre-escalation warning (UTC); omitted if never.
|
|
103
|
+
attr_accessor :sla_warned_at
|
|
104
|
+
|
|
93
105
|
# Optimistic-lock version; pass back as status_version on transitions to avoid races.
|
|
94
106
|
attr_accessor :status_version
|
|
95
107
|
|
|
@@ -132,6 +144,7 @@ module Crisphive
|
|
|
132
144
|
:'archive' => :'archive',
|
|
133
145
|
:'assigned_vehicle' => :'assigned_vehicle',
|
|
134
146
|
:'assignment' => :'assignment',
|
|
147
|
+
:'attention' => :'attention',
|
|
135
148
|
:'business_id' => :'business_id',
|
|
136
149
|
:'completed_at' => :'completed_at',
|
|
137
150
|
:'completed_by_user_id' => :'completed_by_user_id',
|
|
@@ -152,6 +165,9 @@ module Crisphive
|
|
|
152
165
|
:'schedule' => :'schedule',
|
|
153
166
|
:'short_code' => :'short_code',
|
|
154
167
|
:'skills' => :'skills',
|
|
168
|
+
:'sla_deadline' => :'sla_deadline',
|
|
169
|
+
:'sla_escalated_at' => :'sla_escalated_at',
|
|
170
|
+
:'sla_warned_at' => :'sla_warned_at',
|
|
155
171
|
:'status_version' => :'status_version',
|
|
156
172
|
:'updated_at' => :'updated_at',
|
|
157
173
|
:'workflow_id' => :'workflow_id',
|
|
@@ -172,6 +188,7 @@ module Crisphive
|
|
|
172
188
|
:'archive' => :'JobRequestArchiveSummary',
|
|
173
189
|
:'assigned_vehicle' => :'JobRequestAssignedVehicle',
|
|
174
190
|
:'assignment' => :'JobRequestAssignmentSummary',
|
|
191
|
+
:'attention' => :'JobRequestAttentionSummary',
|
|
175
192
|
:'business_id' => :'String',
|
|
176
193
|
:'completed_at' => :'Time',
|
|
177
194
|
:'completed_by_user_id' => :'String',
|
|
@@ -192,6 +209,9 @@ module Crisphive
|
|
|
192
209
|
:'schedule' => :'JobRequestSchedule',
|
|
193
210
|
:'short_code' => :'String',
|
|
194
211
|
:'skills' => :'Array<JobRequestSkillSummary>',
|
|
212
|
+
:'sla_deadline' => :'Time',
|
|
213
|
+
:'sla_escalated_at' => :'Time',
|
|
214
|
+
:'sla_warned_at' => :'Time',
|
|
195
215
|
:'status_version' => :'Integer',
|
|
196
216
|
:'updated_at' => :'Time',
|
|
197
217
|
:'workflow_id' => :'String',
|
|
@@ -242,6 +262,10 @@ module Crisphive
|
|
|
242
262
|
self.assignment = attributes[:'assignment']
|
|
243
263
|
end
|
|
244
264
|
|
|
265
|
+
if attributes.key?(:'attention')
|
|
266
|
+
self.attention = attributes[:'attention']
|
|
267
|
+
end
|
|
268
|
+
|
|
245
269
|
if attributes.key?(:'business_id')
|
|
246
270
|
self.business_id = attributes[:'business_id']
|
|
247
271
|
end
|
|
@@ -328,6 +352,18 @@ module Crisphive
|
|
|
328
352
|
end
|
|
329
353
|
end
|
|
330
354
|
|
|
355
|
+
if attributes.key?(:'sla_deadline')
|
|
356
|
+
self.sla_deadline = attributes[:'sla_deadline']
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
if attributes.key?(:'sla_escalated_at')
|
|
360
|
+
self.sla_escalated_at = attributes[:'sla_escalated_at']
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
if attributes.key?(:'sla_warned_at')
|
|
364
|
+
self.sla_warned_at = attributes[:'sla_warned_at']
|
|
365
|
+
end
|
|
366
|
+
|
|
331
367
|
if attributes.key?(:'status_version')
|
|
332
368
|
self.status_version = attributes[:'status_version']
|
|
333
369
|
end
|
|
@@ -357,7 +393,7 @@ module Crisphive
|
|
|
357
393
|
# @return true if the model is valid
|
|
358
394
|
def valid?
|
|
359
395
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
360
|
-
priority_validator = EnumAttributeValidator.new('String', ["
|
|
396
|
+
priority_validator = EnumAttributeValidator.new('String', ["p0", "p1", "p2", "p3"])
|
|
361
397
|
return false unless priority_validator.valid?(@priority)
|
|
362
398
|
true
|
|
363
399
|
end
|
|
@@ -365,7 +401,7 @@ module Crisphive
|
|
|
365
401
|
# Custom attribute writer method checking allowed values (enum).
|
|
366
402
|
# @param [Object] priority Object to be assigned
|
|
367
403
|
def priority=(priority)
|
|
368
|
-
validator = EnumAttributeValidator.new('String', ["
|
|
404
|
+
validator = EnumAttributeValidator.new('String', ["p0", "p1", "p2", "p3"])
|
|
369
405
|
unless validator.valid?(priority)
|
|
370
406
|
fail ArgumentError, "invalid value for \"priority\", must be one of #{validator.allowable_values}."
|
|
371
407
|
end
|
|
@@ -382,6 +418,7 @@ module Crisphive
|
|
|
382
418
|
archive == o.archive &&
|
|
383
419
|
assigned_vehicle == o.assigned_vehicle &&
|
|
384
420
|
assignment == o.assignment &&
|
|
421
|
+
attention == o.attention &&
|
|
385
422
|
business_id == o.business_id &&
|
|
386
423
|
completed_at == o.completed_at &&
|
|
387
424
|
completed_by_user_id == o.completed_by_user_id &&
|
|
@@ -402,6 +439,9 @@ module Crisphive
|
|
|
402
439
|
schedule == o.schedule &&
|
|
403
440
|
short_code == o.short_code &&
|
|
404
441
|
skills == o.skills &&
|
|
442
|
+
sla_deadline == o.sla_deadline &&
|
|
443
|
+
sla_escalated_at == o.sla_escalated_at &&
|
|
444
|
+
sla_warned_at == o.sla_warned_at &&
|
|
405
445
|
status_version == o.status_version &&
|
|
406
446
|
updated_at == o.updated_at &&
|
|
407
447
|
workflow_id == o.workflow_id &&
|
|
@@ -417,7 +457,7 @@ module Crisphive
|
|
|
417
457
|
# Calculates hash code according to all attributes.
|
|
418
458
|
# @return [Integer] Hash code
|
|
419
459
|
def hash
|
|
420
|
-
[action_audit, address, archive, assigned_vehicle, assignment, business_id, completed_at, completed_by_user_id, created_at, crew, current_status, customer, customer_url, deleted_at, description, id, job_type_id, job_type_name, next_actions, priority, quote, rating, schedule, short_code, skills, status_version, updated_at, workflow_id, workflow_name].hash
|
|
460
|
+
[action_audit, address, archive, assigned_vehicle, assignment, attention, business_id, completed_at, completed_by_user_id, created_at, crew, current_status, customer, customer_url, deleted_at, description, id, job_type_id, job_type_name, next_actions, priority, quote, rating, schedule, short_code, skills, sla_deadline, sla_escalated_at, sla_warned_at, status_version, updated_at, workflow_id, workflow_name].hash
|
|
421
461
|
end
|
|
422
462
|
|
|
423
463
|
# Builds the object from hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -41,7 +41,7 @@ module Crisphive
|
|
|
41
41
|
# Attribute type mapping.
|
|
42
42
|
def self.openapi_types
|
|
43
43
|
{
|
|
44
|
-
:'at' => :'
|
|
44
|
+
:'at' => :'Time',
|
|
45
45
|
:'by' => :'JobRequestActionAuditBy',
|
|
46
46
|
:'payload' => :'Object'
|
|
47
47
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|
|
@@ -41,8 +41,8 @@ module Crisphive
|
|
|
41
41
|
# Attribute type mapping.
|
|
42
42
|
def self.openapi_types
|
|
43
43
|
{
|
|
44
|
-
:'_end' => :'
|
|
45
|
-
:'start' => :'
|
|
44
|
+
:'_end' => :'Time',
|
|
45
|
+
:'start' => :'Time',
|
|
46
46
|
:'window_minutes' => :'Integer'
|
|
47
47
|
}
|
|
48
48
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Crisphive Developer API
|
|
3
3
|
|
|
4
|
-
#Public REST API for integrating
|
|
4
|
+
#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> }`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0
|
|
7
7
|
|