square.rb 3.3.0.20191217 → 3.20190624.0

data/lib/square/api/apple_pay_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # ApplePayApi
   class ApplePayApi < BaseApi
@@ -13,9 +18,8 @@ module Square
     # activate
     # Web Apple Pay with Square for merchants using their platform.
     # To learn more about Apple Pay on Web see the Apple Pay section in the
-    # [Square Payment Form
-    # Walkthrough](https://developer.squareup.com/docs/docs/payment-form/payment
-    # -form-walkthrough).
+    # [Embedding the Square Payment
+    # Form](/payment-form/add-digital-wallets/apple-pay) guide.
     # @param [RegisterDomainRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/base_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # BaseApi.
   class BaseApi
@@ -8,8 +13,8 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/3.3.0.20191217',
-        'Square-Version' => '2019-12-17'
+        'user-agent' => 'Square-Connect-Ruby-BETA/3.20190624.0',
+        'Square-Version' => '2019-06-12'
       }
     end
 
@@ -25,10 +30,7 @@ module Square
       @http_call_back.on_before_request(request) if @http_call_back
 
       APIHelper.clean_hash(request.headers)
-      request.headers.merge!(@global_headers)
-      unless config.additional_headers.nil?
-        request.headers.merge!(config.additional_headers)
-      end
+      request.headers = @global_headers.clone.merge(request.headers)
 
       response = if binary
                    config.http_client.execute_as_binary(request)

data/lib/square/api/catalog_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # CatalogApi
   class CatalogApi < BaseApi
@@ -131,89 +136,6 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Upload an image file to create a new [CatalogImage](#type-catalogimage)
-    # for an existing
-    # [CatalogObject](#type-catalogobject). Images can be uploaded and linked in
-    # this request or created independently
-    # (without an object assignment) and linked to a
-    # [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
-    # ```
-    # 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
-    # ate-catalog-images).
-    # @param [CreateCatalogImageRequest] request Optional parameter: Example:
-    # @param [File | UploadIO] image_file Optional parameter: Example:
-    # @return [CreateCatalogImageResponse Hash] response from the API call
-    def create_catalog_image(request: nil,
-                             image_file: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/catalog/images'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare form parameters.
-      _parameters = {
-        'request' => Faraday::UploadIO.new(
-          StringIO.new(request.to_json),
-          'application/json'
-        ),
-        'image_file' => Faraday::UploadIO.new(
-          image_file,
-          'image/jpeg'
-        )
-      }
-      _parameters = APIHelper.form_encode_parameters(_parameters)
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _query_url,
-        headers: _headers,
-        parameters: _parameters
-      )
-      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 information about the Square Catalog API, such as batch size
     # limits for `BatchUpsertCatalogObjects`.
     # @return [CatalogInfoResponse Hash] response from the API call
@@ -250,7 +172,7 @@ module Square
     # is specified as a comma-separated list of valid
     # [CatalogObject](#type-catalogobject) types:
     # `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`,
-    # `DISCOUNT`, `TAX`, `IMAGE`.
+    # `DISCOUNT`, `TAX`.
     # __Important:__ ListCatalog does not return deleted catalog items. To
     # retrieve
     # deleted catalog items, use SearchCatalogObjects and set
@@ -258,13 +180,13 @@ module Square
     # to `true`.
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # in the previous response. Leave unset for an initial request. See
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
+    # [Pagination](/basics/api101/pagination) for more information.
     # @param [String] types Optional parameter: An optional case-insensitive,
     # comma-separated list of object types to retrieve, for example
     # `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the
-    # CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`,
-    # `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
+    # [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `ITEM`,
+    # `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`,
+    # `MODIFIER_LIST`, or `IMAGE`.
     # @return [ListCatalogResponse Hash] response from the API call
     def list_catalog(cursor: nil,
                      types: nil)
@@ -337,10 +259,11 @@ module Square
     # are also deleted. For example, deleting a [CatalogItem](#type-catalogitem)
     # will also delete all of its
     # [CatalogItemVariation](#type-catalogitemvariation) children.
-    # @param [String] object_id Required parameter: The ID of the catalog object
-    # to be deleted. When an object is deleted, other objects in the graph that
-    # depend on that object will be deleted as well (for example, deleting a
-    # catalog item will delete its catalog item variations).
+    # @param [String] object_id Required parameter: The ID of the
+    # [CatalogObject](#type-catalogobject) to be deleted. When an object is
+    # deleted, other objects in the graph that depend on that object will be
+    # deleted as well (for example, deleting a [CatalogItem](#type-catalogitem)
+    # will delete its [CatalogItemVariation](#type-catalogitemvariation)s).
     # @return [DeleteCatalogObjectResponse Hash] response from the API call
     def delete_catalog_object(object_id:)
       # Prepare query url.
@@ -380,16 +303,18 @@ module Square
     # [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of
     # any [CatalogTax](#type-catalogtax) objects that apply to it.
     # @param [String] object_id Required parameter: The object ID of any type of
-    # catalog objects to be retrieved.
+    # [CatalogObject](#type-catalogobject)s to be retrieved.
     # @param [Boolean] include_related_objects Optional parameter: If `true`,
     # the response will include additional objects that are related to the
     # requested object, as follows:  If the `object` field of the response
-    # contains a CatalogItem, its associated CatalogCategory, CatalogTax
-    # objects, CatalogImages and CatalogModifierLists will be returned in the
+    # contains a [CatalogItem](#type-catalogitem), its associated
+    # [CatalogCategory](#type-catalogcategory),
+    # [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and
+    # [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the
     # `related_objects` field of the response. If the `object` field of the
-    # response contains a CatalogItemVariation, its parent CatalogItem will be
-    # returned in the `related_objects` field of the response.  Default value:
-    # `false`
+    # response contains a [CatalogItemVariation](#type-catalogitemvariation),
+    # its parent [CatalogItem](#type-catalogitem) will be returned in the
+    # `related_objects` field of  the response.  Default value: `false`
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: nil)
@@ -433,16 +358,6 @@ module Square
     # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and
     # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
     # .
-    # --
-    # --
-    # Future end of the above comment:
-    # [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax),
-    # [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)
-    # ,
-    # [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions),
-    # and
-    # [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvari
-    # ationsforitemoptionvalues).
     # @param [SearchCatalogObjectsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/checkout_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # CheckoutApi
   class CheckoutApi < BaseApi

data/lib/square/api/customers_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # CustomersApi
   class CustomersApi < BaseApi
@@ -8,14 +13,13 @@ module Square
     # 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.
+    # results for your original query.  See
+    # [Pagination](/basics/api101/pagination) for more information.
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
-    # Customers should be sorted.  Default: `DEFAULT`.
+    # 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`.
+    # order. Default: `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
                        sort_field: nil,
@@ -203,9 +207,10 @@ module Square
     # 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.
+    # [DeleteCustomerCard](#endpoint-customers-deletecustomercard) endpoint,
+    # then
+    # create a new one with the
+    # [CreateCustomerCard](#endpoint-customers-createcustomercard) endpoint.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object
@@ -249,8 +254,10 @@ module Square
     # 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.
+    # Cards on file are automatically updated on a monthly basis to confirm they
+    # are still valid and can be charged.
+    # @param [String] customer_id Required parameter: The ID of the customer to
+    # link the card on file to.
     # @param [CreateCustomerCardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/api/employees_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # EmployeesApi
   class EmployeesApi < BaseApi
@@ -5,7 +10,7 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # ListEmployees
+    # Gets a list of `Employee` objects for a business.
     # @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
@@ -50,7 +55,7 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # RetrieveEmployee
+    # Gets an `Employee` by Square-assigned employee `ID` (UUID)
     # @param [String] id Required parameter: UUID for the employee that was
     # requested.
     # @return [RetrieveEmployeeResponse Hash] response from the API call

data/lib/square/api/inventory_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # InventoryApi
   class InventoryApi < BaseApi
@@ -197,9 +202,8 @@ module Square
     # empty list queries all locations.
     # @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 the original query.  See the
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination) guide for more information.
+    # results for the original query.  See
+    # [Pagination](/basics/api101/pagination) for more information.
     # @return [RetrieveInventoryCountResponse Hash] response from the API call
     def retrieve_inventory_count(catalog_object_id:,
                                  location_ids: nil,
@@ -252,9 +256,8 @@ module Square
     # empty list queries all locations.
     # @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 the original query.  See the
-    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
-    # gination) guide for more information.
+    # results for the original query.  See
+    # [Pagination](/basics/api101/pagination) for more information.
     # @return [RetrieveInventoryChangesResponse Hash] response from the API call
     def retrieve_inventory_changes(catalog_object_id:,
                                    location_ids: nil,

data/lib/square/api/labor_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # LaborApi
   class LaborApi < BaseApi

data/lib/square/api/locations_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # LocationsApi
   class LocationsApi < BaseApi
@@ -5,7 +10,7 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Provides information of all locations of a business.
+    # 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
@@ -36,111 +41,5 @@ module Square
       _errors = APIHelper.map_response(decoded, ['errors'])
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
-
-    # Creates a location.
-    # For more information about locations, see [Locations API
-    # Overview](https://developer.squareup.com/docs/locations-api).
-    # @param [CreateLocationRequest] body Required parameter: An object
-    # containing the fields to POST for the request.  See the corresponding
-    # object definition for field details.
-    # @return [CreateLocationResponse Hash] response from the API call
-    def create_location(body:)
-      # 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',
-        '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 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 a location.
-    # @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/mobile_authorization_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # MobileAuthorizationApi
   class MobileAuthorizationApi < BaseApi
@@ -14,10 +19,9 @@ module Square
     # ```
     # Authorization: Bearer ACCESS_TOKEN
     # ```
-    # Replace `ACCESS_TOKEN` with a
-    # [valid production authorization
-    # credential](https://developer.squareup.com/docs/docs/build-basics/access-t
-    # okens).
+    # 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.

data/lib/square/api/o_auth_api.rb

@@ -1,3 +1,8 @@
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
 module Square
   # OAuthApi
   class OAuthApi < BaseApi
@@ -7,9 +12,7 @@ module Square
 
     # `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).
+    # [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew).
     # Renews an OAuth access token before it expires.
     # OAuth access tokens besides your application's personal access token
     # expire after __30 days__.
@@ -26,7 +29,7 @@ module Square
     # 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,
+    # @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
@@ -38,7 +41,6 @@ module Square
     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'
@@ -123,8 +125,7 @@ module Square
     # 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).
+    # management](/authz/oauth/how-it-works#oauth-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.