Class: Crisphive::BusinessSkillApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crisphive/api/business_skill_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BusinessSkillApi

Returns a new instance of BusinessSkillApi.



19
20
21
 
# File 'lib/crisphive/api/business_skill_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/crisphive/api/business_skill_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_skill_categories(opts = {}) ⇒ ListSkillCategories200Response

List skill categories Returns paginated skill categories — how the business groups technician qualifications by trade or specialty (e.g. HVAC, plumbing, electrical) — ordered alphabetically.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



28
29
30
31
 
# File 'lib/crisphive/api/business_skill_api.rb', line 28

def list_skill_categories(opts = {})
  data, _status_code, _headers = list_skill_categories_with_http_info(opts)
  data
end

#list_skill_categories_with_http_info(opts = {}) ⇒ Array<(ListSkillCategories200Response, Integer, Hash)>

List skill categories Returns paginated skill categories — how the business groups technician qualifications by trade or specialty (e.g. HVAC, plumbing, electrical) — ordered alphabetically.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/crisphive/api/business_skill_api.rb', line 39

def list_skill_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessSkillApi.list_skill_categories ...'
  end
  # resource path
  local_var_path = '/skill-categories'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSkillCategories200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"BusinessSkillApi.list_skill_categories",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessSkillApi#list_skill_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_skills(opts = {}) ⇒ ListSkills200Response

List all skills Returns the flat list of all active technician skills / qualifications for the current business — the vocabulary the dispatch engine uses for skill-based matching when assigning technicians and crews. Use it to discover the skill UUIDs accepted in skill_ids when creating a job request. (For a category-grouped view, use GET /skill-categories and GET /skill-categories/id/skills.)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/crisphive/api/business_skill_api.rb', line 89

def list_skills(opts = {})
  data, _status_code, _headers = list_skills_with_http_info(opts)
  data
end

#list_skills_by_category(id, opts = {}) ⇒ ListSkillsByCategory200Response

List skills in a category Returns paginated skills (technician qualifications/certifications) belonging to the given trade/specialty category, ordered alphabetically. The members field on each skill is the count of active technicians currently holding it — a quick capacity check per capability.

Parameters:

  • id (String) —

    Skill category ID (UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



149
150
151
152
 
# File 'lib/crisphive/api/business_skill_api.rb', line 149

def list_skills_by_category(id, opts = {})
  data, _status_code, _headers = list_skills_by_category_with_http_info(id, opts)
  data
end

#list_skills_by_category_with_http_info(id, opts = {}) ⇒ Array<(ListSkillsByCategory200Response, Integer, Hash)>

List skills in a category Returns paginated skills (technician qualifications/certifications) belonging to the given trade/specialty category, ordered alphabetically. The `members` field on each skill is the count of active technicians currently holding it — a quick capacity check per capability.

Parameters:

  • id (String) —

    Skill category ID (UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/crisphive/api/business_skill_api.rb', line 161

def list_skills_by_category_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessSkillApi.list_skills_by_category ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BusinessSkillApi.list_skills_by_category"
  end
  # resource path
  local_var_path = '/skill-categories/{id}/skills'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSkillsByCategory200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"BusinessSkillApi.list_skills_by_category",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessSkillApi#list_skills_by_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_skills_with_http_info(opts = {}) ⇒ Array<(ListSkills200Response, Integer, Hash)>

List all skills Returns the flat list of all active technician skills / qualifications for the current business — the vocabulary the dispatch engine uses for skill-based matching when assigning technicians and crews. Use it to discover the skill UUIDs accepted in `skill_ids` when creating a job request. (For a category-grouped view, use GET /skill-categories and GET /skill-categories/id/skills.)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ListSkills200Response, Integer, Hash)>) —

    ListSkills200Response data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/crisphive/api/business_skill_api.rb', line 98

def list_skills_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessSkillApi.list_skills ...'
  end
  # resource path
  local_var_path = '/skills'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSkills200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"BusinessSkillApi.list_skills",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessSkillApi#list_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_technician_skills(id, opts = {}) ⇒ ListTechnicianSkills200Response

List skills for a technician Returns paginated skills assigned to the technician. By default (eligible_only omitted or true) only active skills are returned — pass eligible_only=false to include inactive skills.

Parameters:

  • id (String) —

    Technician ID — business_user_profiles.id (UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :eligible_only (Boolean) —

    true (default) = active skills only; false = all assigned skills including inactive

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



219
220
221
222
 
# File 'lib/crisphive/api/business_skill_api.rb', line 219

def list_technician_skills(id, opts = {})
  data, _status_code, _headers = list_technician_skills_with_http_info(id, opts)
  data
end

#list_technician_skills_with_http_info(id, opts = {}) ⇒ Array<(ListTechnicianSkills200Response, Integer, Hash)>

List skills for a technician Returns paginated skills assigned to the technician. By default (`eligible_only` omitted or `true`) only active skills are returned — pass `eligible_only=false` to include inactive skills.

Parameters:

  • id (String) —

    Technician ID — business_user_profiles.id (UUID)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :eligible_only (Boolean) —

    true (default) = active skills only; false = all assigned skills including inactive

  • :page (Integer) —

    Page number (default: 1)

  • :limit (Integer) —

    Page size (default: 15, max: 1000)

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/crisphive/api/business_skill_api.rb', line 232

def list_technician_skills_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessSkillApi.list_technician_skills ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BusinessSkillApi.list_technician_skills"
  end
  # resource path
  local_var_path = '/technicians/{id}/skills'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eligible_only'] = opts[:'eligible_only'] if !opts[:'eligible_only'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListTechnicianSkills200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"BusinessSkillApi.list_technician_skills",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessSkillApi#list_technician_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_technician_skills(id, technician_skills_request, opts = {}) ⇒ ResponseEnvelope

Replace a technician's skills Sets the technician's full skill set in one call (replace semantics): skills not in the list are removed, new ones added. Pass an empty list to clear all. All skills must be active and belong to the business — on SKILL_NOT_FOUND (404) the data field contains {\"missing_ids\": [\"uuid\", ...]}; on SKILL_INACTIVE (409) it contains {\"inactive_ids\": [\"uuid\", ...]}.

Parameters:

  • id (String) —

    Technician ID — business_user_profiles.id (UUID)

  • technician_skills_request (TechnicianSkillsRequest) —

    Full list of skill_ids (business_skills.id), 0–100 UUIDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/crisphive/api/business_skill_api.rb', line 289

def replace_technician_skills(id, technician_skills_request, opts = {})
  data, _status_code, _headers = replace_technician_skills_with_http_info(id, technician_skills_request, opts)
  data
end

#replace_technician_skills_with_http_info(id, technician_skills_request, opts = {}) ⇒ Array<(ResponseEnvelope, Integer, Hash)>

Replace a technician's skills Sets the technician's full skill set in one call (replace semantics): skills not in the list are removed, new ones added. Pass an empty list to clear all. All skills must be active and belong to the business — on SKILL_NOT_FOUND (404) the `data` field contains `[\"uuid\", ...]`; on SKILL_INACTIVE (409) it contains `[\"uuid\", ...]`.

Parameters:

  • id (String) —

    Technician ID — business_user_profiles.id (UUID)

  • technician_skills_request (TechnicianSkillsRequest) —

    Full list of skill_ids (business_skills.id), 0–100 UUIDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResponseEnvelope, Integer, Hash)>) —

    ResponseEnvelope data, response status code and response headers



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/crisphive/api/business_skill_api.rb', line 300

def replace_technician_skills_with_http_info(id, technician_skills_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessSkillApi.replace_technician_skills ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BusinessSkillApi.replace_technician_skills"
  end
  # verify the required parameter 'technician_skills_request' is set
  if @api_client.config.client_side_validation && technician_skills_request.nil?
    fail ArgumentError, "Missing the required parameter 'technician_skills_request' when calling BusinessSkillApi.replace_technician_skills"
  end
  # resource path
  local_var_path = '/technicians/{id}/skills'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(technician_skills_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseEnvelope'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"BusinessSkillApi.replace_technician_skills",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessSkillApi#replace_technician_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end