gonebusy-ruby-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b8512a26ebf173b7d5dff019ada61c11f3e537
-  data.tar.gz: ae3379eb6e60d839b67cf3c9e7e84a2797f9b086
+  metadata.gz: c62797dc25aa9288b06855875b09ed9a9f4ad612
+  data.tar.gz: 67900e0d872101c9dca554659bc939d1d7639928
 SHA512:
-  metadata.gz: b95d3c6c28de64dd0ebe9b514abf93a5f205ab93421b99c507ec5bd2b8e03b57064a4891085f1d6b3cf5a88ed79f7af0792055b21ff33fc573eb9a5fbf532dcf
-  data.tar.gz: 2d18a850c595ac5593a207ffc100d7bc23beb2f39ac39678a654ddbf833b12e2bb39d842ca36f5a087fefd194376156d56d1abcaeb7a26960ce8060733602669
+  metadata.gz: 30828290bb4650af1c282ccac9b978ea4a72db5586e15020546d3986371b6b0777d6956ed1748450e96f178721c50679c9767c56554e1e1c1119f2f04a27fad3
+  data.tar.gz: c34051538ef315e41336239b538ccc66418c68d47193b1cdc288bc7b99e913cab704533b862f4e295adb65c825158bc567c3adcf66bf0f9472e1a5bb533e9835

data/LICENSE

@@ -3,7 +3,7 @@
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2016 - GoneBusy Inc.
+Copyright (c) 2016-2017 - GoneBusy Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -139,7 +139,8 @@ def get_bookings(options = Hash.new); end
 | page |  ``` Optional ```  ``` DefaultValue ```  | Page offset to fetch. |
 | per_page |  ``` Optional ```  ``` DefaultValue ```  | Number of results to return per page. |
 | states |  ``` Optional ```  | Comma-separated list of Booking states to retrieve only Bookings in those states.  Leave blank to retrieve all Bookings. |
-| user_id |  ``` Optional ```  | Retrieve Bookings owned only by this User Id.  You must be authorized to manage this User Id. |
+| user_id |  ``` Optional ```  | Retrieve Bookings for Resources/Services owned by this User Id.  You must be authorized to manage this User Id. |
+| booker_id |  ``` Optional ```  | Retrieve Bookings make by Booker Id. |
 
 
 #### Example Usage

data/lib/gonebusy/controllers/bookings_controller.rb

@@ -8,27 +8,29 @@ module Gonebusy
       @@instance
     end
 
-    # Return list of Bookings.
+    # Cancel a Booking by id
     # @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 [String] states Optional parameter: Comma-separated list of Booking states to retrieve only Bookings in those states.  Leave blank to retrieve all Bookings.
-    # @param [Integer] user_id Optional parameter: Retrieve Bookings owned only by this User Id.  You must be authorized to manage this User Id.
-    # @return GetBookingsResponse response from the API call
-    def get_bookings(authorization, 
-                     page = 1, 
-                     per_page = 10, 
-                     states = nil, 
-                     user_id = nil)
+    # @param [String] id Required parameter: Example: 
+    # @param [Date] date Optional parameter: If a recurring booking, the date of an instance to cancel.  Several formats are supported: '2014-10-31', 'October 31, 2014'
+    # @param [Date] end_date Optional parameter: If recurring, cancel up to :end_date or leave blank for infinite booking.  Several formats are supported: '2014-10-31', 'October 31, 2014'.
+    # @param [String] cancel_recurring Optional parameter: When a recurring booking, one of: ['instance', 'all', 'infinite']
+    # @return CancelBookingByIdResponse response from the API call
+    def cancel_booking_by_id(authorization, 
+                             id, 
+                             date = nil, 
+                             end_date = nil, 
+                             cancel_recurring = nil)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
-      _query_builder << '/bookings'
+      _query_builder << '/bookings/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        'id' => id
+      }
       _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
-        'page' => page,
-        'per_page' => per_page,
-        'states' => states,
-        'user_id' => user_id
+        'date' => date,
+        'end_date' => end_date,
+        'cancel_recurring' => cancel_recurring
       }, array_serialization: Configuration.array_serialization
       _query_url = APIHelper.clean_url _query_builder
 
@@ -40,12 +42,14 @@ module Gonebusy
       }
 
       # prepare and execute HttpRequest
-      _request = @http_client.get _query_url, headers: _headers
+      _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 == 401
+      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
@@ -58,43 +62,55 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetBookingsResponse.from_hash(decoded)
+      return CancelBookingByIdResponse.from_hash(decoded)
     end
 
-    # Create a Booking with params
+    # Return list of Bookings.
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
-    # @param [CreateBookingBody] create_booking_body Optional parameter: the content of the request
-    # @return CreateBookingResponse response from the API call
-    def create_booking(authorization, 
-                       create_booking_body = nil)
+    # @param [Integer] user_id Optional parameter: Retrieve Bookings for Resources/Services owned by this User Id.  You must be authorized to manage this User Id.
+    # @param [String] states Optional parameter: Comma-separated list of Booking states to retrieve only Bookings in those states.  Leave blank to retrieve all Bookings.
+    # @param [Integer] booker_id Optional parameter: Retrieve Bookings made by Booker Id.  Only Bookings for Services/Resources you are authorized to manage will be returned.
+    # @param [Integer] page Optional parameter: Page offset to fetch.
+    # @param [Integer] per_page Optional parameter: Number of results to return per page.
+    # @return GetBookingsResponse response from the API call
+    def get_bookings(authorization, 
+                     user_id = nil, 
+                     states = nil, 
+                     booker_id = nil, 
+                     page = 1, 
+                     per_page = 10)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
-      _query_builder << '/bookings/new'
+      _query_builder << '/bookings'
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'user_id' => user_id,
+        'states' => states,
+        'booker_id' => booker_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',
-        '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_booking_body.to_json
+      _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
+      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 == 422
-        raise EntitiesErrorErrorException.new 'Unprocessable Entity', _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
@@ -102,15 +118,17 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return CreateBookingResponse.from_hash(decoded)
+      return GetBookingsResponse.from_hash(decoded)
     end
 
-    # Return a Booking by id.
+    # Update a Booking by id
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
     # @param [String] id Required parameter: Example: 
-    # @return GetBookingByIdResponse response from the API call
-    def get_booking_by_id(authorization, 
-                          id)
+    # @param [UpdateBookingByIdBody] update_booking_by_id_body Optional parameter: the content of the request
+    # @return UpdateBookingByIdResponse response from the API call
+    def update_booking_by_id(authorization, 
+                             id, 
+                             update_booking_by_id_body = nil)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
@@ -123,12 +141,13 @@ module Gonebusy
       # 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.get _query_url, headers: _headers
+      _request = @http_client.put _query_url, headers: _headers, parameters: update_booking_by_id_body.to_json
       CustomAuth.apply(_request)
       _context = execute_request(_request)
 
@@ -141,6 +160,8 @@ module Gonebusy
         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
@@ -148,17 +169,15 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetBookingByIdResponse.from_hash(decoded)
+      return UpdateBookingByIdResponse.from_hash(decoded)
     end
 
-    # Update a Booking by id
+    # Return a Booking by id.
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
     # @param [String] id Required parameter: Example: 
-    # @param [UpdateBookingByIdBody] update_booking_by_id_body Optional parameter: the content of the request
-    # @return UpdateBookingByIdResponse response from the API call
-    def update_booking_by_id(authorization, 
-                             id, 
-                             update_booking_by_id_body = nil)
+    # @return GetBookingByIdResponse response from the API call
+    def get_booking_by_id(authorization, 
+                          id)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
@@ -171,13 +190,12 @@ module Gonebusy
       # 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_booking_by_id_body.to_json
+      _request = @http_client.get _query_url, headers: _headers
       CustomAuth.apply(_request)
       _context = execute_request(_request)
 
@@ -190,8 +208,6 @@ module Gonebusy
         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
@@ -199,44 +215,31 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return UpdateBookingByIdResponse.from_hash(decoded)
+      return GetBookingByIdResponse.from_hash(decoded)
     end
 
-    # Cancel a Booking by id
+    # Create a Booking with params
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
-    # @param [String] id Required parameter: Example: 
-    # @param [String] cancel_recurring Optional parameter: When a recurring booking, one of: ['instance', 'all', 'infinite']
-    # @param [Date] date Optional parameter: If a recurring booking, the date of an instance to cancel.  Several formats are supported: '2014-10-31', 'October 31, 2014'
-    # @param [Date] end_date Optional parameter: If recurring, cancel up to :end_date or leave blank for infinite booking.  Several formats are supported: '2014-10-31', 'October 31, 2014'.
-    # @return CancelBookingByIdResponse response from the API call
-    def cancel_booking_by_id(authorization, 
-                             id, 
-                             cancel_recurring = nil, 
-                             date = nil, 
-                             end_date = nil)
+    # @param [CreateBookingBody] create_booking_body Optional parameter: the content of the request
+    # @return CreateBookingResponse response from the API call
+    def create_booking(authorization, 
+                       create_booking_body = nil)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
-      _query_builder << '/bookings/{id}'
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
-        'id' => id
-      }
-      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
-        'cancel_recurring' => cancel_recurring,
-        'date' => date,
-        'end_date' => end_date
-      }, array_serialization: Configuration.array_serialization
+      _query_builder << '/bookings/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.delete _query_url, headers: _headers
+      _request = @http_client.post _query_url, headers: _headers, parameters: create_booking_body.to_json
       CustomAuth.apply(_request)
       _context = execute_request(_request)
 
@@ -247,8 +250,8 @@ module Gonebusy
         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
@@ -256,7 +259,7 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return CancelBookingByIdResponse.from_hash(decoded)
+      return CreateBookingResponse.from_hash(decoded)
     end
   end
 end

data/lib/gonebusy/controllers/categories_controller.rb

@@ -10,22 +10,22 @@ module Gonebusy
 
     # Return list of Categories.
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
+    # @param [Integer] user_id Optional parameter: Retrieve Categories of all services provided by this User Id.  You must be authorized to manage this User Id.
     # @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 Categories of all services provided by this User Id.  You must be authorized to manage this User Id.
     # @return GetCategoriesResponse response from the API call
     def get_categories(authorization, 
+                       user_id = nil, 
                        page = 1, 
-                       per_page = 10, 
-                       user_id = nil)
+                       per_page = 10)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
       _query_builder << '/categories'
       _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'user_id' => user_id,
         'page' => page,
-        'per_page' => per_page,
-        'user_id' => user_id
+        'per_page' => per_page
       }, array_serialization: Configuration.array_serialization
       _query_url = APIHelper.clean_url _query_builder
 
@@ -58,28 +58,30 @@ module Gonebusy
       return GetCategoriesResponse.from_hash(decoded)
     end
 
-    # Create a Category
+    # Return a Category by id.
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
-    # @param [CreateCategoryBody] create_category_body Optional parameter: the content of the request
-    # @return CreateCategoryResponse response from the API call
-    def create_category(authorization, 
-                        create_category_body = nil)
+    # @param [String] id Required parameter: Example: 
+    # @return GetCategoryByIdResponse response from the API call
+    def get_category_by_id(authorization, 
+                           id)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
-      _query_builder << '/categories/new'
+      _query_builder << '/categories/{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.post _query_url, headers: _headers, parameters: create_category_body.to_json
+      _request = @http_client.get _query_url, headers: _headers
       CustomAuth.apply(_request)
       _context = execute_request(_request)
 
@@ -90,8 +92,8 @@ module Gonebusy
         raise EntitiesErrorErrorException.new 'Unauthorized/Missing Token', _context
       elsif _context.response.status_code == 403
         raise EntitiesErrorErrorException.new 'Forbidden', _context
-      elsif _context.response.status_code == 422
-        raise EntitiesErrorErrorException.new 'Unprocessable Entity', _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
@@ -99,33 +101,31 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return CreateCategoryResponse.from_hash(decoded)
+      return GetCategoryByIdResponse.from_hash(decoded)
     end
 
-    # Return a Category by id.
+    # Create a Category
     # @param [String] authorization Required parameter: A valid API key, in the format 'Token API_KEY'
-    # @param [String] id Required parameter: Example: 
-    # @return GetCategoryByIdResponse response from the API call
-    def get_category_by_id(authorization, 
-                           id)
+    # @param [CreateCategoryBody] create_category_body Optional parameter: the content of the request
+    # @return CreateCategoryResponse response from the API call
+    def create_category(authorization, 
+                        create_category_body = nil)
 
       # prepare query url
       _query_builder = Configuration.get_base_uri()
-      _query_builder << '/categories/{id}'
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
-        'id' => id
-      }
+      _query_builder << '/categories/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.get _query_url, headers: _headers
+      _request = @http_client.post _query_url, headers: _headers, parameters: create_category_body.to_json
       CustomAuth.apply(_request)
       _context = execute_request(_request)
 
@@ -136,8 +136,8 @@ module Gonebusy
         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
@@ -145,7 +145,7 @@ module Gonebusy
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetCategoryByIdResponse.from_hash(decoded)
+      return CreateCategoryResponse.from_hash(decoded)
     end
   end
 end