square.rb 44.0.0.20250820 → 44.0.1.20250820
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +62 -9
- data/lib/square/apple_pay/client.rb +12 -6
- data/lib/square/bank_accounts/client.rb +40 -19
- data/lib/square/bookings/client.rb +124 -62
- data/lib/square/bookings/custom_attribute_definitions/client.rb +68 -32
- data/lib/square/bookings/custom_attributes/client.rb +80 -38
- data/lib/square/bookings/location_profiles/client.rb +16 -7
- data/lib/square/bookings/team_member_profiles/client.rb +28 -13
- data/lib/square/cards/client.rb +53 -24
- data/lib/square/cash_drawers/shifts/client.rb +48 -21
- data/lib/square/catalog/client.rb +112 -55
- data/lib/square/catalog/images/client.rb +22 -10
- data/lib/square/catalog/object/client.rb +40 -19
- data/lib/square/catalog/object/types/delete_object_request.rb +1 -1
- data/lib/square/catalog/object/types/get_object_request.rb +1 -1
- data/lib/square/checkout/client.rb +48 -24
- data/lib/square/checkout/payment_links/client.rb +64 -31
- data/lib/square/client.rb +1 -1
- data/lib/square/customers/cards/client.rb +24 -12
- data/lib/square/customers/client.rb +128 -62
- data/lib/square/customers/custom_attribute_definitions/client.rb +80 -38
- data/lib/square/customers/custom_attributes/client.rb +56 -26
- data/lib/square/customers/groups/client.rb +88 -43
- data/lib/square/customers/segments/client.rb +28 -13
- data/lib/square/devices/client.rb +28 -13
- data/lib/square/devices/codes/client.rb +40 -19
- data/lib/square/disputes/client.rb +75 -36
- data/lib/square/disputes/evidence/client.rb +40 -19
- data/lib/square/employees/client.rb +28 -13
- data/lib/square/errors/api_error.rb +8 -0
- data/lib/square/errors/client_error.rb +17 -0
- data/lib/square/errors/redirect_error.rb +8 -0
- data/lib/square/errors/response_error.rb +42 -0
- data/lib/square/errors/server_error.rb +11 -0
- data/lib/square/errors/timeout_error.rb +8 -0
- data/lib/square/events/client.rb +52 -25
- data/lib/square/gift_cards/activities/client.rb +28 -14
- data/lib/square/gift_cards/client.rb +88 -43
- data/lib/square/inventory/client.rb +164 -80
- data/lib/square/invoices/client.rb +127 -61
- data/lib/square/labor/break_types/client.rb +64 -31
- data/lib/square/labor/client.rb +132 -66
- data/lib/square/labor/employee_wages/client.rb +28 -13
- data/lib/square/labor/shifts/client.rb +60 -30
- data/lib/square/labor/team_member_wages/client.rb +28 -13
- data/lib/square/labor/workweek_configs/client.rb +28 -13
- data/lib/square/locations/client.rb +60 -30
- data/lib/square/locations/custom_attribute_definitions/client.rb +68 -32
- data/lib/square/locations/custom_attributes/client.rb +80 -38
- data/lib/square/locations/transactions/client.rb +52 -25
- data/lib/square/loyalty/accounts/client.rb +60 -30
- data/lib/square/loyalty/client.rb +12 -6
- data/lib/square/loyalty/programs/client.rb +36 -18
- data/lib/square/loyalty/programs/promotions/client.rb +52 -25
- data/lib/square/loyalty/rewards/client.rb +60 -30
- data/lib/square/merchants/client.rb +28 -13
- data/lib/square/merchants/custom_attribute_definitions/client.rb +68 -32
- data/lib/square/merchants/custom_attributes/client.rb +80 -38
- data/lib/square/mobile/client.rb +12 -6
- data/lib/square/o_auth/client.rb +46 -22
- data/lib/square/orders/client.rb +98 -46
- data/lib/square/orders/custom_attribute_definitions/client.rb +68 -32
- data/lib/square/orders/custom_attributes/client.rb +80 -38
- data/lib/square/payments/client.rb +90 -44
- data/lib/square/payouts/client.rb +44 -20
- data/lib/square/refunds/client.rb +42 -20
- data/lib/square/sites/client.rb +12 -6
- data/lib/square/snippets/client.rb +36 -18
- data/lib/square/subscriptions/client.rb +153 -73
- data/lib/square/team/client.rb +53 -24
- data/lib/square/team_members/client.rb +72 -36
- data/lib/square/team_members/wage_setting/client.rb +24 -12
- data/lib/square/terminal/actions/client.rb +48 -24
- data/lib/square/terminal/checkouts/client.rb +48 -24
- data/lib/square/terminal/client.rb +36 -18
- data/lib/square/terminal/refunds/client.rb +48 -24
- data/lib/square/types/action_cancel_reason.rb +2 -1
- data/lib/square/types/activity_type.rb +2 -1
- data/lib/square/types/application_details_external_square_product.rb +2 -1
- data/lib/square/types/archived_state.rb +2 -1
- data/lib/square/types/bank_account_status.rb +2 -1
- data/lib/square/types/bank_account_type.rb +2 -1
- data/lib/square/types/booking_booking_source.rb +2 -1
- data/lib/square/types/booking_creator_details_creator_type.rb +2 -1
- data/lib/square/types/booking_status.rb +2 -1
- data/lib/square/types/business_appointment_settings_alignment_time.rb +2 -1
- data/lib/square/types/business_appointment_settings_booking_location_type.rb +2 -1
- data/lib/square/types/business_appointment_settings_cancellation_policy.rb +2 -1
- data/lib/square/types/business_appointment_settings_max_appointments_per_day_limit_type.rb +2 -1
- data/lib/square/types/business_booking_profile_booking_policy.rb +2 -1
- data/lib/square/types/business_booking_profile_customer_timezone_choice.rb +2 -1
- data/lib/square/types/card_brand.rb +2 -1
- data/lib/square/types/card_co_brand.rb +2 -1
- data/lib/square/types/card_prepaid_type.rb +2 -1
- data/lib/square/types/card_type.rb +2 -1
- data/lib/square/types/cash_drawer_event_type.rb +2 -1
- data/lib/square/types/cash_drawer_shift_state.rb +2 -1
- data/lib/square/types/catalog_category_type.rb +2 -1
- data/lib/square/types/catalog_custom_attribute_definition_app_visibility.rb +2 -1
- data/lib/square/types/catalog_custom_attribute_definition_seller_visibility.rb +2 -1
- data/lib/square/types/catalog_custom_attribute_definition_type.rb +2 -1
- data/lib/square/types/catalog_discount_modify_tax_basis.rb +2 -1
- data/lib/square/types/catalog_discount_type.rb +2 -1
- data/lib/square/types/catalog_id_mapping.rb +1 -1
- data/lib/square/types/catalog_item_food_and_beverage_details_dietary_preference_standard_dietary_preference.rb +2 -1
- data/lib/square/types/catalog_item_food_and_beverage_details_dietary_preference_type.rb +2 -1
- data/lib/square/types/catalog_item_food_and_beverage_details_ingredient_standard_ingredient.rb +2 -1
- data/lib/square/types/catalog_item_product_type.rb +2 -1
- data/lib/square/types/catalog_modifier_list_modifier_type.rb +2 -1
- data/lib/square/types/catalog_modifier_list_selection_type.rb +2 -1
- data/lib/square/types/catalog_object_reference.rb +1 -1
- data/lib/square/types/catalog_object_type.rb +2 -1
- data/lib/square/types/catalog_pricing_type.rb +2 -1
- data/lib/square/types/catalog_quick_amount_type.rb +2 -1
- data/lib/square/types/catalog_quick_amounts_settings_option.rb +2 -1
- data/lib/square/types/change_timing.rb +2 -1
- data/lib/square/types/checkout_location_settings_branding_button_shape.rb +2 -1
- data/lib/square/types/checkout_location_settings_branding_header_type.rb +2 -1
- data/lib/square/types/checkout_options_payment_type.rb +2 -1
- data/lib/square/types/component_component_type.rb +2 -1
- data/lib/square/types/country.rb +2 -1
- data/lib/square/types/create_catalog_image_request.rb +1 -1
- data/lib/square/types/currency.rb +2 -1
- data/lib/square/types/custom_attribute_definition_visibility.rb +2 -1
- data/lib/square/types/customer_creation_source.rb +2 -1
- data/lib/square/types/customer_inclusion_exclusion.rb +2 -1
- data/lib/square/types/customer_sort_field.rb +2 -1
- data/lib/square/types/data_collection_options_input_type.rb +2 -1
- data/lib/square/types/day_of_week.rb +2 -1
- data/lib/square/types/destination_type.rb +2 -1
- data/lib/square/types/device_code_status.rb +2 -1
- data/lib/square/types/device_component_details_external_power.rb +2 -1
- data/lib/square/types/device_status_category.rb +2 -1
- data/lib/square/types/dispute_evidence_type.rb +2 -1
- data/lib/square/types/dispute_reason.rb +2 -1
- data/lib/square/types/dispute_state.rb +2 -1
- data/lib/square/types/ecom_visibility.rb +2 -1
- data/lib/square/types/employee_status.rb +2 -1
- data/lib/square/types/error_category.rb +2 -1
- data/lib/square/types/error_code.rb +2 -1
- data/lib/square/types/exclude_strategy.rb +2 -1
- data/lib/square/types/fulfillment_delivery_details_order_fulfillment_delivery_details_schedule_type.rb +2 -1
- data/lib/square/types/fulfillment_fulfillment_line_item_application.rb +2 -1
- data/lib/square/types/fulfillment_pickup_details_schedule_type.rb +2 -1
- data/lib/square/types/fulfillment_state.rb +2 -1
- data/lib/square/types/fulfillment_type.rb +2 -1
- data/lib/square/types/gift_card_activity_adjust_decrement_reason.rb +2 -1
- data/lib/square/types/gift_card_activity_adjust_increment_reason.rb +2 -1
- data/lib/square/types/gift_card_activity_clear_balance_reason.rb +2 -1
- data/lib/square/types/gift_card_activity_deactivate_reason.rb +2 -1
- data/lib/square/types/gift_card_activity_redeem_status.rb +2 -1
- data/lib/square/types/gift_card_activity_type.rb +2 -1
- data/lib/square/types/gift_card_gan_source.rb +2 -1
- data/lib/square/types/gift_card_status.rb +2 -1
- data/lib/square/types/gift_card_type.rb +2 -1
- data/lib/square/types/inventory_alert_type.rb +2 -1
- data/lib/square/types/inventory_change_type.rb +2 -1
- data/lib/square/types/inventory_state.rb +2 -1
- data/lib/square/types/invoice_attachment.rb +1 -1
- data/lib/square/types/invoice_automatic_payment_source.rb +2 -1
- data/lib/square/types/invoice_custom_field_placement.rb +2 -1
- data/lib/square/types/invoice_delivery_method.rb +2 -1
- data/lib/square/types/invoice_payment_reminder_status.rb +2 -1
- data/lib/square/types/invoice_request_method.rb +2 -1
- data/lib/square/types/invoice_request_type.rb +2 -1
- data/lib/square/types/invoice_status.rb +2 -1
- data/lib/square/types/job_assignment_pay_type.rb +2 -1
- data/lib/square/types/list_payment_refunds_request_sort_field.rb +2 -1
- data/lib/square/types/list_payments_request_sort_field.rb +2 -1
- data/lib/square/types/location_capability.rb +2 -1
- data/lib/square/types/location_status.rb +2 -1
- data/lib/square/types/location_type.rb +2 -1
- data/lib/square/types/loyalty_event_source.rb +2 -1
- data/lib/square/types/loyalty_event_type.rb +2 -1
- data/lib/square/types/loyalty_program_accrual_rule_tax_mode.rb +2 -1
- data/lib/square/types/loyalty_program_accrual_rule_type.rb +2 -1
- data/lib/square/types/loyalty_program_status.rb +2 -1
- data/lib/square/types/loyalty_promotion_incentive_type.rb +2 -1
- data/lib/square/types/loyalty_promotion_status.rb +2 -1
- data/lib/square/types/loyalty_promotion_trigger_limit_interval.rb +2 -1
- data/lib/square/types/loyalty_reward_status.rb +2 -1
- data/lib/square/types/measurement_unit_area.rb +2 -1
- data/lib/square/types/measurement_unit_length.rb +2 -1
- data/lib/square/types/measurement_unit_time.rb +2 -1
- data/lib/square/types/measurement_unit_unit_type.rb +2 -1
- data/lib/square/types/measurement_unit_volume.rb +2 -1
- data/lib/square/types/measurement_unit_weight.rb +2 -1
- data/lib/square/types/merchant_status.rb +2 -1
- data/lib/square/types/oauth_authorization_revoked_event_revoker_type.rb +2 -1
- data/lib/square/types/order_fulfillment_delivery_details_schedule_type.rb +2 -1
- data/lib/square/types/order_fulfillment_fulfillment_line_item_application.rb +2 -1
- data/lib/square/types/order_fulfillment_pickup_details_schedule_type.rb +2 -1
- data/lib/square/types/order_fulfillment_state.rb +2 -1
- data/lib/square/types/order_fulfillment_type.rb +2 -1
- data/lib/square/types/order_line_item_discount_scope.rb +2 -1
- data/lib/square/types/order_line_item_discount_type.rb +2 -1
- data/lib/square/types/order_line_item_item_type.rb +2 -1
- data/lib/square/types/order_line_item_tax_scope.rb +2 -1
- data/lib/square/types/order_line_item_tax_type.rb +2 -1
- data/lib/square/types/order_service_charge_calculation_phase.rb +2 -1
- data/lib/square/types/order_service_charge_scope.rb +2 -1
- data/lib/square/types/order_service_charge_treatment_type.rb +2 -1
- data/lib/square/types/order_service_charge_type.rb +2 -1
- data/lib/square/types/order_state.rb +2 -1
- data/lib/square/types/payment_options_delay_action.rb +2 -1
- data/lib/square/types/payout_fee_type.rb +2 -1
- data/lib/square/types/payout_status.rb +2 -1
- data/lib/square/types/payout_type.rb +2 -1
- data/lib/square/types/product.rb +2 -1
- data/lib/square/types/refund_status.rb +2 -1
- data/lib/square/types/register_domain_response_status.rb +2 -1
- data/lib/square/types/risk_evaluation_risk_level.rb +2 -1
- data/lib/square/types/scheduled_shift_filter_assignment_status.rb +2 -1
- data/lib/square/types/scheduled_shift_filter_scheduled_shift_status.rb +2 -1
- data/lib/square/types/scheduled_shift_notification_audience.rb +2 -1
- data/lib/square/types/scheduled_shift_sort_field.rb +2 -1
- data/lib/square/types/scheduled_shift_workday_matcher.rb +2 -1
- data/lib/square/types/search_catalog_items_request_stock_level.rb +2 -1
- data/lib/square/types/search_orders_sort_field.rb +2 -1
- data/lib/square/types/search_vendors_request_sort_field.rb +2 -1
- data/lib/square/types/shift_filter_status.rb +2 -1
- data/lib/square/types/shift_sort_field.rb +2 -1
- data/lib/square/types/shift_status.rb +2 -1
- data/lib/square/types/shift_workday_matcher.rb +2 -1
- data/lib/square/types/sort_order.rb +2 -1
- data/lib/square/types/subscription_action_type.rb +2 -1
- data/lib/square/types/subscription_cadence.rb +2 -1
- data/lib/square/types/subscription_event_info_code.rb +2 -1
- data/lib/square/types/subscription_event_subscription_event_type.rb +2 -1
- data/lib/square/types/subscription_pricing_type.rb +2 -1
- data/lib/square/types/subscription_status.rb +2 -1
- data/lib/square/types/tax_calculation_phase.rb +2 -1
- data/lib/square/types/tax_inclusion_type.rb +2 -1
- data/lib/square/types/team_member_assigned_locations_assignment_type.rb +2 -1
- data/lib/square/types/team_member_invitation_status.rb +2 -1
- data/lib/square/types/team_member_status.rb +2 -1
- data/lib/square/types/tender_bank_account_details_status.rb +2 -1
- data/lib/square/types/tender_buy_now_pay_later_details_brand.rb +2 -1
- data/lib/square/types/tender_buy_now_pay_later_details_status.rb +2 -1
- data/lib/square/types/tender_card_details_entry_method.rb +2 -1
- data/lib/square/types/tender_card_details_status.rb +2 -1
- data/lib/square/types/tender_square_account_details_status.rb +2 -1
- data/lib/square/types/tender_type.rb +2 -1
- data/lib/square/types/terminal_action_action_type.rb +2 -1
- data/lib/square/types/timecard_filter_status.rb +2 -1
- data/lib/square/types/timecard_sort_field.rb +2 -1
- data/lib/square/types/timecard_status.rb +2 -1
- data/lib/square/types/timecard_workday_matcher.rb +2 -1
- data/lib/square/types/transaction_product.rb +2 -1
- data/lib/square/types/transaction_type.rb +2 -1
- data/lib/square/types/v_1_order_history_entry_action.rb +2 -1
- data/lib/square/types/v_1_order_state.rb +2 -1
- data/lib/square/types/v_1_tender_card_brand.rb +2 -1
- data/lib/square/types/v_1_tender_entry_method.rb +2 -1
- data/lib/square/types/v_1_tender_type.rb +2 -1
- data/lib/square/types/v_1_update_order_request_action.rb +2 -1
- data/lib/square/types/vendor_status.rb +2 -1
- data/lib/square/types/visibility_filter.rb +2 -1
- data/lib/square/types/weekday.rb +2 -1
- data/lib/square/v_1_transactions/client.rb +40 -15
- data/lib/square/vendors/client.rb +84 -42
- data/lib/square/version.rb +5 -0
- data/lib/square/webhooks/event_types/client.rb +16 -7
- data/lib/square/webhooks/subscriptions/client.rb +88 -43
- data/lib/square.rb +7 -6
- data/test/square/integration/client_tests/test_catalog.rb +3 -0
- metadata +9 -2
@@ -17,23 +17,33 @@ module Square
|
|
17
17
|
#
|
18
18
|
# @return [Square::Types::ListPaymentsResponse]
|
19
19
|
def list(request_options: {}, **params)
|
20
|
-
_query_param_names =
|
21
|
-
|
20
|
+
_query_param_names = [
|
21
|
+
%w[begin_time end_time sort_order cursor location_id total last_4 card_brand limit
|
22
|
+
is_offline_payment offline_begin_time offline_end_time updated_at_begin_time updated_at_end_time sort_field],
|
23
|
+
%i[begin_time end_time sort_order cursor location_id total last_4 card_brand limit is_offline_payment
|
24
|
+
offline_begin_time offline_end_time updated_at_begin_time updated_at_end_time sort_field]
|
25
|
+
].flatten
|
22
26
|
_query = params.slice(*_query_param_names)
|
23
27
|
params.except(*_query_param_names)
|
24
28
|
|
25
29
|
_request = Square::Internal::JSON::Request.new(
|
26
|
-
base_url: request_options[:base_url] || Square::Environment::
|
30
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
27
31
|
method: "GET",
|
28
32
|
path: "v2/payments",
|
29
33
|
query: _query
|
30
34
|
)
|
31
|
-
|
32
|
-
|
33
|
-
|
35
|
+
begin
|
36
|
+
_response = @client.send(_request)
|
37
|
+
rescue Net::HTTPRequestTimeout
|
38
|
+
raise Square::Errors::TimeoutError
|
39
|
+
end
|
40
|
+
code = _response.code.to_i
|
41
|
+
if code.between?(200, 299)
|
42
|
+
Square::Types::ListPaymentsResponse.load(_response.body)
|
43
|
+
else
|
44
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
45
|
+
raise error_class.new(_response.body, code: code)
|
34
46
|
end
|
35
|
-
|
36
|
-
raise _response.body
|
37
47
|
end
|
38
48
|
|
39
49
|
# Creates a payment using the provided source. You can use this endpoint
|
@@ -48,17 +58,23 @@ module Square
|
|
48
58
|
# @return [Square::Types::CreatePaymentResponse]
|
49
59
|
def create(request_options: {}, **params)
|
50
60
|
_request = Square::Internal::JSON::Request.new(
|
51
|
-
base_url: request_options[:base_url] || Square::Environment::
|
61
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
52
62
|
method: "POST",
|
53
63
|
path: "v2/payments",
|
54
64
|
body: params
|
55
65
|
)
|
56
|
-
|
57
|
-
|
58
|
-
|
66
|
+
begin
|
67
|
+
_response = @client.send(_request)
|
68
|
+
rescue Net::HTTPRequestTimeout
|
69
|
+
raise Square::Errors::TimeoutError
|
70
|
+
end
|
71
|
+
code = _response.code.to_i
|
72
|
+
if code.between?(200, 299)
|
73
|
+
Square::Types::CreatePaymentResponse.load(_response.body)
|
74
|
+
else
|
75
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
76
|
+
raise error_class.new(_response.body, code: code)
|
59
77
|
end
|
60
|
-
|
61
|
-
raise _response.body
|
62
78
|
end
|
63
79
|
|
64
80
|
# Cancels (voids) a payment identified by the idempotency key that is specified in the
|
@@ -76,17 +92,23 @@ module Square
|
|
76
92
|
# @return [Square::Types::CancelPaymentByIdempotencyKeyResponse]
|
77
93
|
def cancel_by_idempotency_key(request_options: {}, **params)
|
78
94
|
_request = Square::Internal::JSON::Request.new(
|
79
|
-
base_url: request_options[:base_url] || Square::Environment::
|
95
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
80
96
|
method: "POST",
|
81
97
|
path: "v2/payments/cancel",
|
82
98
|
body: params
|
83
99
|
)
|
84
|
-
|
85
|
-
|
86
|
-
|
100
|
+
begin
|
101
|
+
_response = @client.send(_request)
|
102
|
+
rescue Net::HTTPRequestTimeout
|
103
|
+
raise Square::Errors::TimeoutError
|
104
|
+
end
|
105
|
+
code = _response.code.to_i
|
106
|
+
if code.between?(200, 299)
|
107
|
+
Square::Types::CancelPaymentByIdempotencyKeyResponse.load(_response.body)
|
108
|
+
else
|
109
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
110
|
+
raise error_class.new(_response.body, code: code)
|
87
111
|
end
|
88
|
-
|
89
|
-
raise _response.body
|
90
112
|
end
|
91
113
|
|
92
114
|
# Retrieves details for a specific payment.
|
@@ -94,16 +116,22 @@ module Square
|
|
94
116
|
# @return [Square::Types::GetPaymentResponse]
|
95
117
|
def get(request_options: {}, **params)
|
96
118
|
_request = Square::Internal::JSON::Request.new(
|
97
|
-
base_url: request_options[:base_url] || Square::Environment::
|
119
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
98
120
|
method: "GET",
|
99
121
|
path: "v2/payments/#{params[:payment_id]}"
|
100
122
|
)
|
101
|
-
|
102
|
-
|
103
|
-
|
123
|
+
begin
|
124
|
+
_response = @client.send(_request)
|
125
|
+
rescue Net::HTTPRequestTimeout
|
126
|
+
raise Square::Errors::TimeoutError
|
127
|
+
end
|
128
|
+
code = _response.code.to_i
|
129
|
+
if code.between?(200, 299)
|
130
|
+
Square::Types::GetPaymentResponse.load(_response.body)
|
131
|
+
else
|
132
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
133
|
+
raise error_class.new(_response.body, code: code)
|
104
134
|
end
|
105
|
-
|
106
|
-
raise _response.body
|
107
135
|
end
|
108
136
|
|
109
137
|
# Updates a payment with the APPROVED status.
|
@@ -114,17 +142,23 @@ module Square
|
|
114
142
|
_path_param_names = ["payment_id"]
|
115
143
|
|
116
144
|
_request = Square::Internal::JSON::Request.new(
|
117
|
-
base_url: request_options[:base_url] || Square::Environment::
|
145
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
118
146
|
method: "PUT",
|
119
147
|
path: "v2/payments/#{params[:payment_id]}",
|
120
148
|
body: params.except(*_path_param_names)
|
121
149
|
)
|
122
|
-
|
123
|
-
|
124
|
-
|
150
|
+
begin
|
151
|
+
_response = @client.send(_request)
|
152
|
+
rescue Net::HTTPRequestTimeout
|
153
|
+
raise Square::Errors::TimeoutError
|
154
|
+
end
|
155
|
+
code = _response.code.to_i
|
156
|
+
if code.between?(200, 299)
|
157
|
+
Square::Types::UpdatePaymentResponse.load(_response.body)
|
158
|
+
else
|
159
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
160
|
+
raise error_class.new(_response.body, code: code)
|
125
161
|
end
|
126
|
-
|
127
|
-
raise _response.body
|
128
162
|
end
|
129
163
|
|
130
164
|
# Cancels (voids) a payment. You can use this endpoint to cancel a payment with
|
@@ -133,16 +167,22 @@ module Square
|
|
133
167
|
# @return [Square::Types::CancelPaymentResponse]
|
134
168
|
def cancel(request_options: {}, **params)
|
135
169
|
_request = Square::Internal::JSON::Request.new(
|
136
|
-
base_url: request_options[:base_url] || Square::Environment::
|
170
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
137
171
|
method: "POST",
|
138
172
|
path: "v2/payments/#{params[:payment_id]}/cancel"
|
139
173
|
)
|
140
|
-
|
141
|
-
|
142
|
-
|
174
|
+
begin
|
175
|
+
_response = @client.send(_request)
|
176
|
+
rescue Net::HTTPRequestTimeout
|
177
|
+
raise Square::Errors::TimeoutError
|
178
|
+
end
|
179
|
+
code = _response.code.to_i
|
180
|
+
if code.between?(200, 299)
|
181
|
+
Square::Types::CancelPaymentResponse.load(_response.body)
|
182
|
+
else
|
183
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
184
|
+
raise error_class.new(_response.body, code: code)
|
143
185
|
end
|
144
|
-
|
145
|
-
raise _response.body
|
146
186
|
end
|
147
187
|
|
148
188
|
# Completes (captures) a payment.
|
@@ -155,17 +195,23 @@ module Square
|
|
155
195
|
_path_param_names = ["payment_id"]
|
156
196
|
|
157
197
|
_request = Square::Internal::JSON::Request.new(
|
158
|
-
base_url: request_options[:base_url] || Square::Environment::
|
198
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
159
199
|
method: "POST",
|
160
200
|
path: "v2/payments/#{params[:payment_id]}/complete",
|
161
201
|
body: params.except(*_path_param_names)
|
162
202
|
)
|
163
|
-
|
164
|
-
|
165
|
-
|
203
|
+
begin
|
204
|
+
_response = @client.send(_request)
|
205
|
+
rescue Net::HTTPRequestTimeout
|
206
|
+
raise Square::Errors::TimeoutError
|
207
|
+
end
|
208
|
+
code = _response.code.to_i
|
209
|
+
if code.between?(200, 299)
|
210
|
+
Square::Types::CompletePaymentResponse.load(_response.body)
|
211
|
+
else
|
212
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
213
|
+
raise error_class.new(_response.body, code: code)
|
166
214
|
end
|
167
|
-
|
168
|
-
raise _response.body
|
169
215
|
end
|
170
216
|
end
|
171
217
|
end
|
@@ -14,22 +14,31 @@ module Square
|
|
14
14
|
#
|
15
15
|
# @return [Square::Types::ListPayoutsResponse]
|
16
16
|
def list(request_options: {}, **params)
|
17
|
-
_query_param_names =
|
17
|
+
_query_param_names = [
|
18
|
+
%w[location_id status begin_time end_time sort_order cursor limit],
|
19
|
+
%i[location_id status begin_time end_time sort_order cursor limit]
|
20
|
+
].flatten
|
18
21
|
_query = params.slice(*_query_param_names)
|
19
22
|
params.except(*_query_param_names)
|
20
23
|
|
21
24
|
_request = Square::Internal::JSON::Request.new(
|
22
|
-
base_url: request_options[:base_url] || Square::Environment::
|
25
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
23
26
|
method: "GET",
|
24
27
|
path: "v2/payouts",
|
25
28
|
query: _query
|
26
29
|
)
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
+
begin
|
31
|
+
_response = @client.send(_request)
|
32
|
+
rescue Net::HTTPRequestTimeout
|
33
|
+
raise Square::Errors::TimeoutError
|
34
|
+
end
|
35
|
+
code = _response.code.to_i
|
36
|
+
if code.between?(200, 299)
|
37
|
+
Square::Types::ListPayoutsResponse.load(_response.body)
|
38
|
+
else
|
39
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
40
|
+
raise error_class.new(_response.body, code: code)
|
30
41
|
end
|
31
|
-
|
32
|
-
raise _response.body
|
33
42
|
end
|
34
43
|
|
35
44
|
# Retrieves details of a specific payout identified by a payout ID.
|
@@ -38,16 +47,22 @@ module Square
|
|
38
47
|
# @return [Square::Types::GetPayoutResponse]
|
39
48
|
def get(request_options: {}, **params)
|
40
49
|
_request = Square::Internal::JSON::Request.new(
|
41
|
-
base_url: request_options[:base_url] || Square::Environment::
|
50
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
42
51
|
method: "GET",
|
43
52
|
path: "v2/payouts/#{params[:payout_id]}"
|
44
53
|
)
|
45
|
-
|
46
|
-
|
47
|
-
|
54
|
+
begin
|
55
|
+
_response = @client.send(_request)
|
56
|
+
rescue Net::HTTPRequestTimeout
|
57
|
+
raise Square::Errors::TimeoutError
|
58
|
+
end
|
59
|
+
code = _response.code.to_i
|
60
|
+
if code.between?(200, 299)
|
61
|
+
Square::Types::GetPayoutResponse.load(_response.body)
|
62
|
+
else
|
63
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
64
|
+
raise error_class.new(_response.body, code: code)
|
48
65
|
end
|
49
|
-
|
50
|
-
raise _response.body
|
51
66
|
end
|
52
67
|
|
53
68
|
# Retrieves a list of all payout entries for a specific payout.
|
@@ -55,22 +70,31 @@ module Square
|
|
55
70
|
#
|
56
71
|
# @return [Square::Types::ListPayoutEntriesResponse]
|
57
72
|
def list_entries(request_options: {}, **params)
|
58
|
-
_query_param_names =
|
73
|
+
_query_param_names = [
|
74
|
+
%w[sort_order cursor limit],
|
75
|
+
%i[sort_order cursor limit]
|
76
|
+
].flatten
|
59
77
|
_query = params.slice(*_query_param_names)
|
60
78
|
params = params.except(*_query_param_names)
|
61
79
|
|
62
80
|
_request = Square::Internal::JSON::Request.new(
|
63
|
-
base_url: request_options[:base_url] || Square::Environment::
|
81
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
64
82
|
method: "GET",
|
65
83
|
path: "v2/payouts/#{params[:payout_id]}/payout-entries",
|
66
84
|
query: _query
|
67
85
|
)
|
68
|
-
|
69
|
-
|
70
|
-
|
86
|
+
begin
|
87
|
+
_response = @client.send(_request)
|
88
|
+
rescue Net::HTTPRequestTimeout
|
89
|
+
raise Square::Errors::TimeoutError
|
90
|
+
end
|
91
|
+
code = _response.code.to_i
|
92
|
+
if code.between?(200, 299)
|
93
|
+
Square::Types::ListPayoutEntriesResponse.load(_response.body)
|
94
|
+
else
|
95
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
96
|
+
raise error_class.new(_response.body, code: code)
|
71
97
|
end
|
72
|
-
|
73
|
-
raise _response.body
|
74
98
|
end
|
75
99
|
end
|
76
100
|
end
|
@@ -17,23 +17,33 @@ module Square
|
|
17
17
|
#
|
18
18
|
# @return [Square::Types::ListPaymentRefundsResponse]
|
19
19
|
def list(request_options: {}, **params)
|
20
|
-
_query_param_names =
|
21
|
-
|
20
|
+
_query_param_names = [
|
21
|
+
%w[begin_time end_time sort_order cursor location_id status source_type limit
|
22
|
+
updated_at_begin_time updated_at_end_time sort_field],
|
23
|
+
%i[begin_time end_time sort_order cursor location_id status source_type limit updated_at_begin_time
|
24
|
+
updated_at_end_time sort_field]
|
25
|
+
].flatten
|
22
26
|
_query = params.slice(*_query_param_names)
|
23
27
|
params.except(*_query_param_names)
|
24
28
|
|
25
29
|
_request = Square::Internal::JSON::Request.new(
|
26
|
-
base_url: request_options[:base_url] || Square::Environment::
|
30
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
27
31
|
method: "GET",
|
28
32
|
path: "v2/refunds",
|
29
33
|
query: _query
|
30
34
|
)
|
31
|
-
|
32
|
-
|
33
|
-
|
35
|
+
begin
|
36
|
+
_response = @client.send(_request)
|
37
|
+
rescue Net::HTTPRequestTimeout
|
38
|
+
raise Square::Errors::TimeoutError
|
39
|
+
end
|
40
|
+
code = _response.code.to_i
|
41
|
+
if code.between?(200, 299)
|
42
|
+
Square::Types::ListPaymentRefundsResponse.load(_response.body)
|
43
|
+
else
|
44
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
45
|
+
raise error_class.new(_response.body, code: code)
|
34
46
|
end
|
35
|
-
|
36
|
-
raise _response.body
|
37
47
|
end
|
38
48
|
|
39
49
|
# Refunds a payment. You can refund the entire payment amount or a
|
@@ -44,17 +54,23 @@ module Square
|
|
44
54
|
# @return [Square::Types::RefundPaymentResponse]
|
45
55
|
def refund_payment(request_options: {}, **params)
|
46
56
|
_request = Square::Internal::JSON::Request.new(
|
47
|
-
base_url: request_options[:base_url] || Square::Environment::
|
57
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
48
58
|
method: "POST",
|
49
59
|
path: "v2/refunds",
|
50
60
|
body: params
|
51
61
|
)
|
52
|
-
|
53
|
-
|
54
|
-
|
62
|
+
begin
|
63
|
+
_response = @client.send(_request)
|
64
|
+
rescue Net::HTTPRequestTimeout
|
65
|
+
raise Square::Errors::TimeoutError
|
66
|
+
end
|
67
|
+
code = _response.code.to_i
|
68
|
+
if code.between?(200, 299)
|
69
|
+
Square::Types::RefundPaymentResponse.load(_response.body)
|
70
|
+
else
|
71
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
72
|
+
raise error_class.new(_response.body, code: code)
|
55
73
|
end
|
56
|
-
|
57
|
-
raise _response.body
|
58
74
|
end
|
59
75
|
|
60
76
|
# Retrieves a specific refund using the `refund_id`.
|
@@ -62,16 +78,22 @@ module Square
|
|
62
78
|
# @return [Square::Types::GetPaymentRefundResponse]
|
63
79
|
def get(request_options: {}, **params)
|
64
80
|
_request = Square::Internal::JSON::Request.new(
|
65
|
-
base_url: request_options[:base_url] || Square::Environment::
|
81
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
66
82
|
method: "GET",
|
67
83
|
path: "v2/refunds/#{params[:refund_id]}"
|
68
84
|
)
|
69
|
-
|
70
|
-
|
71
|
-
|
85
|
+
begin
|
86
|
+
_response = @client.send(_request)
|
87
|
+
rescue Net::HTTPRequestTimeout
|
88
|
+
raise Square::Errors::TimeoutError
|
89
|
+
end
|
90
|
+
code = _response.code.to_i
|
91
|
+
if code.between?(200, 299)
|
92
|
+
Square::Types::GetPaymentRefundResponse.load(_response.body)
|
93
|
+
else
|
94
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
95
|
+
raise error_class.new(_response.body, code: code)
|
72
96
|
end
|
73
|
-
|
74
|
-
raise _response.body
|
75
97
|
end
|
76
98
|
end
|
77
99
|
end
|
data/lib/square/sites/client.rb
CHANGED
@@ -16,16 +16,22 @@ module Square
|
|
16
16
|
# @return [Square::Types::ListSitesResponse]
|
17
17
|
def list(request_options: {}, **_params)
|
18
18
|
_request = Square::Internal::JSON::Request.new(
|
19
|
-
base_url: request_options[:base_url] || Square::Environment::
|
19
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
20
20
|
method: "GET",
|
21
21
|
path: "v2/sites"
|
22
22
|
)
|
23
|
-
|
24
|
-
|
25
|
-
|
23
|
+
begin
|
24
|
+
_response = @client.send(_request)
|
25
|
+
rescue Net::HTTPRequestTimeout
|
26
|
+
raise Square::Errors::TimeoutError
|
27
|
+
end
|
28
|
+
code = _response.code.to_i
|
29
|
+
if code.between?(200, 299)
|
30
|
+
Square::Types::ListSitesResponse.load(_response.body)
|
31
|
+
else
|
32
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
33
|
+
raise error_class.new(_response.body, code: code)
|
26
34
|
end
|
27
|
-
|
28
|
-
raise _response.body
|
29
35
|
end
|
30
36
|
end
|
31
37
|
end
|
@@ -18,16 +18,22 @@ module Square
|
|
18
18
|
# @return [Square::Types::GetSnippetResponse]
|
19
19
|
def get(request_options: {}, **params)
|
20
20
|
_request = Square::Internal::JSON::Request.new(
|
21
|
-
base_url: request_options[:base_url] || Square::Environment::
|
21
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
22
22
|
method: "GET",
|
23
23
|
path: "v2/sites/#{params[:site_id]}/snippet"
|
24
24
|
)
|
25
|
-
|
26
|
-
|
27
|
-
|
25
|
+
begin
|
26
|
+
_response = @client.send(_request)
|
27
|
+
rescue Net::HTTPRequestTimeout
|
28
|
+
raise Square::Errors::TimeoutError
|
29
|
+
end
|
30
|
+
code = _response.code.to_i
|
31
|
+
if code.between?(200, 299)
|
32
|
+
Square::Types::GetSnippetResponse.load(_response.body)
|
33
|
+
else
|
34
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
35
|
+
raise error_class.new(_response.body, code: code)
|
28
36
|
end
|
29
|
-
|
30
|
-
raise _response.body
|
31
37
|
end
|
32
38
|
|
33
39
|
# Adds a snippet to a Square Online site or updates the existing snippet on the site.
|
@@ -43,17 +49,23 @@ module Square
|
|
43
49
|
_path_param_names = ["site_id"]
|
44
50
|
|
45
51
|
_request = Square::Internal::JSON::Request.new(
|
46
|
-
base_url: request_options[:base_url] || Square::Environment::
|
52
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
47
53
|
method: "POST",
|
48
54
|
path: "v2/sites/#{params[:site_id]}/snippet",
|
49
55
|
body: params.except(*_path_param_names)
|
50
56
|
)
|
51
|
-
|
52
|
-
|
53
|
-
|
57
|
+
begin
|
58
|
+
_response = @client.send(_request)
|
59
|
+
rescue Net::HTTPRequestTimeout
|
60
|
+
raise Square::Errors::TimeoutError
|
61
|
+
end
|
62
|
+
code = _response.code.to_i
|
63
|
+
if code.between?(200, 299)
|
64
|
+
Square::Types::UpsertSnippetResponse.load(_response.body)
|
65
|
+
else
|
66
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
67
|
+
raise error_class.new(_response.body, code: code)
|
54
68
|
end
|
55
|
-
|
56
|
-
raise _response.body
|
57
69
|
end
|
58
70
|
|
59
71
|
# Removes your snippet from a Square Online site.
|
@@ -66,16 +78,22 @@ module Square
|
|
66
78
|
# @return [Square::Types::DeleteSnippetResponse]
|
67
79
|
def delete(request_options: {}, **params)
|
68
80
|
_request = Square::Internal::JSON::Request.new(
|
69
|
-
base_url: request_options[:base_url] || Square::Environment::
|
81
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
70
82
|
method: "DELETE",
|
71
83
|
path: "v2/sites/#{params[:site_id]}/snippet"
|
72
84
|
)
|
73
|
-
|
74
|
-
|
75
|
-
|
85
|
+
begin
|
86
|
+
_response = @client.send(_request)
|
87
|
+
rescue Net::HTTPRequestTimeout
|
88
|
+
raise Square::Errors::TimeoutError
|
89
|
+
end
|
90
|
+
code = _response.code.to_i
|
91
|
+
if code.between?(200, 299)
|
92
|
+
Square::Types::DeleteSnippetResponse.load(_response.body)
|
93
|
+
else
|
94
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
95
|
+
raise error_class.new(_response.body, code: code)
|
76
96
|
end
|
77
|
-
|
78
|
-
raise _response.body
|
79
97
|
end
|
80
98
|
end
|
81
99
|
end
|