gonebusy-ruby-client 0.0.2

data/lib/gonebusy/controllers/services_controller.rb

@@ -0,0 +1,367 @@
+# This file was automatically generated for GoneBusy Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Gonebusy
+  class ServicesController < BaseController
+    @@instance = ServicesController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Delete a Service by id
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return DeleteServiceByIdResponse response from the API call
+    def delete_service_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return DeleteServiceByIdResponse.from_hash(decoded)
+    end
+
+    # Update a Service with params.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @param [UpdateServiceByIdBody] update_service_by_id_body Required parameter: the content of the request
+    # @return UpdateServiceByIdResponse response from the API call
+    def update_service_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.put _query_url, headers: _headers, parameters: options['update_service_by_id_body'].to_json
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return UpdateServiceByIdResponse.from_hash(decoded)
+    end
+
+    # Return a Service by id.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return GetServiceByIdResponse response from the API call
+    def get_service_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetServiceByIdResponse.from_hash(decoded)
+    end
+
+    # Create a Service with params.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [CreateServiceBody] create_service_body Required parameter: the content of the request
+    # @return CreateServiceResponse response from the API call
+    def create_service(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services/new'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: options['create_service_body'].to_json
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return CreateServiceResponse.from_hash(decoded)
+    end
+
+    # Return list of Services.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [Integer] page Optional parameter: Page offset to fetch.
+    # @param [Integer] per_page Optional parameter: Number of results to return per page.
+    # @param [Integer] user_id Optional parameter: Retrieve Services provided by the User specified by Id.  You must be authorized to manage this User Id.
+    # @return GetServicesResponse response from the API call
+    def get_services(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'page' => options['page'],
+        'per_page' => options['per_page'],
+        'user_id' => options['user_id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetServicesResponse.from_hash(decoded)
+    end
+
+    # Return available times for a Service.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @param [DateTime] date 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'.
+    # @param [DateTime] end_date 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'.
+    # @param [DateTime] start_date 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'.
+    # @return GetServiceAvailableSlotsByIdResponse response from the API call
+    def get_service_available_slots_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/services/{id}/available_slots'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'date' => options['date'],
+        'end_date' => options['end_date'],
+        'start_date' => options['start_date']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetServiceAvailableSlotsByIdResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/gonebusy/controllers/users_controller.rb

@@ -0,0 +1,288 @@
+# This file was automatically generated for GoneBusy Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Gonebusy
+  class UsersController < BaseController
+    @@instance = UsersController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Update a User by id, with params.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @param [UpdateUserByIdBody] update_user_by_id_body Required parameter: the content of the request
+    # @return UpdateUserByIdResponse response from the API call
+    def update_user_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.put _query_url, headers: _headers, parameters: options['update_user_by_id_body'].to_json
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return UpdateUserByIdResponse.from_hash(decoded)
+    end
+
+    # Return a User by id.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [String] id Required parameter: Example: 
+    # @return GetUserByIdResponse response from the API call
+    def get_user_by_id(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users/{id}'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => options['id']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 404
+        raise EntitiesErrorException.new '404 - Not Found', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetUserByIdResponse.from_hash(decoded)
+    end
+
+    # Return list of active Pro Users.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @return GetUsersProsResponse response from the API call
+    def get_users_pros(authorization)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users/pros'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => authorization
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetUsersProsResponse.from_hash(decoded)
+    end
+
+    # Create a User
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [CreateUserBody] create_user_body Required parameter: the content of the request
+    # @return CreateUserResponse response from the API call
+    def create_user(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users/new'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: options['create_user_body'].to_json
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 422
+        raise EntitiesErrorException.new '422 - Unprocessable Entity', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return CreateUserResponse.from_hash(decoded)
+    end
+
+    # Return all Users that your account has access to.  Includes your own User as well as any Users for which you are the Account Manager.
+    # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [Integer] page Optional parameter: Page offset to fetch.
+    # @param [Integer] per_page Optional parameter: Number of results to return per page.
+    # @return GetUsersResponse response from the API call
+    def get_users(options = Hash.new)
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/users'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'page' => options['page'],
+        'per_page' => options['per_page']
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => Configuration.authorization,
+        'Authorization' => options['authorization']
+      }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
+
+      # apply authentication
+      CustomAuth.apply(_request)
+
+      # execute the request
+      _context = execute_request(_request)
+
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
+        raise EntitiesErrorException.new '400 - Bad Request', _context
+      elsif _context.response.status_code == 401
+        raise EntitiesErrorException.new '401 - Unauthorized/Missing Token', _context
+      elsif _context.response.status_code == 403
+        raise EntitiesErrorException.new '403 - Forbidden', _context
+      elsif _context.response.status_code == 500
+        raise APIException.new '500 - Unexpected error', _context
+      end
+
+      # global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return GetUsersResponse.from_hash(decoded)
+    end
+  end
+end