square.rb 6.5.0.20201028 → 9.1.0.20210317

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89b291628ca9e34dd317c1cabd319b96d3e7861de70eb8e9b1e006f521bd9e7
-  data.tar.gz: 316cd50188c224693b87df34043991a7cea712cfdc22814d08b90268924bd85b
+  metadata.gz: 0073c43aaa6518848223c41ea272fa28f77cf58b9ade77aae705423849a37bb3
+  data.tar.gz: 6d1f79d5fd9c6224e3a1b6769faf8c1c7b93b2a98357878a42a816a522d2a0a5
 SHA512:
-  metadata.gz: 7d3b58b7592ba99f662b7e6601f9eee48535fa61a5009c159d05a21080e75b5af4f182ba7907e6350830400790fcd802531a62b5130da19392e95e6c8af9322f
-  data.tar.gz: abf4ab1de91013ea370e77fa7186a2f9436831b2611d6bc574d1c1401c6f2d99676c5984c37a5024f5bbd231799b4d4a599bdc43b00557a213f8191a7039cc65
+  metadata.gz: 6d9da7a0178efe277fcacb6ea12c73b4c03aee542edd5ce2791eeda0d97f5e8787d467f1031f260321305c060b0bb59904bab13ecf5218507d2d236c0b5ab945
+  data.tar.gz: 54f48e7dd8de672b7eadc9282e4e1dfb41e8c925a60093b450b94d2e26f7e92859f61b59c7730e65b81b1510ff9bf9affa40b28b4e8a35807e811e2a0a816802

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 Square, Inc.
+Copyright 2121 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/README.md

@@ -56,6 +56,9 @@ gem 'square.rb'
 ### Loyalty
 * [Loyalty]
 
+### Bookings
+* [Bookings]
+
 ### Business
 * [Merchants]
 * [Locations]
@@ -75,7 +78,6 @@ gem 'square.rb'
 * [O Auth]
 
 ### Deprecated APIs
-* [V1 Locations]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -194,6 +196,15 @@ client = Square::Client.new(
     environment: 'production'
 )
 ```
+
+- To set a custom environment provide a `custom_url`, and set environment to `custom`:
+
+```ruby
+client = Square::Client.new(
+    access_token:'ACCESS TOKEN HERE',
+    environment: 'custom',
+    custom_url: 'https://your.customdomain.com'
+)
  
 ### Get an Instance of an API object and call its methods
 
@@ -286,33 +297,33 @@ You can also use the Square API to create applications or services that work wit
 [Square API]: https://squareup.com/developers
 [sign up for a developer account]: https://squareup.com/signup?v=developers
 [Client]: doc/client.md
-[Devices]: doc/apis/devices.md
-[Disputes]: doc/apis/disputes.md
-[Terminal]: doc/apis/terminal.md
-[Team]: doc/apis/team.md
-[Cash Drawers]: doc/apis/cash-drawers.md
-[Customer Groups]: doc/apis/customer-groups.md
-[Customer Segments]: doc/apis/customer-segments.md
-[Bank Accounts]: doc/apis/bank-accounts
-[Payments]: doc/apis/payments.md
-[Checkout]: doc/apis/checkout.md
-[Catalog]: doc/apis/catalog.md
-[Customers]: doc/apis/customers.md
-[Employees]: doc/apis/employees.md
-[Inventory]: doc/apis/inventory.md
-[Labor]: doc/apis/labor.md
-[Loyalty]: doc/apis/loyalty.md
-[Locations]: doc/apis/locations.md
-[Merchants]: doc/apis/merchants.md
-[Orders]: doc/apis/orders.md
-[Invoices]: doc/apis/invoices.md
-[Apple Pay]: doc/apis/apple-pay.md
-[Refunds]: doc/apis/refunds.md
-[Subscriptions]: doc/apis/subscriptions.md
-[Mobile Authorization]: doc/apis/mobile-authorization.md
-[O Auth]: doc/apis/o-auth.md
-[V1 Locations]: doc/apis/v1-locations.md
-[V1 Employees]: doc/apis/v1-employees.md
-[V1 Transactions]: doc/apis/v1-transactions.md
-[V1 Items]: doc/apis/v1-items.md
-[Transactions]: doc/apis/transactions.md
+[Devices]: doc/api/devices.md
+[Disputes]: doc/api/disputes.md
+[Terminal]: doc/api/terminal.md
+[Team]: doc/api/team.md
+[Cash Drawers]: doc/api/cash-drawers.md
+[Customer Groups]: doc/api/customer-groups.md
+[Customer Segments]: doc/api/customer-segments.md
+[Bank Accounts]: doc/api/bank-accounts.md
+[Payments]: doc/api/payments.md
+[Checkout]: doc/api/checkout.md
+[Catalog]: doc/api/catalog.md
+[Customers]: doc/api/customers.md
+[Employees]: doc/api/employees.md
+[Inventory]: doc/api/inventory.md
+[Labor]: doc/api/labor.md
+[Loyalty]: doc/api/loyalty.md
+[Bookings]: doc/api/bookings.md
+[Locations]: doc/api/locations.md
+[Merchants]: doc/api/merchants.md
+[Orders]: doc/api/orders.md
+[Invoices]: doc/api/invoices.md
+[Apple Pay]: doc/api/apple-pay.md
+[Refunds]: doc/api/refunds.md
+[Subscriptions]: doc/api/subscriptions.md
+[Mobile Authorization]: doc/api/mobile-authorization.md
+[O Auth]: doc/api/o-auth.md
+[V1 Employees]: doc/api/v1-employees.md
+[V1 Transactions]: doc/api/v1-transactions.md
+[V1 Items]: doc/api/v1-items.md
+[Transactions]: doc/api/transactions.md

data/lib/square.rb

@@ -31,12 +31,11 @@ require_relative 'square/configuration.rb'
 require_relative 'square/api/base_api.rb'
 require_relative 'square/api/mobile_authorization_api.rb'
 require_relative 'square/api/o_auth_api.rb'
-require_relative 'square/api/v1_locations_api.rb'
 require_relative 'square/api/v1_employees_api.rb'
 require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/v1_items_api.rb'
 require_relative 'square/api/apple_pay_api.rb'
 require_relative 'square/api/bank_accounts_api.rb'
+require_relative 'square/api/bookings_api.rb'
 require_relative 'square/api/cash_drawers_api.rb'
 require_relative 'square/api/catalog_api.rb'
 require_relative 'square/api/customers_api.rb'

data/lib/square/api/apple_pay_api.rb

@@ -5,17 +5,18 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Activates a domain for use with Web Apple Pay and Square. A validation
-    # will be performed on this domain by Apple to ensure is it properly set up
+    # Activates a domain for use with Apple Pay on the Web and Square. A
+    # validation
+    # is performed on this domain by Apple to ensure that it is properly set up
     # as
     # an Apple Pay enabled domain.
     # This endpoint provides an easy way for platform developers to bulk
     # activate
-    # Web Apple Pay with Square for merchants using their platform.
-    # To learn more about Apple Pay on Web see the Apple Pay section in the
-    # [Square Payment Form
-    # Walkthrough](https://developer.squareup.com/docs/docs/payment-form/payment
-    # -form-walkthrough).
+    # Apple Pay on the Web with Square for merchants using their platform.
+    # To learn more about Web Apple Pay, see
+    # [Add the Apple Pay on the Web
+    # Button](https://developer.squareup.com/docs/payment-form/add-digital-walle
+    # ts/apple-pay).
     # @param [RegisterDomainRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/bank_accounts_api.rb

@@ -10,8 +10,8 @@ module Square
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
     # request to retrieve the next set  of results.  See the
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination) guide for more information.
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion) guide for more information.
     # @param [Integer] limit Optional parameter: Upper limit on the number of
     # bank accounts to return in the response.  Currently, 1000 is the largest
     # supported limit. You can specify a limit  of up to 1000 bank accounts.
@@ -60,8 +60,8 @@ module Square
     # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
     # the desired `BankAccount`. For more information, see  [Retrieve a bank
     # account by using an ID issued by V1 Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
-    # -bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
+    # API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank
+    # -account-by-using-an-id-issued-by-v1-bank-accounts-api).
     # @return [GetBankAccountByV1IdResponse Hash] response from the API call
     def get_bank_account_by_v1_id(v1_bank_account_id:)
       # Prepare query url.

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/6.5.0.20201028',
+        'user-agent' => 'Square-Ruby-SDK/9.1.0.20210317',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/bookings_api.rb

@@ -0,0 +1,308 @@
+module Square
+  # BookingsApi
+  class BookingsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a booking.
+    # @param [CreateBookingRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateBookingResponse Hash] response from the API call
+    def create_booking(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # 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
+
+    # Searches for availabilities for booking.
+    # @param [SearchAvailabilityRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchAvailabilityResponse Hash] response from the API call
+    def search_availability(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/availability/search'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # 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 a seller's booking profile.
+    # @return [RetrieveBusinessBookingProfileResponse Hash] response from the API call
+    def retrieve_business_booking_profile
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/business-booking-profile'
+      _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
+
+    # 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 [Integer] limit Optional parameter: The maximum number of results
+    # to return.
+    # @param [String] cursor Optional parameter: The cursor for paginating
+    # through the results.
+    # @param [String] location_id Optional parameter: Indicates whether to
+    # include only team members enabled at the given location in the returned
+    # result.
+    # @return [ListTeamMemberBookingProfilesResponse Hash] response from the API call
+    def list_team_member_booking_profiles(bookable_only: false,
+                                          limit: nil,
+                                          cursor: nil,
+                                          location_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/team-member-booking-profiles'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'bookable_only' => bookable_only,
+        'limit' => limit,
+        'cursor' => cursor,
+        'location_id' => location_id
+      )
+      _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
+
+    # Retrieves a team member's booking profile.
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to retrieve.
+    # @return [RetrieveTeamMemberBookingProfileResponse Hash] response from the API call
+    def retrieve_team_member_booking_profile(team_member_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/team-member-booking-profiles/{team_member_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => { 'value' => team_member_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
+
+    # Retrieves a booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-booking) object representing the to-be-retrieved
+    # booking.
+    # @return [RetrieveBookingResponse Hash] response from the API call
+    def retrieve_booking(booking_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_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
+
+    # Updates a booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-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.
+    # @return [UpdateBookingResponse Hash] response from the API call
+    def update_booking(booking_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _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
+
+    # Cancels an existing booking.
+    # @param [String] booking_id Required parameter: The ID of the
+    # [Booking](#type-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.
+    # @return [CancelBookingResponse Hash] response from the API call
+    def cancel_booking(booking_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # 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
+  end
+end