square.rb 3.3.0.20191217

data/lib/square/api/customers_api.rb

@@ -0,0 +1,327 @@
+module Square
+  # CustomersApi
+  class CustomersApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists a business's customers.
+    # @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 the [Pagination
+    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
+    # @param [CustomerSortField] sort_field Optional parameter: Indicates how
+    # Customers should be sorted.  Default: `DEFAULT`.
+    # @param [SortOrder] sort_order Optional parameter: Indicates whether
+    # Customers should be sorted in ascending (`ASC`) or descending (`DESC`)
+    # order.  Default: `ASC`.
+    # @return [ListCustomersResponse Hash] response from the API call
+    def list_customers(cursor: nil,
+                       sort_field: nil,
+                       sort_order: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'sort_field' => sort_field,
+        '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
+
+    # Creates a new customer for a business, which can have associated cards on
+    # file.
+    # You must provide __at least one__ of the following values in your request
+    # to this
+    # endpoint:
+    # - `given_name`
+    # - `family_name`
+    # - `company_name`
+    # - `email_address`
+    # - `phone_number`
+    # @param [CreateCustomerRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateCustomerResponse Hash] response from the API call
+    def create_customer(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers'
+      _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 the customer profiles associated with a Square account.
+    # Calling SearchCustomers without an explicit query parameter returns all
+    # customer profiles ordered alphabetically based on `given_name` and
+    # `family_name`.
+    # @param [SearchCustomersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchCustomersResponse Hash] response from the API call
+    def search_customers(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/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
+
+    # Deletes a customer from a business, along with any linked cards on file.
+    # When two profiles
+    # are merged into a single profile, that profile is assigned a new
+    # `customer_id`. You must use the
+    # new `customer_id` to delete merged profiles.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # delete.
+    # @return [DeleteCustomerResponse Hash] response from the API call
+    def delete_customer(customer_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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
+
+    # Returns details for a single customer.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # retrieve.
+    # @return [RetrieveCustomerResponse Hash] response from the API call
+    def retrieve_customer(customer_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_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 the details of an existing customer. When two profiles are merged
+    # into a single profile, that profile is assigned a new `customer_id`. You
+    # must use
+    # the new `customer_id` to update merged profiles.
+    # You cannot edit a customer's cards on file with this endpoint. To make
+    # changes
+    # to a card on file, you must delete the existing card on file with the
+    # [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a
+    # new one with the
+    # [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # update.
+    # @param [UpdateCustomerRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateCustomerResponse Hash] response from the API call
+    def update_customer(customer_id:,
+                        body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_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
+
+    # Adds a card on file to an existing customer.
+    # As with charges, calls to `CreateCustomerCard` are idempotent. Multiple
+    # calls with the same card nonce return the same card record that was
+    # created
+    # with the provided nonce during the _first_ call.
+    # @param [String] customer_id Required parameter: The Square ID of the
+    # customer profile the card is linked to.
+    # @param [CreateCustomerCardRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateCustomerCardResponse Hash] response from the API call
+    def create_customer_card(customer_id:,
+                             body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/cards'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_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.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
+
+    # Removes a card on file from a customer.
+    # @param [String] customer_id Required parameter: The ID of the customer
+    # that the card on file belongs to.
+    # @param [String] card_id Required parameter: The ID of the card on file to
+    # delete.
+    # @return [DeleteCustomerCardResponse Hash] response from the API call
+    def delete_customer_card(customer_id:,
+                             card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/customers/{customer_id}/cards/{card_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'customer_id' => customer_id,
+        'card_id' => card_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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/employees_api.rb

@@ -0,0 +1,86 @@
+module Square
+  # EmployeesApi
+  class EmployeesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # ListEmployees
+    # @param [String] location_id Optional parameter: Filter employees returned
+    # to only those that are associated with the specified location.
+    # @param [EmployeeStatus] status Optional parameter: Specifies the
+    # EmployeeStatus to filter the employee by.
+    # @param [Integer] limit Optional parameter: The number of employees to be
+    # returned on each page.
+    # @param [String] cursor Optional parameter: The token required to retrieve
+    # the specified page of results.
+    # @return [ListEmployeesResponse Hash] response from the API call
+    def list_employees(location_id: nil,
+                       status: nil,
+                       limit: nil,
+                       cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/employees'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'status' => status,
+        'limit' => limit,
+        'cursor' => cursor
+      )
+      _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
+
+    # RetrieveEmployee
+    # @param [String] id Required parameter: UUID for the employee that was
+    # requested.
+    # @return [RetrieveEmployeeResponse Hash] response from the API call
+    def retrieve_employee(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/employees/{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'
+      }
+
+      # 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
+  end
+end