RubyGems - square.rb - Versions diffs - 3.20190814.0 → 3.20190925.0 - Mend

square.rb 3.20190814.0 → 3.20190925.0

Files changed (39) hide show

checksums.yaml +4 -4
data/README.md +6 -2
data/lib/square.rb +53 -52
data/lib/square/api/apple_pay_api.rb +55 -55
data/lib/square/api/base_api.rb +48 -45
data/lib/square/api/catalog_api.rb +461 -461
data/lib/square/api/checkout_api.rb +54 -54
data/lib/square/api/customers_api.rb +335 -335
data/lib/square/api/employees_api.rb +91 -91
data/lib/square/api/inventory_api.rb +300 -300
data/lib/square/api/labor_api.rb +558 -558
data/lib/square/api/locations_api.rb +117 -45
data/lib/square/api/merchants_api.rb +46 -0
data/lib/square/api/mobile_authorization_api.rb +56 -56
data/lib/square/api/o_auth_api.rb +168 -168
data/lib/square/api/orders_api.rb +271 -269
data/lib/square/api/payments_api.rb +282 -282
data/lib/square/api/refunds_api.rb +149 -149
data/lib/square/api/reporting_api.rb +145 -143
data/lib/square/api/transactions_api.rb +379 -379
data/lib/square/api/v1_employees_api.rb +720 -720
data/lib/square/api/v1_items_api.rb +1651 -1651
data/lib/square/api/v1_locations_api.rb +67 -67
data/lib/square/api/v1_transactions_api.rb +574 -574
data/lib/square/api_helper.rb +281 -281
data/lib/square/client.rb +155 -139
data/lib/square/configuration.rb +98 -88
data/lib/square/exceptions/api_exception.rb +20 -20
data/lib/square/http/api_response.rb +50 -50
data/lib/square/http/auth/o_auth2.rb +17 -17
data/lib/square/http/faraday_client.rb +64 -64
data/lib/square/http/http_call_back.rb +24 -24
data/lib/square/http/http_client.rb +104 -104
data/lib/square/http/http_method_enum.rb +13 -13
data/lib/square/http/http_request.rb +50 -50
data/lib/square/http/http_response.rb +29 -29
data/test/api/test_labor_api.rb +74 -0
metadata +4 -3
data/lib/square/api/v1_locations_api.rbe +0 -67

data/lib/square/api/refunds_api.rb CHANGED

@@ -1,149 +1,149 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-module Square
-  # RefundsApi
-  class RefundsApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-    # Retrieves a list of refunds for the account making the request.
-    # Max results per page: 100
-    # @param [String] begin_time Optional parameter: Timestamp for the beginning
-    # of the requested reporting period, in RFC 3339 format.  Default: The
-    # current time minus one year.
-    # @param [String] end_time Optional parameter: Timestamp for the end of the
-    # requested reporting period, in RFC 3339 format.  Default: The current
-    # time.
-    # @param [String] sort_order Optional parameter: The order in which results
-    # are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest
-    # (default).
-    # @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
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
-    # @param [String] location_id Optional parameter: ID of location associated
-    # with payment.
-    # @param [String] status Optional parameter: If provided, only refunds with
-    # the given status are returned.  For a list of refund status values, see
-    # [PaymentRefund](#type-paymentrefund).  Default: If omitted refunds are
-    # returned regardless of status.
-    # @param [String] source_type Optional parameter: If provided, only refunds
-    # with the given source type are returned.  - `CARD` - List refunds only for
-    # payments where card was specified as payment  source.  Default: If omitted
-    # refunds are returned regardless of source type.
-    # @return [ListPaymentRefundsResponse Hash] response from the API call
-    def list_payment_refunds(begin_time: nil,
-                             end_time: nil,
-                             sort_order: nil,
-                             cursor: nil,
-                             location_id: nil,
-                             status: nil,
-                             source_type: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds'
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor,
-        'location_id' => location_id,
-        'status' => status,
-        'source_type' => source_type
-      )
-      _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
-    # Refunds a payment. You can refund the entire payment amount or a
-    # portion of it. For more information, see
-    # [Payments and Refunds
-    # Overview](https://developer.squareup.com/docs/payments-api/overview).
-    # @param [RefundPaymentRequest] body Required parameter: An object
-    # containing the fields to POST for the request.  See the corresponding
-    # object definition for field details.
-    # @return [RefundPaymentResponse Hash] response from the API call
-    def refund_payment(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds'
-      _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 specific `Refund` using the `refund_id`.
-    # @param [String] refund_id Required parameter: Unique ID for the desired
-    # `PaymentRefund`.
-    # @return [GetPaymentRefundResponse Hash] response from the API call
-    def get_payment_refund(refund_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds/{refund_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'refund_id' => refund_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
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+module Square
+  # RefundsApi
+  class RefundsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+    # Retrieves a list of refunds for the account making the request.
+    # Max results per page: 100
+    # @param [String] begin_time Optional parameter: Timestamp for the beginning
+    # of the requested reporting period, in RFC 3339 format.  Default: The
+    # current time minus one year.
+    # @param [String] end_time Optional parameter: Timestamp for the end of the
+    # requested reporting period, in RFC 3339 format.  Default: The current
+    # time.
+    # @param [String] sort_order Optional parameter: The order in which results
+    # are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest
+    # (default).
+    # @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
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # for more information.
+    # @param [String] location_id Optional parameter: ID of location associated
+    # with payment.
+    # @param [String] status Optional parameter: If provided, only refunds with
+    # the given status are returned.  For a list of refund status values, see
+    # [PaymentRefund](#type-paymentrefund).  Default: If omitted refunds are
+    # returned regardless of status.
+    # @param [String] source_type Optional parameter: If provided, only refunds
+    # with the given source type are returned.  - `CARD` - List refunds only for
+    # payments where card was specified as payment  source.  Default: If omitted
+    # refunds are returned regardless of source type.
+    # @return [ListPaymentRefundsResponse Hash] response from the API call
+    def list_payment_refunds(begin_time: nil,
+                             end_time: nil,
+                             sort_order: nil,
+                             cursor: nil,
+                             location_id: nil,
+                             status: nil,
+                             source_type: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/refunds'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'sort_order' => sort_order,
+        'cursor' => cursor,
+        'location_id' => location_id,
+        'status' => status,
+        'source_type' => source_type
+      )
+      _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
+    # Refunds a payment. You can refund the entire payment amount or a
+    # portion of it. For more information, see
+    # [Payments and Refunds
+    # Overview](https://developer.squareup.com/docs/payments-api/overview).
+    # @param [RefundPaymentRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [RefundPaymentResponse Hash] response from the API call
+    def refund_payment(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/refunds'
+      _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 specific `Refund` using the `refund_id`.
+    # @param [String] refund_id Required parameter: Unique ID for the desired
+    # `PaymentRefund`.
+    # @return [GetPaymentRefundResponse Hash] response from the API call
+    def get_payment_refund(refund_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/refunds/{refund_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'refund_id' => refund_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/reporting_api.rb CHANGED

@@ -1,143 +1,145 @@
-# square
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-module Square
-  # ReportingApi
-  class ReportingApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-    # Returns a list of refunded transactions (across all possible originating
-    # locations) relating to monies
-    # credited to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivableRefunds for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @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
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
-    # @return [ListAdditionalRecipientReceivableRefundsResponse Hash] response from the API call
-    def list_additional_recipient_receivable_refunds(location_id:,
-                                                     begin_time: nil,
-                                                     end_time: nil,
-                                                     sort_order: nil,
-                                                     cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivable_refunds in ReportingApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivable-refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        '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
-    # Returns a list of receivables (across all possible sending locations)
-    # representing monies credited
-    # to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivables for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @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
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # for more information.
-    # @return [ListAdditionalRecipientReceivablesResponse Hash] response from the API call
-    def list_additional_recipient_receivables(location_id:,
-                                              begin_time: nil,
-                                              end_time: nil,
-                                              sort_order: nil,
-                                              cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivables in ReportingApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivables'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        '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
-  end
-end
+# square
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+module Square
+  # ReportingApi
+  class ReportingApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+    # Returns a list of refunded transactions (across all possible originating
+    # locations) relating to monies
+    # credited to the provided location ID by another Square account using the
+    # `additional_recipients` field in a transaction.
+    # Max results per [page](#paginatingresults): 50
+    # @param [String] location_id Required parameter: The ID of the location to
+    # list AdditionalRecipientReceivableRefunds for.
+    # @param [String] begin_time Optional parameter: The beginning of the
+    # requested reporting period, in RFC 3339 format.  See [Date
+    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
+    # value: The current time minus one year.
+    # @param [String] end_time Optional parameter: The end of the requested
+    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
+    # details on date inclusivity/exclusivity.  Default value: The current
+    # time.
+    # @param [SortOrder] sort_order Optional parameter: The order in which
+    # results are listed in the response (`ASC` for oldest first, `DESC` for
+    # newest first).  Default value: `DESC`
+    # @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
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # for more information.
+    # @return [ListAdditionalRecipientReceivableRefundsResponse Hash] response from the API call
+    def list_additional_recipient_receivable_refunds(location_id:,
+                                                     begin_time: nil,
+                                                     end_time: nil,
+                                                     sort_order: nil,
+                                                     cursor: nil)
+      warn 'Endpoint list_additional_recipient_receivable_refunds in Reporting'\
+           'Api is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivable-refunds'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => location_id
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'sort_order' => sort_order,
+        '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
+    # Returns a list of receivables (across all possible sending locations)
+    # representing monies credited
+    # to the provided location ID by another Square account using the
+    # `additional_recipients` field in a transaction.
+    # Max results per [page](#paginatingresults): 50
+    # @param [String] location_id Required parameter: The ID of the location to
+    # list AdditionalRecipientReceivables for.
+    # @param [String] begin_time Optional parameter: The beginning of the
+    # requested reporting period, in RFC 3339 format.  See [Date
+    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
+    # value: The current time minus one year.
+    # @param [String] end_time Optional parameter: The end of the requested
+    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
+    # details on date inclusivity/exclusivity.  Default value: The current
+    # time.
+    # @param [SortOrder] sort_order Optional parameter: The order in which
+    # results are listed in the response (`ASC` for oldest first, `DESC` for
+    # newest first).  Default value: `DESC`
+    # @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
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # for more information.
+    # @return [ListAdditionalRecipientReceivablesResponse Hash] response from the API call
+    def list_additional_recipient_receivables(location_id:,
+                                              begin_time: nil,
+                                              end_time: nil,
+                                              sort_order: nil,
+                                              cursor: nil)
+      warn 'Endpoint list_additional_recipient_receivables in ReportingApi is '\
+           'deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivables'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => location_id
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'sort_order' => sort_order,
+        '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
+  end
+end