square.rb 5.2.2.20200422 → 6.3.0.20200826

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

data/lib/square/api/transactions_api.rb

@@ -6,16 +6,6 @@ module Square
     end
 
     # Lists refunds for one of a business's locations.
-    # Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # In addition to full or partial tender refunds processed through Square
     # APIs,
     # refunds may result from itemized returns or exchanges through Square's
@@ -83,16 +73,6 @@ module Square
     end
 
     # Lists transactions for a particular location.
-    # Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # Transactions include payment information from sales and exchanges and
     # refund
     # information from returns and exchanges.
@@ -157,17 +137,6 @@ module Square
     end
 
     # Charges a card represented by a card nonce or a customer's card on file.
-    # Deprecated - recommend using
-    # [CreatePayment](#endpoint-payments-createpayment)
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # Your request to this endpoint must include _either_:
     # - A value for the `card_nonce` parameter (to charge a card nonce generated
     # with the `SqPaymentForm`)
@@ -226,17 +195,6 @@ module Square
     end
 
     # Retrieves details for a single transaction.
-    # Deprecated - recommend using
-    # [BatchRetrieveOrders](#endpoint-batchretrieveorders)
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # @param [String] location_id Required parameter: The ID of the
     # transaction's associated location.
     # @param [String] transaction_id Required parameter: The ID of the
@@ -277,15 +235,6 @@ module Square
     # Captures a transaction that was created with the
     # [Charge](#endpoint-charge)
     # endpoint with a `delay_capture` value of `true`.
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
     # erview#delayed-capture)
@@ -326,17 +275,6 @@ module Square
     end
 
     # Initiates a refund for a previously charged tender.
-    # Deprecated - recommend using
-    # [RefundPayment](#endpoint-refunds-refundpayment)
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # You must issue a refund within 120 days of the associated payment. See
     # [this article](https://squareup.com/help/us/en/article/5060) for more
     # information
@@ -389,15 +327,6 @@ module Square
 
     # Cancels a transaction that was created with the [Charge](#endpoint-charge)
     # endpoint with a `delay_capture` value of `true`.
-    # ---
-    # - __Deprecation date__: 2019-08-15
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/build-basics/api-lifecycle#dep
-    # recated): 2021-09-01
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/payments-api/migrate-from-trans
-    # actions-api)
-    # ---
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
     # erview#delayed-capture)

data/lib/square/api/v1_employees_api.rb

@@ -345,15 +345,6 @@ module Square
     end
 
     # Provides summary information for all of a business's employee timecards.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
     # @param [SortOrder] order Optional parameter: The order in which timecards
     # are listed in the response, based on their created_at field.
     # @param [String] employee_id Optional parameter: If provided, the endpoint
@@ -395,7 +386,7 @@ module Square
                        end_clockout_time: nil,
                        begin_updated_at: nil,
                        end_updated_at: nil,
-                       deleted: nil,
+                       deleted: false,
                        limit: nil,
                        batch_token: nil)
       warn 'Endpoint list_timecards in V1EmployeesApi is deprecated'
@@ -440,15 +431,6 @@ module Square
     # Creates a timecard for an employee and clocks them in with an
     # `API_CREATE` event and a `clockin_time` set to the current time unless
     # the request provides a different value.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
     # To import timecards from another
     # system (rather than clocking someone in). Specify the `clockin_time`
     # and* `clockout_time` in the request.
@@ -493,25 +475,15 @@ module Square
     # Square Dashboard. Deleted timecards are still accessible through
     # Connect API endpoints, but cannot be modified. The `deleted` field of
     # the `Timecard` object indicates whether the timecard has been deleted.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
-    # *Note**: By default, deleted timecards appear alongside valid timecards in
+    # __Note__: By default, deleted timecards appear alongside valid timecards
+    # in
     # results returned by the
     # [ListTimecards](#endpoint-v1employees-listtimecards)
     # endpoint. To filter deleted timecards, include the `deleted` query
     # parameter in the list request.
-    # <aside>
     # Only approved accounts can manage their employees with Square.
     # Unapproved accounts cannot use employee management features with the
     # API.
-    # </aside>
     # @param [String] timecard_id Required parameter: The ID of the timecard to
     # delete.
     # @return [Object] response from the API call
@@ -538,15 +510,6 @@ module Square
     end
 
     # Provides the details for a single timecard.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
     # <aside>
     # Only approved accounts can manage their employees with Square.
     # Unapproved accounts cannot use employee management features with the
@@ -587,15 +550,6 @@ module Square
     # Modifies the details of a timecard with an `API_EDIT` event for
     # the timecard. Updating an active timecard with a `clockout_time`
     # clocks the employee out.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
     # @param [String] timecard_id Required parameter: TThe ID of the timecard to
     # modify.
     # @param [V1Timecard] body Required parameter: An object containing the
@@ -637,15 +591,6 @@ module Square
 
     # Provides summary information for all events associated with a
     # particular timecard.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # timecards)
-    # ---
     # <aside>
     # Only approved accounts can manage their employees with Square.
     # Unapproved accounts cannot use employee management features with the
@@ -686,15 +631,6 @@ module Square
 
     # Provides the details for all of a location's cash drawer shifts during a
     # date range. The date range you specify cannot exceed 90 days.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # cashdrawershifts)
-    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list cash drawer shifts for.
     # @param [SortOrder] order Optional parameter: The order in which cash
@@ -748,15 +684,6 @@ module Square
 
     # Provides the details for a single cash drawer shift, including all events
     # that occurred during the shift.
-    # ---
-    # - __Deprecation date__: 2020-02-26
-    # - [__Retirement
-    # date__](https://developer.squareup.com/docs/docs/build-basics/api-lifecycl
-    # e#deprecated): 2021-02-26
-    # - [Migration
-    # guide](https://developer.squareup.com/docs/docs/migrate-from-v1/guides/v1-
-    # cashdrawershifts)
-    # ---
     # @param [String] location_id Required parameter: The ID of the location to
     # list cash drawer shifts for.
     # @param [String] shift_id Required parameter: The shift's ID.