Table of Contents - square.rb-19.0.0.20220420 Documentation
Classes and Modules
- Square
- Square::APIException
- Square::APIHelper
- Square::ApiResponse
- Square::ApplePayApi
- Square::BankAccountsApi
- Square::BaseApi
- Square::BookingsApi
- Square::CardsApi
- Square::CashDrawersApi
- Square::CatalogApi
- Square::CheckoutApi
- Square::Client
- Square::Configuration
- Square::CustomerGroupsApi
- Square::CustomerSegmentsApi
- Square::CustomersApi
- Square::DateTimeHelper
- Square::DevicesApi
- Square::DisputesApi
- Square::EmployeesApi
- Square::FaradayClient
- Square::FileWrapper
- Square::GiftCardActivitiesApi
- Square::GiftCardsApi
- Square::HttpCallBack
- Square::HttpClient
- Square::HttpMethodEnum
- Square::HttpRequest
- Square::HttpResponse
- Square::InventoryApi
- Square::InvoicesApi
- Square::LaborApi
- Square::LocationsApi
- Square::LoyaltyApi
- Square::MerchantsApi
- Square::MobileAuthorizationApi
- Square::OAuth2
- Square::OAuthApi
- Square::OrdersApi
- Square::PaymentsApi
- Square::PayoutsApi
- Square::RefundsApi
- Square::SitesApi
- Square::SnippetsApi
- Square::SubscriptionsApi
- Square::TeamApi
- Square::TerminalApi
- Square::TransactionsApi
- Square::V1TransactionsApi
- Square::VendorsApi
Methods
- ::append_url_with_query_parameters — Square::APIHelper
- ::append_url_with_template_parameters — Square::APIHelper
- ::apply — Square::OAuth2
- ::clean_hash — Square::APIHelper
- ::clean_url — Square::APIHelper
- ::custom_merge — Square::APIHelper
- ::form_encode — Square::APIHelper
- ::form_encode_parameters — Square::APIHelper
- ::from_rfc1123 — Square::DateTimeHelper
- ::from_rfc3339 — Square::DateTimeHelper
- ::from_unix — Square::DateTimeHelper
- ::json_deserialize — Square::APIHelper
- ::map_response — Square::APIHelper
- ::new — Square::ApplePayApi
- ::new — Square::BankAccountsApi
- ::new — Square::BaseApi
- ::new — Square::BookingsApi
- ::new — Square::CardsApi
- ::new — Square::CashDrawersApi
- ::new — Square::CatalogApi
- ::new — Square::CheckoutApi
- ::new — Square::CustomerGroupsApi
- ::new — Square::CustomerSegmentsApi
- ::new — Square::CustomersApi
- ::new — Square::DevicesApi
- ::new — Square::DisputesApi
- ::new — Square::EmployeesApi
- ::new — Square::GiftCardActivitiesApi
- ::new — Square::GiftCardsApi
- ::new — Square::InventoryApi
- ::new — Square::InvoicesApi
- ::new — Square::LaborApi
- ::new — Square::LocationsApi
- ::new — Square::LoyaltyApi
- ::new — Square::MerchantsApi
- ::new — Square::MobileAuthorizationApi
- ::new — Square::OAuthApi
- ::new — Square::OrdersApi
- ::new — Square::PaymentsApi
- ::new — Square::PayoutsApi
- ::new — Square::RefundsApi
- ::new — Square::SitesApi
- ::new — Square::SnippetsApi
- ::new — Square::SubscriptionsApi
- ::new — Square::TeamApi
- ::new — Square::TerminalApi
- ::new — Square::TransactionsApi
- ::new — Square::V1TransactionsApi
- ::new — Square::VendorsApi
- ::new — Square::Client
- ::new — Square::Configuration
- ::new — Square::APIException
- ::new — Square::ApiResponse
- ::new — Square::FaradayClient
- ::new — Square::HttpRequest
- ::new — Square::HttpResponse
- ::new — Square::FileWrapper
- ::process_complex_types_parameters — Square::APIHelper
- ::serialize_array — Square::APIHelper
- ::to_rfc1123 — Square::DateTimeHelper
- ::to_rfc1123_array — Square::DateTimeHelper
- ::to_rfc1123_map — Square::DateTimeHelper
- ::to_rfc3339 — Square::DateTimeHelper
- ::to_rfc3339_array — Square::DateTimeHelper
- ::to_rfc3339_map — Square::DateTimeHelper
- ::to_unix — Square::DateTimeHelper
- ::to_unix_array — Square::DateTimeHelper
- ::to_unix_map — Square::DateTimeHelper
- #accept_dispute — Square::DisputesApi
- #accumulate_loyalty_points — Square::LoyaltyApi
- #add_group_to_customer — Square::CustomersApi
- #add_header — Square::HttpRequest
- #add_parameter — Square::HttpRequest
- #add_query_parameter — Square::HttpRequest
- #additional_headers — Square::Configuration
- #adjust_loyalty_points — Square::LoyaltyApi
- #apple_pay — Square::Client
- #bank_accounts — Square::Client
- #batch_change_inventory — Square::InventoryApi
- #batch_delete_catalog_objects — Square::CatalogApi
- #batch_retrieve_catalog_objects — Square::CatalogApi
- #batch_retrieve_inventory_changes — Square::InventoryApi
- #batch_retrieve_inventory_counts — Square::InventoryApi
- #batch_retrieve_orders — Square::OrdersApi
- #batch_upsert_catalog_objects — Square::CatalogApi
- #bookings — Square::Client
- #bulk_create_team_members — Square::TeamApi
- #bulk_create_vendors — Square::VendorsApi
- #bulk_retrieve_vendors — Square::VendorsApi
- #bulk_update_team_members — Square::TeamApi
- #bulk_update_vendors — Square::VendorsApi
- #calculate_loyalty_points — Square::LoyaltyApi
- #calculate_order — Square::OrdersApi
- #cancel_booking — Square::BookingsApi
- #cancel_invoice — Square::InvoicesApi
- #cancel_payment — Square::PaymentsApi
- #cancel_payment_by_idempotency_key — Square::PaymentsApi
- #cancel_subscription — Square::SubscriptionsApi
- #cancel_terminal_checkout — Square::TerminalApi
- #cancel_terminal_refund — Square::TerminalApi
- #capture_transaction — Square::TransactionsApi
- #cards — Square::Client
- #cash_drawers — Square::Client
- #catalog — Square::Client
- #catalog_info — Square::CatalogApi
- #checkout — Square::Client
- #clone_order — Square::OrdersApi
- #clone_with — Square::Configuration
- #complete_payment — Square::PaymentsApi
- #convert_response — Square::FaradayClient
- #convert_response — Square::HttpClient
- #create_booking — Square::BookingsApi
- #create_break_type — Square::LaborApi
- #create_card — Square::CardsApi
- #create_catalog_image — Square::CatalogApi
- #create_checkout — Square::CheckoutApi
- #create_connection — Square::FaradayClient
- #create_customer — Square::CustomersApi
- #create_customer_card — Square::CustomersApi
- #create_customer_group — Square::CustomerGroupsApi
- #create_device_code — Square::DevicesApi
- #create_dispute_evidence_file — Square::DisputesApi
- #create_dispute_evidence_text — Square::DisputesApi
- #create_gift_card — Square::GiftCardsApi
- #create_gift_card_activity — Square::GiftCardActivitiesApi
- #create_http_client — Square::Configuration
- #create_invoice — Square::InvoicesApi
- #create_location — Square::LocationsApi
- #create_loyalty_account — Square::LoyaltyApi
- #create_loyalty_reward — Square::LoyaltyApi
- #create_mobile_authorization_code — Square::MobileAuthorizationApi
- #create_order — Square::OrdersApi
- #create_payment — Square::PaymentsApi
- #create_refund — Square::V1TransactionsApi
- #create_shift — Square::LaborApi
- #create_subscription — Square::SubscriptionsApi
- #create_team_member — Square::TeamApi
- #create_terminal_checkout — Square::TerminalApi
- #create_terminal_refund — Square::TerminalApi
- #create_vendor — Square::VendorsApi
- #customer_groups — Square::Client
- #customer_segments — Square::Client
- #customers — Square::Client
- #delete — Square::HttpClient
- #delete_break_type — Square::LaborApi
- #delete_catalog_object — Square::CatalogApi
- #delete_customer — Square::CustomersApi
- #delete_customer_card — Square::CustomersApi
- #delete_customer_group — Square::CustomerGroupsApi
- #delete_dispute_evidence — Square::DisputesApi
- #delete_invoice — Square::InvoicesApi
- #delete_loyalty_reward — Square::LoyaltyApi
- #delete_shift — Square::LaborApi
- #delete_snippet — Square::SnippetsApi
- #delete_subscription_action — Square::SubscriptionsApi
- #deprecated_batch_change_inventory — Square::InventoryApi
- #deprecated_batch_retrieve_inventory_changes — Square::InventoryApi
- #deprecated_batch_retrieve_inventory_counts — Square::InventoryApi
- #deprecated_retrieve_inventory_adjustment — Square::InventoryApi
- #deprecated_retrieve_inventory_physical_count — Square::InventoryApi
- #devices — Square::Client
- #disable_card — Square::CardsApi
- #disputes — Square::Client
- #employees — Square::Client
- #error? — Square::ApiResponse
- #execute_as_binary — Square::FaradayClient
- #execute_as_binary — Square::HttpClient
- #execute_as_string — Square::FaradayClient
- #execute_as_string — Square::HttpClient
- #execute_request — Square::BaseApi
- #get — Square::HttpClient
- #get_bank_account — Square::BankAccountsApi
- #get_bank_account_by_v1_id — Square::BankAccountsApi
- #get_base_uri — Square::Configuration
- #get_break_type — Square::LaborApi
- #get_device_code — Square::DevicesApi
- #get_employee_wage — Square::LaborApi
- #get_invoice — Square::InvoicesApi
- #get_payment — Square::PaymentsApi
- #get_payment_refund — Square::RefundsApi
- #get_payout — Square::PayoutsApi
- #get_shift — Square::LaborApi
- #get_team_member_wage — Square::LaborApi
- #get_terminal_checkout — Square::TerminalApi
- #get_terminal_refund — Square::TerminalApi
- #get_user_agent — Square::BaseApi
- #get_user_agent — Square::Configuration
- #gift_card_activities — Square::Client
- #gift_cards — Square::Client
- #head — Square::HttpClient
- #inventory — Square::Client
- #invoices — Square::Client
- #labor — Square::Client
- #link_customer_to_gift_card — Square::GiftCardsApi
- #list_bank_accounts — Square::BankAccountsApi
- #list_bookings — Square::BookingsApi
- #list_break_types — Square::LaborApi
- #list_cards — Square::CardsApi
- #list_cash_drawer_shift_events — Square::CashDrawersApi
- #list_cash_drawer_shifts — Square::CashDrawersApi
- #list_catalog — Square::CatalogApi
- #list_customer_groups — Square::CustomerGroupsApi
- #list_customer_segments — Square::CustomerSegmentsApi
- #list_customers — Square::CustomersApi
- #list_device_codes — Square::DevicesApi
- #list_dispute_evidence — Square::DisputesApi
- #list_disputes — Square::DisputesApi
- #list_employee_wages — Square::LaborApi
- #list_employees — Square::EmployeesApi
- #list_gift_card_activities — Square::GiftCardActivitiesApi
- #list_gift_cards — Square::GiftCardsApi
- #list_invoices — Square::InvoicesApi
- #list_locations — Square::LocationsApi
- #list_loyalty_programs — Square::LoyaltyApi
- #list_merchants — Square::MerchantsApi
- #list_orders — Square::V1TransactionsApi
- #list_payment_refunds — Square::RefundsApi
- #list_payments — Square::PaymentsApi
- #list_payments — Square::V1TransactionsApi
- #list_payout_entries — Square::PayoutsApi
- #list_payouts — Square::PayoutsApi
- #list_refunds — Square::V1TransactionsApi
- #list_settlements — Square::V1TransactionsApi
- #list_sites — Square::SitesApi
- #list_subscription_events — Square::SubscriptionsApi
- #list_team_member_booking_profiles — Square::BookingsApi
- #list_team_member_wages — Square::LaborApi
- #list_transactions — Square::TransactionsApi
- #list_workweek_configs — Square::LaborApi
- #locations — Square::Client
- #loyalty — Square::Client
- #merchants — Square::Client
- #mobile_authorization — Square::Client
- #o_auth — Square::Client
- #obtain_token — Square::OAuthApi
- #on_after_response — Square::HttpCallBack
- #on_before_request — Square::HttpCallBack
- #orders — Square::Client
- #patch — Square::HttpClient
- #pause_subscription — Square::SubscriptionsApi
- #pay_order — Square::OrdersApi
- #payments — Square::Client
- #payouts — Square::Client
- #post — Square::HttpClient
- #publish_invoice — Square::InvoicesApi
- #put — Square::HttpClient
- #redeem_loyalty_reward — Square::LoyaltyApi
- #refund_payment — Square::RefundsApi
- #refunds — Square::Client
- #register_domain — Square::ApplePayApi
- #remove_group_from_customer — Square::CustomersApi
- #renew_token — Square::OAuthApi
- #resume_subscription — Square::SubscriptionsApi
- #retrieve_booking — Square::BookingsApi
- #retrieve_business_booking_profile — Square::BookingsApi
- #retrieve_card — Square::CardsApi
- #retrieve_cash_drawer_shift — Square::CashDrawersApi
- #retrieve_catalog_object — Square::CatalogApi
- #retrieve_customer — Square::CustomersApi
- #retrieve_customer_group — Square::CustomerGroupsApi
- #retrieve_customer_segment — Square::CustomerSegmentsApi
- #retrieve_dispute — Square::DisputesApi
- #retrieve_dispute_evidence — Square::DisputesApi
- #retrieve_employee — Square::EmployeesApi
- #retrieve_gift_card — Square::GiftCardsApi
- #retrieve_gift_card_from_gan — Square::GiftCardsApi
- #retrieve_gift_card_from_nonce — Square::GiftCardsApi
- #retrieve_inventory_adjustment — Square::InventoryApi
- #retrieve_inventory_changes — Square::InventoryApi
- #retrieve_inventory_count — Square::InventoryApi
- #retrieve_inventory_physical_count — Square::InventoryApi
- #retrieve_inventory_transfer — Square::InventoryApi
- #retrieve_location — Square::LocationsApi
- #retrieve_loyalty_account — Square::LoyaltyApi
- #retrieve_loyalty_program — Square::LoyaltyApi
- #retrieve_loyalty_reward — Square::LoyaltyApi
- #retrieve_merchant — Square::MerchantsApi
- #retrieve_order — Square::OrdersApi
- #retrieve_order — Square::V1TransactionsApi
- #retrieve_payment — Square::V1TransactionsApi
- #retrieve_settlement — Square::V1TransactionsApi
- #retrieve_snippet — Square::SnippetsApi
- #retrieve_subscription — Square::SubscriptionsApi
- #retrieve_team_member — Square::TeamApi
- #retrieve_team_member_booking_profile — Square::BookingsApi
- #retrieve_transaction — Square::TransactionsApi
- #retrieve_vendor — Square::VendorsApi
- #retrieve_wage_setting — Square::TeamApi
- #revoke_token — Square::OAuthApi
- #sdk_version — Square::Client
- #search_availability — Square::BookingsApi
- #search_catalog_items — Square::CatalogApi
- #search_catalog_objects — Square::CatalogApi
- #search_customers — Square::CustomersApi
- #search_invoices — Square::InvoicesApi
- #search_loyalty_accounts — Square::LoyaltyApi
- #search_loyalty_events — Square::LoyaltyApi
- #search_loyalty_rewards — Square::LoyaltyApi
- #search_orders — Square::OrdersApi
- #search_shifts — Square::LaborApi
- #search_subscriptions — Square::SubscriptionsApi
- #search_team_members — Square::TeamApi
- #search_terminal_checkouts — Square::TerminalApi
- #search_terminal_refunds — Square::TerminalApi
- #search_vendors — Square::VendorsApi
- #sites — Square::Client
- #snippets — Square::Client
- #square_version — Square::Client
- #submit_evidence — Square::DisputesApi
- #subscriptions — Square::Client
- #success? — Square::ApiResponse
- #swap_plan — Square::SubscriptionsApi
- #team — Square::Client
- #terminal — Square::Client
- #transactions — Square::Client
- #unlink_customer_from_gift_card — Square::GiftCardsApi
- #update_booking — Square::BookingsApi
- #update_break_type — Square::LaborApi
- #update_catalog_image — Square::CatalogApi
- #update_customer — Square::CustomersApi
- #update_customer_group — Square::CustomerGroupsApi
- #update_invoice — Square::InvoicesApi
- #update_item_modifier_lists — Square::CatalogApi
- #update_item_taxes — Square::CatalogApi
- #update_location — Square::LocationsApi
- #update_order — Square::OrdersApi
- #update_order — Square::V1TransactionsApi
- #update_payment — Square::PaymentsApi
- #update_shift — Square::LaborApi
- #update_subscription — Square::SubscriptionsApi
- #update_team_member — Square::TeamApi
- #update_vendor — Square::VendorsApi
- #update_wage_setting — Square::TeamApi
- #update_workweek_config — Square::LaborApi
- #upsert_catalog_object — Square::CatalogApi
- #upsert_snippet — Square::SnippetsApi
- #user_agent_detail — Square::Client
- #v1_transactions — Square::Client
- #validate_parameters — Square::BaseApi
- #vendors — Square::Client
- #void_transaction — Square::TransactionsApi