square.rb 3.20190814.0 → 3.20190925.0

data/lib/square/api/locations_api.rb

@@ -1,45 +1,117 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Square
-  # LocationsApi
-  class LocationsApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Provides the details for all of a business's locations.
-    # Most other Connect API endpoints have a required `location_id` path
-    # parameter.
-    # The `id` field of the [`Location`](#type-location) objects returned by
-    # this
-    # endpoint correspond to that `location_id` parameter.
-    # @return [ListLocationsResponse Hash] response from the API call
-    def list_locations
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations'
-      _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
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # LocationsApi
+  class LocationsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Provides the details for all of a business's locations.
+    # Most other Connect API endpoints have a required `location_id` path
+    # parameter.
+    # The `id` field of the [`Location`](#type-location) objects returned by
+    # this
+    # endpoint correspond to that `location_id` parameter.
+    # @return [ListLocationsResponse Hash] response from the API call
+    def list_locations
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations'
+      _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 details of a location.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # retrieve.
+    # @return [RetrieveLocationResponse Hash] response from the API call
+    def retrieve_location(location_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}'
+      _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'
+      }
+
+      # 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 `Location` specified by the given ID.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # update.
+    # @param [UpdateLocationRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpdateLocationResponse Hash] response from the API call
+    def update_location(location_id:,
+                        body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}'
+      _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.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/merchants_api.rb

@@ -0,0 +1,46 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Square
+  # MerchantsApi
+  class MerchantsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    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

@@ -1,56 +1,56 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-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://docs.connect.squareup.com/get-started#step-4-understan
-    # d-the-different-application-credentials).
-    # @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
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+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/get-started#step-4-underst
+    # and-the-different-application-credentials).
+    # @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

@@ -1,168 +1,168 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-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's 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
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+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's 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