square.rb 3.3.0.20191217

data/lib/square/api/merchants_api.rb

@@ -0,0 +1,82 @@
+module Square
+  # MerchantsApi
+  class MerchantsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Returns `Merchant` information for a given access token.
+    # If you don't know a `Merchant` ID, you can use this endpoint to retrieve
+    # the merchant ID for an access token.
+    # You can specify your personal access token to get your own merchant
+    # information or specify an OAuth token
+    # to get the information for the  merchant that granted you access.
+    # If you know the merchant ID, you can also use the
+    # [RetrieveMerchant](#endpoint-merchants-retrievemerchant)
+    # endpoint to get the merchant information.
+    # @param [Integer] cursor Optional parameter: The cursor generated by the
+    # previous response.
+    # @return [ListMerchantsResponse Hash] response from the API call
+    def list_merchants(cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/merchants'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        '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
+
+    # Retrieve a `Merchant` object for the given `merchant_id`.
+    # @param [String] merchant_id Required parameter: The ID of the merchant to
+    # retrieve.
+    # @return [RetrieveMerchantResponse Hash] response from the API call
+    def retrieve_merchant(merchant_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/merchants/{merchant_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'merchant_id' => merchant_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

data/lib/square/api/mobile_authorization_api.rb

@@ -0,0 +1,52 @@
+module Square
+  # MobileAuthorizationApi
+  class MobileAuthorizationApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Generates code to authorize a mobile application to connect to a Square
+    # card reader
+    # Authorization codes are one-time-use and expire __60 minutes__ after being
+    # issued.
+    # __Important:__ The `Authorization` header you provide to this endpoint
+    # must have the following format:
+    # ```
+    # Authorization: Bearer ACCESS_TOKEN
+    # ```
+    # Replace `ACCESS_TOKEN` with a
+    # [valid production authorization
+    # credential](https://developer.squareup.com/docs/docs/build-basics/access-t
+    # okens).
+    # @param [CreateMobileAuthorizationCodeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [CreateMobileAuthorizationCodeResponse Hash] response from the API call
+    def create_mobile_authorization_code(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/mobile/authorization-code'
+      _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

data/lib/square/api/o_auth_api.rb

@@ -0,0 +1,163 @@
+module Square
+  # OAuthApi
+  class OAuthApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # `RenewToken` is deprecated. For information about refreshing OAuth access
+    # tokens, see
+    # [Renew OAuth
+    # Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-
+    # tokens).
+    # Renews an OAuth access token before it expires.
+    # OAuth access tokens besides your application's personal access token
+    # expire after __30 days__.
+    # You can also renew expired tokens within __15 days__ of their expiration.
+    # You cannot renew an access token that has been expired for more than 15
+    # days.
+    # Instead, the associated user must re-complete the OAuth flow from the
+    # beginning.
+    # __Important:__ The `Authorization` header for this endpoint must have the
+    # following format:
+    # ```
+    # Authorization: Client APPLICATION_SECRET
+    # ```
+    # Replace `APPLICATION_SECRET` with the application secret on the
+    # Credentials
+    # page in the [application dashboard](https://connect.squareup.com/apps).
+    # @param [String] client_id Required parameter: Your application ID,
+    # available from the [application
+    # dashboard](https://connect.squareup.com/apps).
+    # @param [RenewTokenRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @param [String] authorization Required parameter: Client
+    # APPLICATION_SECRET
+    # @return [RenewTokenResponse Hash] response from the API call
+    def renew_token(client_id:,
+                    body:,
+                    authorization:)
+      warn 'Endpoint renew_token in OAuthApi is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth2/clients/{client_id}/access-token/renew'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'client_id' => client_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => authorization
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      _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
+
+    # Revokes an access token generated with the OAuth flow.
+    # If an account has more than one OAuth access token for your application,
+    # this
+    # endpoint revokes all of them, regardless of which token you specify. When
+    # an
+    # OAuth access token is revoked, all of the active subscriptions associated
+    # with that OAuth token are canceled immediately.
+    # __Important:__ The `Authorization` header for this endpoint must have the
+    # following format:
+    # ```
+    # Authorization: Client APPLICATION_SECRET
+    # ```
+    # Replace `APPLICATION_SECRET` with the application secret on the
+    # Credentials
+    # page in the [application dashboard](https://connect.squareup.com/apps).
+    # @param [RevokeTokenRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @param [String] authorization Required parameter: Client
+    # APPLICATION_SECRET
+    # @return [RevokeTokenResponse Hash] response from the API call
+    def revoke_token(body:,
+                     authorization:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth2/revoke'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8',
+        'Authorization' => authorization
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      _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 an OAuth access token.
+    # The endpoint supports distinct methods of obtaining OAuth access tokens.
+    # Applications specify a method by adding the `grant_type` parameter
+    # in the request and also provide relevant information.
+    # For more information, see [OAuth access token
+    # management](https://developer.squareup.com/docs/authz/oauth/how-it-works#o
+    # auth-access-token-management).
+    # __Note:__ Regardless of the method application specified,
+    # the endpoint always returns two items; an OAuth access token and
+    # a refresh token in the response.
+    # __OAuth tokens should only live on secure servers. Application clients
+    # should never interact directly with OAuth tokens__.
+    # @param [ObtainTokenRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [ObtainTokenResponse Hash] response from the API call
+    def obtain_token(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth2/token'
+      _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
+      )
+      _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/orders_api.rb

@@ -0,0 +1,266 @@
+module Square
+  # OrdersApi
+  class OrdersApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates a new [Order](#type-order) which can include information on
+    # products for
+    # purchase and settings to apply to the purchase.
+    # To pay for a created order, please refer to the [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
+    # guide.
+    # You can modify open orders using the
+    # [UpdateOrder](#endpoint-orders-updateorder) endpoint.
+    # To learn more about the Orders API, see the
+    # [Orders API
+    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
+    # @param [String] location_id Required parameter: The ID of the business
+    # location to associate the order with.
+    # @param [CreateOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateOrderResponse Hash] response from the API call
+    def create_order(location_id:,
+                     body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/orders'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => location_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
+
+    # Retrieves a set of [Order](#type-order)s by their IDs.
+    # If a given Order ID does not exist, the ID is ignored instead of
+    # generating an error.
+    # @param [String] location_id Required parameter: The ID of the orders'
+    # associated location.
+    # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BatchRetrieveOrdersResponse Hash] response from the API call
+    def batch_retrieve_orders(location_id:,
+                              body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/orders/batch-retrieve'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => location_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
+
+    # Updates an open [Order](#type-order) by adding, replacing, or deleting
+    # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
+    # An UpdateOrder request requires the following:
+    # - The `order_id` in the endpoint path, identifying the order to update.
+    # - The latest `version` of the order to update.
+    # - The [sparse
+    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
+    # -order-objects)
+    # containing only the fields to update and the version the update is
+    # being applied to.
+    # - If deleting fields, the [dot notation
+    # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
+    # -notation)
+    # identifying fields to clear.
+    # To pay for an order, please refer to the [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
+    # guide.
+    # To learn more about the Orders API, see the
+    # [Orders API
+    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
+    # @param [String] location_id Required parameter: The ID of the order's
+    # associated location.
+    # @param [String] order_id Required parameter: The ID of the order to
+    # update.
+    # @param [UpdateOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [UpdateOrderResponse Hash] response from the API call
+    def update_order(location_id:,
+                     order_id:,
+                     body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/orders/{order_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'order_id' => order_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
+
+    # Search all orders for one or more locations. Orders include all sales,
+    # returns, and exchanges regardless of how or when they entered the Square
+    # Ecosystem (e.g. Point of Sale, Invoices, Connect APIs, etc).
+    # SearchOrders requests need to specify which locations to search and define
+    # a
+    # [`SearchOrdersQuery`](#type-searchordersquery) object which controls
+    # how to sort or filter the results. Your SearchOrdersQuery can:
+    #   Set filter criteria.
+    #   Set sort order.
+    #   Determine whether to return results as complete Order objects, or as
+    # [OrderEntry](#type-orderentry) objects.
+    # Note that details for orders processed with Square Point of Sale while in
+    # offline mode may not be transmitted to Square for up to 72 hours. Offline
+    # orders have a `created_at` value that reflects the time the order was
+    # created,
+    # not the time it was subsequently transmitted to Square.
+    # @param [SearchOrdersRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [SearchOrdersResponse Hash] response from the API call
+    def search_orders(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/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
+
+    # Pay for an [order](#type-order) using one or more approved
+    # [payments](#type-payment),
+    # or settle an order with a total of `0`.
+    # The total of the `payment_ids` listed in the request must be equal to the
+    # order
+    # total. Orders with a total amount of `0` can be marked as paid by
+    # specifying an empty
+    # array of `payment_ids` in the request.
+    # To be used with PayOrder, a payment must:
+    # - Reference the order by specifying the `order_id` when [creating the
+    # payment](#endpoint-payments-createpayment).
+    # Any approved payments that reference the same `order_id` not specified in
+    # the
+    # `payment_ids` will be canceled.
+    # - Be approved with [delayed
+    # capture](https://developer.squareup.com/docs/payments-api/take-payments#de
+    # layed-capture).
+    # Using a delayed capture payment with PayOrder will complete the approved
+    # payment.
+    # Learn how to [pay for orders with a single payment using the Payments
+    # API](https://developer.squareup.com/docs/orders-api/pay-for-orders).
+    # @param [String] order_id Required parameter: The ID of the order being
+    # paid.
+    # @param [PayOrderRequest] body Required parameter: An object containing the
+    # fields to POST for the request.  See the corresponding object definition
+    # for field details.
+    # @return [PayOrderResponse Hash] response from the API call
+    def pay_order(order_id:,
+                  body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/{order_id}/pay'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'order_id' => order_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
+  end
+end