square.rb 8.0.0.20201216 → 26.1.0.20230119

data/lib/square/api/v1_transactions_api.rb

@@ -5,91 +5,10 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Provides non-confidential details for all of a location's associated bank
-    # accounts. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list bank accounts for.
-    # @return [List of V1BankAccount Hash] response from the API call
-    def list_bank_accounts(location_id:)
-      warn 'Endpoint list_bank_accounts in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true }
-      )
-      _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
-
-    # Provides non-confidential details for a merchant's associated bank
-    # account. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the bank
-    # account's associated location.
-    # @param [String] bank_account_id Required parameter: The bank account's
-    # Square-issued ID. You obtain this value from Settlement objects
-    # returned.
-    # @return [V1BankAccount Hash] response from the API call
-    def retrieve_bank_account(location_id:,
-                              bank_account_id:)
-      warn 'Endpoint retrieve_bank_account in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts/{bank_account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true },
-        'bank_account_id' => { 'value' => bank_account_id, 'encode' => true }
-      )
-      _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
-
     # Provides summary information for a merchant's online store orders.
     # @param [String] location_id Required parameter: The ID of the location to
     # list online store orders for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [Integer] limit Optional parameter: The maximum number of payments
     # to return in a single response. This value cannot exceed 200.
@@ -97,10 +16,11 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Order Hash] response from the API call
-    def list_orders(location_id:,
-                    order: nil,
-                    limit: nil,
-                    batch_token: nil)
+    def v1_list_orders(location_id:,
+                       order: nil,
+                       limit: nil,
+                       batch_token: nil)
+      warn 'Endpoint v1_list_orders in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders'
@@ -145,8 +65,9 @@ module Square
     # You obtain this value from Order objects returned by the List Orders
     # endpoint
     # @return [V1Order Hash] response from the API call
-    def retrieve_order(location_id:,
-                       order_id:)
+    def v1_retrieve_order(location_id:,
+                          order_id:)
+      warn 'Endpoint v1_retrieve_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -189,9 +110,10 @@ module Square
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [V1Order Hash] response from the API call
-    def update_order(location_id:,
-                     order_id:,
-                     body:)
+    def v1_update_order(location_id:,
+                        order_id:,
+                        body:)
+      warn 'Endpoint v1_update_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -205,7 +127,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -253,18 +175,19 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @param [Boolean] include_partial Optional parameter: Indicates whether or
-    # not to include partial payments in the response. Partial payments will
-    # have the tenders collected so far, but the itemizations will be empty
-    # until the payment is completed.
+    # @param [TrueClass|FalseClass] include_partial Optional parameter:
+    # Indicates whether or not to include partial payments in the response.
+    # Partial payments will have the tenders collected so far, but the
+    # itemizations will be empty until the payment is completed.
     # @return [List of V1Payment Hash] response from the API call
-    def list_payments(location_id:,
-                      order: nil,
-                      begin_time: nil,
-                      end_time: nil,
-                      limit: nil,
-                      batch_token: nil,
-                      include_partial: false)
+    def v1_list_payments(location_id:,
+                         order: nil,
+                         begin_time: nil,
+                         end_time: nil,
+                         limit: nil,
+                         batch_token: nil,
+                         include_partial: false)
+      warn 'Endpoint v1_list_payments in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'
@@ -312,8 +235,9 @@ module Square
     # endpoint, Settlement objects returned by the List Settlements endpoint, or
     # Refund objects returned by the List Refunds endpoint.
     # @return [V1Payment Hash] response from the API call
-    def retrieve_payment(location_id:,
-                         payment_id:)
+    def v1_retrieve_payment(location_id:,
+                            payment_id:)
+      warn 'Endpoint v1_retrieve_payment in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
@@ -350,7 +274,7 @@ module Square
     # year in length.
     # @param [String] location_id Required parameter: The ID of the location to
     # list refunds for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in ISO 8601 format. If this value is before
@@ -369,12 +293,13 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Refund Hash] response from the API call
-    def list_refunds(location_id:,
-                     order: nil,
-                     begin_time: nil,
-                     end_time: nil,
-                     limit: nil,
-                     batch_token: nil)
+    def v1_list_refunds(location_id:,
+                        order: nil,
+                        begin_time: nil,
+                        end_time: nil,
+                        limit: nil,
+                        batch_token: nil)
+      warn 'Endpoint v1_list_refunds in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -429,8 +354,9 @@ module Square
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [V1Refund Hash] response from the API call
-    def create_refund(location_id:,
-                      body:)
+    def v1_create_refund(location_id:,
+                         body:)
+      warn 'Endpoint v1_create_refund in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -443,7 +369,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -491,13 +417,14 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Settlement Hash] response from the API call
-    def list_settlements(location_id:,
-                         order: nil,
-                         begin_time: nil,
-                         end_time: nil,
-                         limit: nil,
-                         status: nil,
-                         batch_token: nil)
+    def v1_list_settlements(location_id:,
+                            order: nil,
+                            begin_time: nil,
+                            end_time: nil,
+                            limit: nil,
+                            status: nil,
+                            batch_token: nil)
+      warn 'Endpoint v1_list_settlements in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements'
@@ -558,8 +485,9 @@ module Square
     # Square-issued ID. You obtain this value from Settlement objects returned
     # by the List Settlements endpoint.
     # @return [V1Settlement Hash] response from the API call
-    def retrieve_settlement(location_id:,
-                            settlement_id:)
+    def v1_retrieve_settlement(location_id:,
+                               settlement_id:)
+      warn 'Endpoint v1_retrieve_settlement in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'

data/lib/square/api/vendors_api.rb

@@ -0,0 +1,257 @@
+module Square
+  # VendorsApi
+  class VendorsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to
+    # a seller.
+    # @param [BulkCreateVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkCreateVendorsResponse Hash] response from the API call
+    def bulk_create_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-create'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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 one or more vendors of specified [Vendor]($m/Vendor) IDs.
+    # @param [BulkRetrieveVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkRetrieveVendorsResponse Hash] response from the API call
+    def bulk_retrieve_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-retrieve'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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 one or more of existing [Vendor]($m/Vendor) objects as suppliers
+    # to a seller.
+    # @param [BulkUpdateVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkUpdateVendorsResponse Hash] response from the API call
+    def bulk_update_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-update'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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
+
+    # Creates a single [Vendor]($m/Vendor) object to represent a supplier to a
+    # seller.
+    # @param [CreateVendorRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateVendorResponse Hash] response from the API call
+    def create_vendor(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/create'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Searches for vendors using a filter against supported [Vendor]($m/Vendor)
+    # properties and a supported sorter.
+    # @param [SearchVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchVendorsResponse Hash] response from the API call
+    def search_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/search'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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 the vendor of a specified [Vendor]($m/Vendor) ID.
+    # @param [String] vendor_id Required parameter: ID of the
+    # [Vendor]($m/Vendor) to retrieve.
+    # @return [RetrieveVendorResponse Hash] response from the API call
+    def retrieve_vendor(vendor_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/{vendor_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'vendor_id' => { 'value' => vendor_id, 'encode' => true }
+      )
+      _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 an existing [Vendor]($m/Vendor) object as a supplier to a seller.
+    # @param [UpdateVendorRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @param [String] vendor_id Required parameter: Example:
+    # @return [UpdateVendorResponse Hash] response from the API call
+    def update_vendor(body:,
+                      vendor_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/{vendor_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'vendor_id' => { 'value' => vendor_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # 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