square.rb 5.3.0.20200528 → 6.0.0.20200625

data/lib/square.rb

@@ -56,4 +56,5 @@ require_relative 'square/api/loyalty_api.rb'
 require_relative 'square/api/merchants_api.rb'
 require_relative 'square/api/payments_api.rb'
 require_relative 'square/api/refunds_api.rb'
+require_relative 'square/api/team_api.rb'
 require_relative 'square/api/terminal_api.rb'

data/lib/square/api/base_api.rb

@@ -8,8 +8,8 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/5.3.0.20200528',
-        'Square-Version' => '2020-05-28'
+        'user-agent' => 'Square-Ruby-SDK/6.0.0.20200625',
+        'Square-Version' => '2020-06-25'
       }
     end
 

data/lib/square/api/catalog_api.rb

@@ -139,34 +139,7 @@ module Square
     # [CatalogObject](#type-catalogobject) at a later time.
     # CreateCatalogImage accepts HTTP multipart/form-data requests with a JSON
     # part and an image file part in
-    # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. The
-    # following is an example of such an HTTP request:
-    # ```
-    # POST /v2/catalog/images
-    # Accept: application/json
-    # Content-Type: multipart/form-data;boundary="boundary"
-    # Square-Version: XXXX-XX-XX
-    # Authorization: Bearer {ACCESS_TOKEN}
-    # --boundary
-    # Content-Disposition: form-data; name="request"
-    # Content-Type: application/json
-    # {
-    # "idempotency_key":"528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
-    # "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
-    # "image":{
-    # "id":"#TEMP_ID",
-    # "type":"IMAGE",
-    # "image_data":{
-    # "caption":"A picture of a cup of coffee"
-    # }
-    # }
-    # }
-    # --boundary
-    # Content-Disposition: form-data; name="image"; filename="Coffee.jpg"
-    # Content-Type: image/jpeg
-    # {ACTUAL_IMAGE_BYTES}
-    # --boundary
-    # ```
+    # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
     # Additional information and an example cURL request can be found in the
     # [Create a Catalog Image
     # recipe](https://developer.squareup.com/docs/more-apis/catalog/cookbook/cre
@@ -400,7 +373,7 @@ module Square
     # `false`
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
-                                include_related_objects: nil)
+                                include_related_objects: false)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/catalog/object/{object_id}'
@@ -433,22 +406,20 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Queries the targeted catalog using a variety of query types:
-    # [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),
-    # [CatalogQueryExact](#type-catalogqueryexact),
-    # [CatalogQueryRange](#type-catalogqueryrange),
-    # [CatalogQueryText](#type-catalogquerytext),
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and
-    # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
-    # .
-    # --
-    # --
-    # Future end of the above comment:
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),
+    # Queries the targeted catalog using a variety of query expressions.
+    # Supported query expressions are of the following types:
+    # - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute),
+    # - [CatalogQueryExact](#type-catalogqueryexact),
+    # - [CatalogQueryRange](#type-catalogqueryrange),
+    # - [CatalogQueryText](#type-catalogquerytext),
+    # - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),
+    # -
     # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
     # ,
+    # -
     # [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions),
     # and
+    # -
     # [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvari
     # ationsforitemoptionvalues).
     # @param [SearchCatalogObjectsRequest] body Required parameter: An object

data/lib/square/api/disputes_api.rb

@@ -244,17 +244,7 @@ module Square
     # Uploads a file to use as evidence in a dispute challenge. The endpoint
     # accepts
     # HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
-    # and TIFF formats. The following is an example of such an HTTP request:
-    # ```
-    # curl -X POST \
-    # -H 'Accept: application/json' \
-    # -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
-    # -H 'Content-Type: multipart/form-data' \
-    # -F 'evidence=@/path/to/file/filename.tiff' \
-    # -F 'request={ "idempotency_key":"{{UNIQUE_KEY}}",
-    # "evidence_type":"{{EVIDENCE_TYPE}}", "content_type":"image/tiff" }' \
-    # 'https://connect.squareup.com/v2/disputes/{{DISPUTE_ID}}/evidence_file'
-    # ```
+    # and TIFF formats.
     # For more information, see [Challenge a
     # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
     # putes#challenge-a-dispute).

data/lib/square/api/payments_api.rb

@@ -246,12 +246,8 @@ module Square
     # elayed-payments).
     # @param [String] payment_id Required parameter: Unique ID identifying the
     # payment to be completed.
-    # @param [Object] body Required parameter: An object containing the fields
-    # to POST for the request.  See the corresponding object definition for
-    # field details.
     # @return [CompletePaymentResponse Hash] response from the API call
-    def complete_payment(payment_id:,
-                         body:)
+    def complete_payment(payment_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/payments/{payment_id}/complete'
@@ -263,15 +259,13 @@ module Square
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'accept' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
       _request = config.http_client.post(
         _query_url,
-        headers: _headers,
-        parameters: body.to_json
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)

data/lib/square/api/refunds_api.rb

@@ -21,8 +21,9 @@ module Square
     # results for the original query.  See
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
-    # @param [String] location_id Optional parameter: ID of location associated
-    # with payment.
+    # @param [String] location_id Optional parameter: Limit results to the
+    # location supplied. By default, results are returned for all locations
+    # associated with the merchant.
     # @param [String] status Optional parameter: If provided, only refunds with
     # the given status are returned. For a list of refund status values, see
     # [PaymentRefund](#type-paymentrefund).  Default: If omitted refunds are

data/lib/square/api/team_api.rb

@@ -0,0 +1,326 @@
+module Square
+  # TeamApi
+  class TeamApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a single `TeamMember` object. The `TeamMember` will be returned on
+    # successful creates.
+    # You must provide the following values in your request to this endpoint:
+    # - `first_name`
+    # - `last_name`
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#createt
+    # eammember).
+    # @param [CreateTeamMemberRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateTeamMemberResponse Hash] response from the API call
+    def create_team_member(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members'
+      _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
+
+    # Creates multiple `TeamMember` objects. The created `TeamMember` objects
+    # will be returned on successful creates.
+    # This process is non-transactional and will process as much of the request
+    # as is possible. If one of the creates in
+    # the request cannot be successfully processed, the request will NOT be
+    # marked as failed, but the body of the response
+    # will contain explicit error information for this particular create.
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#bulkcre
+    # ateteammembers).
+    # @param [BulkCreateTeamMembersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkCreateTeamMembersResponse Hash] response from the API call
+    def bulk_create_team_members(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/bulk-create'
+      _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
+
+    # Updates multiple `TeamMember` objects. The updated `TeamMember` objects
+    # will be returned on successful updates.
+    # This process is non-transactional and will process as much of the request
+    # as is possible. If one of the updates in
+    # the request cannot be successfully processed, the request will NOT be
+    # marked as failed, but the body of the response
+    # will contain explicit error information for this particular update.
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#bulkupd
+    # ateteammembers).
+    # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkUpdateTeamMembersResponse Hash] response from the API call
+    def bulk_update_team_members(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/bulk-update'
+      _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
+
+    # Returns a paginated list of `TeamMember` objects for a business.
+    # The list to be returned can be filtered by:
+    # - location IDs **and**
+    # - `is_active`
+    # @param [SearchTeamMembersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchTeamMembersResponse Hash] response from the API call
+    def search_team_members(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/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
+
+    # Retrieve a `TeamMember` object for the given `TeamMember.id`
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#retriev
+    # eteammember).
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to retrieve.
+    # @return [RetrieveTeamMemberResponse Hash] response from the API call
+    def retrieve_team_member(team_member_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/{team_member_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => team_member_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
+
+    # Updates a single `TeamMember` object. The `TeamMember` will be returned on
+    # successful updates.
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#updatet
+    # eammember).
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to update.
+    # @param [UpdateTeamMemberRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateTeamMemberResponse Hash] response from the API call
+    def update_team_member(team_member_id:,
+                           body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/{team_member_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id
+      )
+      _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
+
+    # Retrieve a `WageSetting` object for a team member specified
+    # by `TeamMember.id`.
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#retriev
+    # ewagesetting).
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to retrieve wage setting for
+    # @return [RetrieveWageSettingResponse Hash] response from the API call
+    def retrieve_wage_setting(team_member_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/{team_member_id}/wage-setting'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => team_member_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
+
+    # Creates or updates a `WageSetting` object. The object is created if a
+    # `WageSetting` with the specified `team_member_id` does not exist.
+    # Otherwise,
+    # it fully replaces the `WageSetting` object for the team member.
+    # The `WageSetting` will be returned upon successful update.
+    # Learn about [Troubleshooting the Teams
+    # API](https://developer.squareup.com/docs/docs/team/troubleshooting#updatew
+    # agesetting).
+    # @param [String] team_member_id Required parameter: The ID of the team
+    # member to update the `WageSetting` object for.
+    # @param [UpdateWageSettingRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateWageSettingResponse Hash] response from the API call
+    def update_wage_setting(team_member_id:,
+                            body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/team-members/{team_member_id}/wage-setting'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id
+      )
+      _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
+  end
+end