Module: SquareConnect

Defined in:
lib/square_connect/version.rb,
lib/square_connect.rb,
lib/square_connect/api_error.rb,
lib/square_connect/api_client.rb,
lib/square_connect/models/card.rb,
lib/square_connect/models/error.rb,
lib/square_connect/models/money.rb,
lib/square_connect/models/order.rb,
lib/square_connect/configuration.rb,
lib/square_connect/models/device.rb,
lib/square_connect/models/refund.rb,
lib/square_connect/models/tender.rb,
lib/square_connect/models/v1_fee.rb,
lib/square_connect/api/orders_api.rb,
lib/square_connect/models/address.rb,
lib/square_connect/models/country.rb,
lib/square_connect/models/v1_item.rb,
lib/square_connect/models/v1_page.rb,
lib/square_connect/api/catalog_api.rb,
lib/square_connect/models/checkout.rb,
lib/square_connect/models/currency.rb,
lib/square_connect/models/customer.rb,
lib/square_connect/models/location.rb,
lib/square_connect/models/v1_money.rb,
lib/square_connect/models/v1_order.rb,
lib/square_connect/api/checkout_api.rb,
lib/square_connect/api/v1_items_api.rb,
lib/square_connect/models/v1_refund.rb,
lib/square_connect/models/v1_tender.rb,
lib/square_connect/api/apple_pay_api.rb,
lib/square_connect/api/customers_api.rb,
lib/square_connect/api/locations_api.rb,
lib/square_connect/models/card_brand.rb,
lib/square_connect/models/error_code.rb,
lib/square_connect/models/sort_order.rb,
lib/square_connect/models/v1_payment.rb,
lib/square_connect/models/catalog_tax.rb,
lib/square_connect/models/tender_type.rb,
lib/square_connect/models/transaction.rb,
lib/square_connect/models/v1_category.rb,
lib/square_connect/models/v1_discount.rb,
lib/square_connect/models/v1_employee.rb,
lib/square_connect/models/v1_merchant.rb,
lib/square_connect/models/v1_timecard.rb,
lib/square_connect/models/catalog_item.rb,
lib/square_connect/models/v1_page_cell.rb,
lib/square_connect/models/v1_variation.rb,
lib/square_connect/api/transactions_api.rb,
lib/square_connect/api/v1_employees_api.rb,
lib/square_connect/api/v1_locations_api.rb,
lib/square_connect/models/catalog_query.rb,
lib/square_connect/models/catalog_v1_id.rb,
lib/square_connect/models/location_type.rb,
lib/square_connect/models/refund_status.rb,
lib/square_connect/models/v1_item_image.rb,
lib/square_connect/models/v1_settlement.rb,
lib/square_connect/models/catalog_object.rb,
lib/square_connect/models/charge_request.rb,
lib/square_connect/models/error_category.rb,
lib/square_connect/models/v1_payment_tax.rb,
lib/square_connect/models/charge_response.rb,
lib/square_connect/models/location_status.rb,
lib/square_connect/models/order_line_item.rb,
lib/square_connect/models/v1_bank_account.rb,
lib/square_connect/models/v1_phone_number.rb,
lib/square_connect/api/v1_transactions_api.rb,
lib/square_connect/models/catalog_category.rb,
lib/square_connect/models/catalog_discount.rb,
lib/square_connect/models/catalog_modifier.rb,
lib/square_connect/models/v1_employee_role.rb,
lib/square_connect/models/v1_modifier_list.rb,
lib/square_connect/models/v1_timecard_event.rb,
lib/square_connect/models/catalog_id_mapping.rb,
lib/square_connect/models/catalog_query_text.rb,
lib/square_connect/models/tax_inclusion_type.rb,
lib/square_connect/models/v1_inventory_entry.rb,
lib/square_connect/models/v1_modifier_option.rb,
lib/square_connect/models/catalog_object_type.rb,
lib/square_connect/models/catalog_query_exact.rb,
lib/square_connect/models/catalog_query_range.rb,
lib/square_connect/models/customer_group_info.rb,
lib/square_connect/models/location_capability.rb,
lib/square_connect/models/order_line_item_tax.rb,
lib/square_connect/models/tender_card_details.rb,
lib/square_connect/models/tender_cash_details.rb,
lib/square_connect/models/transaction_product.rb,
lib/square_connect/models/v1_payment_discount.rb,
lib/square_connect/models/v1_payment_modifier.rb,
lib/square_connect/models/v1_settlement_entry.rb,
lib/square_connect/models/catalog_info_request.rb,
lib/square_connect/models/catalog_object_batch.rb,
lib/square_connect/models/catalog_pricing_type.rb,
lib/square_connect/models/catalog_query_prefix.rb,
lib/square_connect/models/create_order_request.rb,
lib/square_connect/models/customer_preferences.rb,
lib/square_connect/models/inventory_alert_type.rb,
lib/square_connect/models/list_catalog_request.rb,
lib/square_connect/models/list_refunds_request.rb,
lib/square_connect/models/v1_cash_drawer_event.rb,
lib/square_connect/models/v1_cash_drawer_shift.rb,
lib/square_connect/models/catalog_discount_type.rb,
lib/square_connect/models/catalog_info_response.rb,
lib/square_connect/models/catalog_modifier_list.rb,
lib/square_connect/models/create_order_response.rb,
lib/square_connect/models/create_refund_request.rb,
lib/square_connect/models/list_catalog_response.rb,
lib/square_connect/models/list_refunds_response.rb,
lib/square_connect/models/tax_calculation_phase.rb,
lib/square_connect/models/catalog_item_variation.rb,
lib/square_connect/models/create_refund_response.rb,
lib/square_connect/models/list_customers_request.rb,
lib/square_connect/models/list_locations_request.rb,
lib/square_connect/models/v1_order_history_entry.rb,
lib/square_connect/models/v1_payment_item_detail.rb,
lib/square_connect/models/v1_payment_itemization.rb,
lib/square_connect/models/create_checkout_request.rb,
lib/square_connect/models/create_customer_request.rb,
lib/square_connect/models/delete_customer_request.rb,
lib/square_connect/models/list_customers_response.rb,
lib/square_connect/models/list_locations_response.rb,
lib/square_connect/models/register_domain_request.rb,
lib/square_connect/models/update_customer_request.rb,
lib/square_connect/models/v1_update_order_request.rb,
lib/square_connect/models/create_checkout_response.rb,
lib/square_connect/models/create_customer_response.rb,
lib/square_connect/models/create_order_request_tax.rb,
lib/square_connect/models/delete_customer_response.rb,
lib/square_connect/models/order_line_item_discount.rb,
lib/square_connect/models/order_line_item_modifier.rb,
lib/square_connect/models/order_line_item_tax_type.rb,
lib/square_connect/models/register_domain_response.rb,
lib/square_connect/models/update_customer_response.rb,
lib/square_connect/models/v1_create_refund_request.rb,
lib/square_connect/models/void_transaction_request.rb,
lib/square_connect/models/catalog_item_product_type.rb,
lib/square_connect/models/catalog_modifier_override.rb,
lib/square_connect/models/list_transactions_request.rb,
lib/square_connect/models/retrieve_customer_request.rb,
lib/square_connect/models/update_item_taxes_request.rb,
lib/square_connect/models/void_transaction_response.rb,
lib/square_connect/models/list_transactions_response.rb,
lib/square_connect/models/retrieve_customer_response.rb,
lib/square_connect/models/tender_card_details_status.rb,
lib/square_connect/models/update_item_taxes_response.rb,
lib/square_connect/models/capture_transaction_request.rb,
lib/square_connect/models/catalog_query_items_for_tax.rb,
lib/square_connect/models/v1_adjust_inventory_request.rb,
lib/square_connect/models/capture_transaction_response.rb,
lib/square_connect/models/catalog_info_response_limits.rb,
lib/square_connect/models/create_customer_card_request.rb,
lib/square_connect/models/delete_customer_card_request.rb,
lib/square_connect/models/retrieve_transaction_request.rb,
lib/square_connect/models/v1_merchant_location_details.rb,
lib/square_connect/models/batch_retrieve_orders_request.rb,
lib/square_connect/models/create_customer_card_response.rb,
lib/square_connect/models/create_order_request_discount.rb,
lib/square_connect/models/create_order_request_modifier.rb,
lib/square_connect/models/delete_catalog_object_request.rb,
lib/square_connect/models/delete_customer_card_response.rb,
lib/square_connect/models/order_line_item_discount_type.rb,
lib/square_connect/models/retrieve_transaction_response.rb,
lib/square_connect/models/upsert_catalog_object_request.rb,
lib/square_connect/models/batch_retrieve_orders_response.rb,
lib/square_connect/models/catalog_query_sorted_attribute.rb,
lib/square_connect/models/create_order_request_line_item.rb,
lib/square_connect/models/delete_catalog_object_response.rb,
lib/square_connect/models/order_line_item_discount_scope.rb,
lib/square_connect/models/search_catalog_objects_request.rb,
lib/square_connect/models/upsert_catalog_object_response.rb,
lib/square_connect/models/catalog_item_modifier_list_info.rb,
lib/square_connect/models/register_domain_response_status.rb,
lib/square_connect/models/retrieve_catalog_object_request.rb,
lib/square_connect/models/search_catalog_objects_response.rb,
lib/square_connect/models/v1_update_modifier_list_request.rb,
lib/square_connect/models/retrieve_catalog_object_response.rb,
lib/square_connect/models/tender_card_details_entry_method.rb,
lib/square_connect/models/item_variation_location_overrides.rb,
lib/square_connect/models/update_item_modifier_lists_request.rb,
lib/square_connect/models/update_item_modifier_lists_response.rb,
lib/square_connect/models/batch_delete_catalog_objects_request.rb,
lib/square_connect/models/batch_upsert_catalog_objects_request.rb,
lib/square_connect/models/catalog_modifier_list_selection_type.rb,
lib/square_connect/models/batch_delete_catalog_objects_response.rb,
lib/square_connect/models/batch_upsert_catalog_objects_response.rb,
lib/square_connect/models/catalog_query_items_for_modifier_list.rb,
lib/square_connect/models/batch_retrieve_catalog_objects_request.rb,
lib/square_connect/models/batch_retrieve_catalog_objects_response.rb

Overview

#Square Connect API

OpenAPI spec version: 2.0 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git

Defined Under Namespace

Classes: Address, ApiClient, ApiError, ApplePayApi, BatchDeleteCatalogObjectsRequest, BatchDeleteCatalogObjectsResponse, BatchRetrieveCatalogObjectsRequest, BatchRetrieveCatalogObjectsResponse, BatchRetrieveOrdersRequest, BatchRetrieveOrdersResponse, BatchUpsertCatalogObjectsRequest, BatchUpsertCatalogObjectsResponse, CaptureTransactionRequest, CaptureTransactionResponse, Card, CardBrand, CatalogApi, CatalogCategory, CatalogDiscount, CatalogDiscountType, CatalogIdMapping, CatalogInfoRequest, CatalogInfoResponse, CatalogInfoResponseLimits, CatalogItem, CatalogItemModifierListInfo, CatalogItemProductType, CatalogItemVariation, CatalogModifier, CatalogModifierList, CatalogModifierListSelectionType, CatalogModifierOverride, CatalogObject, CatalogObjectBatch, CatalogObjectType, CatalogPricingType, CatalogQuery, CatalogQueryExact, CatalogQueryItemsForModifierList, CatalogQueryItemsForTax, CatalogQueryPrefix, CatalogQueryRange, CatalogQuerySortedAttribute, CatalogQueryText, CatalogTax, CatalogV1Id, ChargeRequest, ChargeResponse, Checkout, CheckoutApi, Configuration, Country, CreateCheckoutRequest, CreateCheckoutResponse, CreateCustomerCardRequest, CreateCustomerCardResponse, CreateCustomerRequest, CreateCustomerResponse, CreateOrderRequest, CreateOrderRequestDiscount, CreateOrderRequestLineItem, CreateOrderRequestModifier, CreateOrderRequestTax, CreateOrderResponse, CreateRefundRequest, CreateRefundResponse, Currency, Customer, CustomerGroupInfo, CustomerPreferences, CustomersApi, DeleteCatalogObjectRequest, DeleteCatalogObjectResponse, DeleteCustomerCardRequest, DeleteCustomerCardResponse, DeleteCustomerRequest, DeleteCustomerResponse, Device, Error, ErrorCategory, ErrorCode, InventoryAlertType, ItemVariationLocationOverrides, ListCatalogRequest, ListCatalogResponse, ListCustomersRequest, ListCustomersResponse, ListLocationsRequest, ListLocationsResponse, ListRefundsRequest, ListRefundsResponse, ListTransactionsRequest, ListTransactionsResponse, Location, LocationCapability, LocationStatus, LocationType, LocationsApi, Money, Order, OrderLineItem, OrderLineItemDiscount, OrderLineItemDiscountScope, OrderLineItemDiscountType, OrderLineItemModifier, OrderLineItemTax, OrderLineItemTaxType, OrdersApi, Refund, RefundStatus, RegisterDomainRequest, RegisterDomainResponse, RegisterDomainResponseStatus, RetrieveCatalogObjectRequest, RetrieveCatalogObjectResponse, RetrieveCustomerRequest, RetrieveCustomerResponse, RetrieveTransactionRequest, RetrieveTransactionResponse, SearchCatalogObjectsRequest, SearchCatalogObjectsResponse, SortOrder, TaxCalculationPhase, TaxInclusionType, Tender, TenderCardDetails, TenderCardDetailsEntryMethod, TenderCardDetailsStatus, TenderCashDetails, TenderType, Transaction, TransactionProduct, TransactionsApi, UpdateCustomerRequest, UpdateCustomerResponse, UpdateItemModifierListsRequest, UpdateItemModifierListsResponse, UpdateItemTaxesRequest, UpdateItemTaxesResponse, UpsertCatalogObjectRequest, UpsertCatalogObjectResponse, V1AdjustInventoryRequest, V1BankAccount, V1CashDrawerEvent, V1CashDrawerShift, V1Category, V1CreateRefundRequest, V1Discount, V1Employee, V1EmployeeRole, V1EmployeesApi, V1Fee, V1InventoryEntry, V1Item, V1ItemImage, V1ItemsApi, V1LocationsApi, V1Merchant, V1MerchantLocationDetails, V1ModifierList, V1ModifierOption, V1Money, V1Order, V1OrderHistoryEntry, V1Page, V1PageCell, V1Payment, V1PaymentDiscount, V1PaymentItemDetail, V1PaymentItemization, V1PaymentModifier, V1PaymentTax, V1PhoneNumber, V1Refund, V1Settlement, V1SettlementEntry, V1Tender, V1Timecard, V1TimecardEvent, V1TransactionsApi, V1UpdateModifierListRequest, V1UpdateOrderRequest, V1Variation, VoidTransactionRequest, VoidTransactionResponse

Constant Summary collapse

VERSION = 
"2.4.0"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

SquareConnect.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



210
211
212
213
214
215
216
 
# File 'lib/square_connect.rb', line 210

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end