Class: Gonebusy::ServicesController

Inherits:
BaseController show all
Defined in:
lib/gonebusy/controllers/services_controller.rb

Constant Summary collapse

@@instance = 
ServicesController.new

Instance Attribute Summary

Attributes inherited from BaseController

#http_call_back, #http_client

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from Gonebusy::BaseController

Class Method Details

.instance ⇒ Object

Singleton instance of the controller class



7
8
9
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 7

def self.instance
  @@instance
end

Instance Method Details

#create_service(authorization, create_service_body = nil) ⇒ Object

Create a Service with params.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • create_service_body (CreateServiceBody) (defaults to: nil) —

    Optional parameter: the content of the request

Returns:

  • CreateServiceResponse response from the API call



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
141
142
143
144
145
146
147
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 107

def create_service(authorization, 
                   create_service_body = nil)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services/new'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: create_service_body.to_json
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorErrorException.new 'Unprocessable Entity', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return CreateServiceResponse.from_hash(decoded)
end

#delete_service_by_id(authorization, id) ⇒ Object

Delete a Service by id

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

Returns:

  • DeleteServiceByIdResponse response from the API call



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 15

def delete_service_by_id(authorization, 
                         id)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return DeleteServiceByIdResponse.from_hash(decoded)
end

#get_service_available_slots_by_id(authorization, id, date = nil, start_date = nil, end_date = nil, resource_id = nil) ⇒ Object

Return available times for a Service.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

  • date (Date) (defaults to: nil) —

    Optional parameter: Date to check for availability. Either this field or a date range employing start_date and end_date must be supplied. If date is provided, start_date/end_date are ignored. Several formats are supported: ‘2014-10-31’, ‘October 31, 2014’.

  • start_date (Date) (defaults to: nil) —

    Optional parameter: Start Date of a range to check for availability. If supplied, date must not be supplied and end_date must be supplied. Several formats are supported: ‘2014-10-31’, ‘October 31, 2014’.

  • end_date (Date) (defaults to: nil) —

    Optional parameter: End Date of a range to check for availability. If supplied, date must not be supplied and start_date must be supplied. Several formats are supported: ‘2014-10-31’, ‘October 31, 2014’.

  • resource_id (Integer) (defaults to: nil) —

    Optional parameter: Retrieve available slots only for this Resource. You must be authorized to manage this Resource.

Returns:

  • GetServiceAvailableSlotsByIdResponse response from the API call



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 208

def get_service_available_slots_by_id(authorization, 
                                      id, 
                                      date = nil, 
                                      start_date = nil, 
                                      end_date = nil, 
                                      resource_id = nil)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services/{id}/available_slots'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'date' => date,
    'start_date' => start_date,
    'end_date' => end_date,
    'resource_id' => resource_id
  }, array_serialization: Configuration.array_serialization
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetServiceAvailableSlotsByIdResponse.from_hash(decoded)
end

#get_service_by_id(authorization, id) ⇒ Object

Return a Service by id.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

Returns:

  • GetServiceByIdResponse response from the API call



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 61

def get_service_by_id(authorization, 
                      id)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetServiceByIdResponse.from_hash(decoded)
end

#get_services(authorization, user_id = nil, page = 1, per_page = 10) ⇒ Object

Return list of Services.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • user_id (Integer) (defaults to: nil) —

    Optional parameter: Retrieve Services provided by the User specified by Id. You must be authorized to manage this User Id.

  • page (Integer) (defaults to: 1) —

    Optional parameter: Page offset to fetch.

  • per_page (Integer) (defaults to: 10) —

    Optional parameter: Number of results to return per page.

Returns:

  • GetServicesResponse response from the API call



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 266

def get_services(authorization, 
                 user_id = nil, 
                 page = 1, 
                 per_page = 10)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'user_id' => user_id,
    'page' => page,
    'per_page' => per_page
  }, array_serialization: Configuration.array_serialization
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetServicesResponse.from_hash(decoded)
end

#update_service_by_id(authorization, id, update_service_by_id_body = nil) ⇒ Object

Update a Service with params.

Parameters:

  • authorization (String) —

    Required parameter: A valid API key, in the format ‘Token API_KEY’

  • id (String) —

    Required parameter: Example:

  • update_service_by_id_body (UpdateServiceByIdBody) (defaults to: nil) —

    Optional parameter: the content of the request

Returns:

  • UpdateServiceByIdResponse response from the API call



154
155
156
157
158
159
160
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
 
# File 'lib/gonebusy/controllers/services_controller.rb', line 154

def update_service_by_id(authorization, 
                         id, 
                         update_service_by_id_body = nil)

  # prepare query url
  _query_builder = Configuration.get_base_uri()
  _query_builder << '/services/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'id' => id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8',
    'Authorization' => Configuration.authorization,
    'Authorization' => authorization
  }

  # prepare and execute HttpRequest
  _request = @http_client.put _query_url, headers: _headers, parameters: update_service_by_id_body.to_json
  CustomAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise EntitiesErrorErrorException.new 'Bad Request', _context
  elsif _context.response.status_code == 401
    raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
  elsif _context.response.status_code == 403
    raise EntitiesErrorErrorException.new 'Forbidden', _context
  elsif _context.response.status_code == 404
    raise EntitiesErrorErrorException.new 'Not Found', _context
  elsif _context.response.status_code == 422
    raise EntitiesErrorErrorException.new 'Unprocessable Entity', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise APIException.new 'Unexpected error', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return UpdateServiceByIdResponse.from_hash(decoded)
end