Class: Square::BaseApi
- Inherits:
-
Object
- Object
- Square::BaseApi
- Defined in:
- lib/square/api/base_api.rb
Overview
BaseApi.
Direct Known Subclasses
ApplePayApi, BankAccountsApi, BookingsApi, CardsApi, CashDrawersApi, CatalogApi, CheckoutApi, CustomerGroupsApi, CustomerSegmentsApi, CustomersApi, DevicesApi, DisputesApi, EmployeesApi, GiftCardActivitiesApi, GiftCardsApi, InventoryApi, InvoicesApi, LaborApi, LocationsApi, LoyaltyApi, MerchantsApi, MobileAuthorizationApi, OAuthApi, OrdersApi, PaymentsApi, RefundsApi, SitesApi, SnippetsApi, SubscriptionsApi, TeamApi, TerminalApi, TransactionsApi, V1TransactionsApi
Instance Attribute Summary collapse
-
#config ⇒ Object
Returns the value of attribute config.
-
#http_call_back ⇒ Object
Returns the value of attribute http_call_back.
Instance Method Summary collapse
- #execute_request(request, binary: false) ⇒ Object
-
#initialize(config, http_call_back: nil) ⇒ BaseApi
constructor
A new instance of BaseApi.
- #validate_parameters(args) ⇒ Object
Constructor Details
#initialize(config, http_call_back: nil) ⇒ BaseApi
Returns a new instance of BaseApi.
6 7 8 9 10 11 12 13 14 |
# File 'lib/square/api/base_api.rb', line 6 def initialize(config, http_call_back: nil) @config = config @http_call_back = http_call_back @global_headers = { 'user-agent' => 'Square-Ruby-SDK/14.1.0.20210915', 'Square-Version' => config.square_version } end |
Instance Attribute Details
#config ⇒ Object
Returns the value of attribute config.
4 5 6 |
# File 'lib/square/api/base_api.rb', line 4 def config @config end |
#http_call_back ⇒ Object
Returns the value of attribute http_call_back.
4 5 6 |
# File 'lib/square/api/base_api.rb', line 4 def http_call_back @http_call_back end |
Instance Method Details
#execute_request(request, binary: false) ⇒ Object
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/square/api/base_api.rb', line 22 def execute_request(request, binary: false) @http_call_back&.on_before_request(request) APIHelper.clean_hash(request.headers) request.headers.merge!(@global_headers) unless config.additional_headers.nil? request.headers.merge!(config.additional_headers) end response = if binary config.http_client.execute_as_binary(request) else config.http_client.execute_as_string(request) end @http_call_back&.on_after_response(response) response end |
#validate_parameters(args) ⇒ Object
16 17 18 19 20 |
# File 'lib/square/api/base_api.rb', line 16 def validate_parameters(args) args.each do |_name, value| raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil? end end |