fangkuai.rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56c9c3f195a152d6a31bb63f9cb26ec4dcab92ccee6d1778db4466285e2d2bd2
+  data.tar.gz: 0ead846acab56019bf56f6ee729f3b80c86e52c24f19e8fc60bbc0a2250f2821
+SHA512:
+  metadata.gz: c6b7526615b4bdb7ef94f1701a41668316b6cda8aa81da559bc32caa750e12e5722a7c44684648364aee580d54f1841483d698c91384d65f74f8d8f97887960d
+  data.tar.gz: 9c7240d6f939f422a0789339518aaf48de06fc00e6087313aaee7becc7bb29bd1a86ee7a10ec28179b75b9851c28361a6416659722461f1afbc8c1c6689a7d8a

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright 2020 Square, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+   https://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1 @@
+# test-ruby

data/lib/square.rb

@@ -0,0 +1,61 @@
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'square/api_helper.rb'
+require_relative 'square/client.rb'
+
+# Utilities
+require_relative 'square/utilities/file_wrapper.rb'
+
+# Http
+require_relative 'square/http/api_response.rb'
+require_relative 'square/http/http_call_back.rb'
+require_relative 'square/http/http_client.rb'
+require_relative 'square/http/faraday_client.rb'
+require_relative 'square/http/http_method_enum.rb'
+require_relative 'square/http/http_request.rb'
+require_relative 'square/http/http_response.rb'
+require_relative 'square/http/auth/o_auth2.rb'
+
+# Models
+
+# Exceptions
+require_relative 'square/exceptions/api_exception.rb'
+
+require_relative 'square/configuration.rb'
+
+# Controllers
+require_relative 'square/api/base_api.rb'
+require_relative 'square/api/mobile_authorization_api.rb'
+require_relative 'square/api/o_auth_api.rb'
+require_relative 'square/api/v1_locations_api.rb'
+require_relative 'square/api/v1_employees_api.rb'
+require_relative 'square/api/v1_transactions_api.rb'
+require_relative 'square/api/v1_items_api.rb'
+require_relative 'square/api/apple_pay_api.rb'
+require_relative 'square/api/bank_accounts_api.rb'
+require_relative 'square/api/cash_drawers_api.rb'
+require_relative 'square/api/catalog_api.rb'
+require_relative 'square/api/customers_api.rb'
+require_relative 'square/api/customer_groups_api.rb'
+require_relative 'square/api/customer_segments_api.rb'
+require_relative 'square/api/devices_api.rb'
+require_relative 'square/api/disputes_api.rb'
+require_relative 'square/api/employees_api.rb'
+require_relative 'square/api/inventory_api.rb'
+require_relative 'square/api/invoices_api.rb'
+require_relative 'square/api/labor_api.rb'
+require_relative 'square/api/locations_api.rb'
+require_relative 'square/api/checkout_api.rb'
+require_relative 'square/api/transactions_api.rb'
+require_relative 'square/api/loyalty_api.rb'
+require_relative 'square/api/merchants_api.rb'
+require_relative 'square/api/orders_api.rb'
+require_relative 'square/api/payments_api.rb'
+require_relative 'square/api/refunds_api.rb'
+require_relative 'square/api/subscriptions_api.rb'
+require_relative 'square/api/team_api.rb'
+require_relative 'square/api/terminal_api.rb'

data/lib/square/api/apple_pay_api.rb

@@ -0,0 +1,50 @@
+module Square
+  # ApplePayApi
+  class ApplePayApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Activates a domain for use with Web Apple Pay and Square. A validation
+    # will be performed on this domain by Apple to ensure is it properly set up
+    # as
+    # an Apple Pay enabled domain.
+    # This endpoint provides an easy way for platform developers to bulk
+    # 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).
+    # @param [RegisterDomainRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [RegisterDomainResponse Hash] response from the API call
+    def register_domain(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/apple-pay/domains'
+      _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/bank_accounts_api.rb

@@ -0,0 +1,136 @@
+module Square
+  # BankAccountsApi
+  class BankAccountsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Returns a list of [BankAccount](#type-bankaccount) objects linked to a
+    # Square account.
+    # For more information, see
+    # [Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # @param [String] cursor Optional parameter: The pagination cursor returned
+    # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
+    # request to retrieve the next set  of results.  See the
+    # [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pa
+    # gination) guide for more information.
+    # @param [Integer] limit Optional parameter: Upper limit on the number of
+    # bank accounts to return in the response.  Currently, 1000 is the largest
+    # supported limit. You can specify a limit  of up to 1000 bank accounts.
+    # This is also the default limit.
+    # @param [String] location_id Optional parameter: Location ID. You can
+    # specify this optional filter  to retrieve only the linked bank accounts
+    # belonging to a specific location.
+    # @return [ListBankAccountsResponse Hash] response from the API call
+    def list_bank_accounts(cursor: nil,
+                           limit: nil,
+                           location_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'limit' => limit,
+        '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
+
+    # Returns details of a [BankAccount](#type-bankaccount) identified by V1
+    # bank account ID.
+    # For more information, see
+    # [Retrieve a bank account by using an ID issued by V1 Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
+    # -bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api).
+    # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
+    # the desired `BankAccount`. For more information, see  [Retrieve a bank
+    # account by using an ID issued by V1 Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
+    # -bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
+    # @return [GetBankAccountByV1IdResponse Hash] response from the API call
+    def get_bank_account_by_v1_id(v1_bank_account_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'v1_bank_account_id' => v1_bank_account_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
+
+    # Returns details of a [BankAccount](#type-bankaccount)
+    # linked to a Square account. For more information, see
+    # [Bank Accounts
+    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # @param [String] bank_account_id Required parameter: Square-issued ID of
+    # the desired `BankAccount`.
+    # @return [GetBankAccountResponse Hash] response from the API call
+    def get_bank_account(bank_account_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bank-accounts/{bank_account_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'bank_account_id' => bank_account_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/base_api.rb

@@ -0,0 +1,43 @@
+module Square
+  # BaseApi.
+  class BaseApi
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'Square-Ruby-SDK/6.3.0.20200826',
+        'Square-Version' => config.square_version
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @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
+
+      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) if @http_call_back
+
+      response
+    end
+  end
+end

data/lib/square/api/cash_drawers_api.rb

@@ -0,0 +1,150 @@
+module Square
+  # CashDrawersApi
+  class CashDrawersApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Provides the details for all of the cash drawer shifts for a location
+    # in a date range.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # query for a list of cash drawer shifts.
+    # @param [SortOrder] sort_order Optional parameter: The order in which cash
+    # drawer shifts are listed in the response, based on their opened_at field.
+    # Default value: ASC
+    # @param [String] begin_time Optional parameter: The inclusive start time of
+    # the query on opened_at, in ISO 8601 format.
+    # @param [String] end_time Optional parameter: The exclusive end date of the
+    # query on opened_at, in ISO 8601 format.
+    # @param [Integer] limit Optional parameter: Number of cash drawer shift
+    # events in a page of results (200 by default, 1000 max).
+    # @param [String] cursor Optional parameter: Opaque cursor for fetching the
+    # next page of results.
+    # @return [ListCashDrawerShiftsResponse Hash] response from the API call
+    def list_cash_drawer_shifts(location_id:,
+                                sort_order: nil,
+                                begin_time: nil,
+                                end_time: nil,
+                                limit: nil,
+                                cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cash-drawers/shifts'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'sort_order' => sort_order,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'limit' => limit,
+        '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
+
+    # Provides the summary details for a single cash drawer shift. See
+    # RetrieveCashDrawerShiftEvents for a list of cash drawer shift events.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # retrieve cash drawer shifts from.
+    # @param [String] shift_id Required parameter: The shift ID.
+    # @return [RetrieveCashDrawerShiftResponse Hash] response from the API call
+    def retrieve_cash_drawer_shift(location_id:,
+                                   shift_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cash-drawers/shifts/{shift_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'shift_id' => shift_id
+      )
+      _query_builder = APIHelper.append_url_with_query_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
+
+    # Provides a paginated list of events for a single cash drawer shift.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # list cash drawer shifts for.
+    # @param [String] shift_id Required parameter: The shift ID.
+    # @param [Integer] limit Optional parameter: Number of resources to be
+    # returned in a page of results (200 by default, 1000 max).
+    # @param [String] cursor Optional parameter: Opaque cursor for fetching the
+    # next page of results.
+    # @return [ListCashDrawerShiftEventsResponse Hash] response from the API call
+    def list_cash_drawer_shift_events(location_id:,
+                                      shift_id:,
+                                      limit: nil,
+                                      cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cash-drawers/shifts/{shift_id}/events'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'shift_id' => shift_id
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'limit' => limit,
+        '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