square.rb 8.0.0.20201216 → 26.1.0.20230119

data/lib/square/api/bookings_api.rb

@@ -5,7 +5,78 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Retrieve a collection of bookings.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # per page to return in a paged response.
+    # @param [String] cursor Optional parameter: The pagination cursor from the
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
+    # @param [String] team_member_id Optional parameter: The team member for
+    # whom to retrieve bookings. If this is not set, bookings of all members are
+    # retrieved.
+    # @param [String] location_id Optional parameter: The location for which to
+    # retrieve bookings. If this is not set, all locations' bookings are
+    # retrieved.
+    # @param [String] start_at_min Optional parameter: The RFC 3339 timestamp
+    # specifying the earliest of the start time. If this is not set, the current
+    # time is used.
+    # @param [String] start_at_max Optional parameter: The RFC 3339 timestamp
+    # specifying the latest of the start time. If this is not set, the time of
+    # 31 days after `start_at_min` is used.
+    # @return [ListBookingsResponse Hash] response from the API call
+    def list_bookings(limit: nil,
+                      cursor: nil,
+                      team_member_id: nil,
+                      location_id: nil,
+                      start_at_min: nil,
+                      start_at_max: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor,
+        'team_member_id' => team_member_id,
+        'location_id' => location_id,
+        'start_at_min' => start_at_min,
+        'start_at_max' => start_at_max
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
     # Creates a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [CreateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -19,7 +90,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -40,6 +111,10 @@ module Square
     end
 
     # Searches for availabilities for booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [SearchAvailabilityRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -53,7 +128,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -103,13 +178,14 @@ module Square
     end
 
     # Lists booking profiles for team members.
-    # @param [Boolean] bookable_only Optional parameter: Indicates whether to
-    # include only bookable team members in the returned result (`true`) or not
-    # (`false`).
+    # @param [TrueClass|FalseClass] bookable_only Optional parameter: Indicates
+    # whether to include only bookable team members in the returned result
+    # (`true`) or not (`false`).
     # @param [Integer] limit Optional parameter: The maximum number of results
-    # to return.
-    # @param [String] cursor Optional parameter: The cursor for paginating
-    # through the results.
+    # to return in a paged response.
+    # @param [String] cursor Optional parameter: The pagination cursor from the
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
     # @param [String] location_id Optional parameter: Indicates whether to
     # include only team members enabled at the given location in the returned
     # result.
@@ -187,9 +263,12 @@ module Square
     end
 
     # Retrieves a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-retrieved
-    # booking.
+    # [Booking]($m/Booking) object representing the to-be-retrieved booking.
     # @return [RetrieveBookingResponse Hash] response from the API call
     def retrieve_booking(booking_id:)
       # Prepare query url.
@@ -223,8 +302,15 @@ module Square
     end
 
     # Updates a booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-updated booking.
+    # [Booking]($m/Booking) object representing the to-be-updated booking.
     # @param [UpdateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -243,7 +329,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -264,9 +350,15 @@ module Square
     end
 
     # Cancels an existing booking.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
     # @param [String] booking_id Required parameter: The ID of the
-    # [Booking](#type-booking) object representing the to-be-cancelled
-    # booking.
+    # [Booking]($m/Booking) object representing the to-be-cancelled booking.
     # @param [CancelBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -285,7 +377,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/cards_api.rb

@@ -0,0 +1,171 @@
+module Square
+  # CardsApi
+  class CardsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Retrieves a list of cards owned by the account making the request.
+    # A max of 25 cards will be returned.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint. Provide this to retrieve the next set of
+    # results for your original query.  See
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # for more information.
+    # @param [String] customer_id Optional parameter: Limit results to cards
+    # associated with the customer supplied. By default, all cards owned by the
+    # merchant are returned.
+    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # Includes disabled cards. By default, all enabled cards owned by the
+    # merchant are returned.
+    # @param [String] reference_id Optional parameter: Limit results to cards
+    # associated with the reference_id supplied.
+    # @param [SortOrder] sort_order Optional parameter: Sorts the returned list
+    # by when the card was created with the specified order. This field defaults
+    # to ASC.
+    # @return [ListCardsResponse Hash] response from the API call
+    def list_cards(cursor: nil,
+                   customer_id: nil,
+                   include_disabled: false,
+                   reference_id: nil,
+                   sort_order: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'customer_id' => customer_id,
+        'include_disabled' => include_disabled,
+        'reference_id' => reference_id,
+        'sort_order' => sort_order
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Adds a card on file to an existing merchant.
+    # @param [CreateCardRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateCardResponse Hash] response from the API call
+    def create_card(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves details for a specific Card.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [RetrieveCardResponse Hash] response from the API call
+    def retrieve_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Disables the card, preventing any further updates or charges.
+    # Disabling an already disabled card is allowed but has no effect.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [DisableCardResponse Hash] response from the API call
+    def disable_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}/disable'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+  end
+end

data/lib/square/api/cash_drawers_api.rb

@@ -63,8 +63,8 @@ module Square
     end
 
     # Provides the summary details for a single cash drawer shift. See
-    # [ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvent
-    # s) for a list of cash drawer shift events.
+    # [ListCashDrawerShiftEvents]($e/CashDrawers/ListCashDrawerShiftEvents) for
+    # a list of cash drawer shift events.
     # @param [String] location_id Required parameter: The ID of the location to
     # retrieve cash drawer shifts from.
     # @param [String] shift_id Required parameter: The shift ID.