square.rb 44.0.0.0 → 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 +11 -4
@@ -14,16 +14,22 @@ module Square
|
|
14
14
|
# @return [Square::Types::GetInventoryAdjustmentResponse]
|
15
15
|
def deprecated_get_adjustment(request_options: {}, **params)
|
16
16
|
_request = Square::Internal::JSON::Request.new(
|
17
|
-
base_url: request_options[:base_url] || Square::Environment::
|
17
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
18
18
|
method: "GET",
|
19
19
|
path: "v2/inventory/adjustment/#{params[:adjustment_id]}"
|
20
20
|
)
|
21
|
-
|
22
|
-
|
23
|
-
|
21
|
+
begin
|
22
|
+
_response = @client.send(_request)
|
23
|
+
rescue Net::HTTPRequestTimeout
|
24
|
+
raise Square::Errors::TimeoutError
|
25
|
+
end
|
26
|
+
code = _response.code.to_i
|
27
|
+
if code.between?(200, 299)
|
28
|
+
Square::Types::GetInventoryAdjustmentResponse.load(_response.body)
|
29
|
+
else
|
30
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
31
|
+
raise error_class.new(_response.body, code: code)
|
24
32
|
end
|
25
|
-
|
26
|
-
raise _response.body
|
27
33
|
end
|
28
34
|
|
29
35
|
# Returns the [InventoryAdjustment](entity:InventoryAdjustment) object
|
@@ -32,16 +38,22 @@ module Square
|
|
32
38
|
# @return [Square::Types::GetInventoryAdjustmentResponse]
|
33
39
|
def get_adjustment(request_options: {}, **params)
|
34
40
|
_request = Square::Internal::JSON::Request.new(
|
35
|
-
base_url: request_options[:base_url] || Square::Environment::
|
41
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
36
42
|
method: "GET",
|
37
43
|
path: "v2/inventory/adjustments/#{params[:adjustment_id]}"
|
38
44
|
)
|
39
|
-
|
40
|
-
|
41
|
-
|
45
|
+
begin
|
46
|
+
_response = @client.send(_request)
|
47
|
+
rescue Net::HTTPRequestTimeout
|
48
|
+
raise Square::Errors::TimeoutError
|
49
|
+
end
|
50
|
+
code = _response.code.to_i
|
51
|
+
if code.between?(200, 299)
|
52
|
+
Square::Types::GetInventoryAdjustmentResponse.load(_response.body)
|
53
|
+
else
|
54
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
55
|
+
raise error_class.new(_response.body, code: code)
|
42
56
|
end
|
43
|
-
|
44
|
-
raise _response.body
|
45
57
|
end
|
46
58
|
|
47
59
|
# Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL
|
@@ -50,17 +62,23 @@ module Square
|
|
50
62
|
# @return [Square::Types::BatchChangeInventoryResponse]
|
51
63
|
def deprecated_batch_change(request_options: {}, **params)
|
52
64
|
_request = Square::Internal::JSON::Request.new(
|
53
|
-
base_url: request_options[:base_url] || Square::Environment::
|
65
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
54
66
|
method: "POST",
|
55
67
|
path: "v2/inventory/batch-change",
|
56
68
|
body: Square::Types::BatchChangeInventoryRequest.new(params).to_h
|
57
69
|
)
|
58
|
-
|
59
|
-
|
60
|
-
|
70
|
+
begin
|
71
|
+
_response = @client.send(_request)
|
72
|
+
rescue Net::HTTPRequestTimeout
|
73
|
+
raise Square::Errors::TimeoutError
|
74
|
+
end
|
75
|
+
code = _response.code.to_i
|
76
|
+
if code.between?(200, 299)
|
77
|
+
Square::Types::BatchChangeInventoryResponse.load(_response.body)
|
78
|
+
else
|
79
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
80
|
+
raise error_class.new(_response.body, code: code)
|
61
81
|
end
|
62
|
-
|
63
|
-
raise _response.body
|
64
82
|
end
|
65
83
|
|
66
84
|
# Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL
|
@@ -69,17 +87,23 @@ module Square
|
|
69
87
|
# @return [Square::Types::BatchGetInventoryChangesResponse]
|
70
88
|
def deprecated_batch_get_changes(request_options: {}, **params)
|
71
89
|
_request = Square::Internal::JSON::Request.new(
|
72
|
-
base_url: request_options[:base_url] || Square::Environment::
|
90
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
73
91
|
method: "POST",
|
74
92
|
path: "v2/inventory/batch-retrieve-changes",
|
75
93
|
body: Square::Types::BatchRetrieveInventoryChangesRequest.new(params).to_h
|
76
94
|
)
|
77
|
-
|
78
|
-
|
79
|
-
|
95
|
+
begin
|
96
|
+
_response = @client.send(_request)
|
97
|
+
rescue Net::HTTPRequestTimeout
|
98
|
+
raise Square::Errors::TimeoutError
|
99
|
+
end
|
100
|
+
code = _response.code.to_i
|
101
|
+
if code.between?(200, 299)
|
102
|
+
Square::Types::BatchGetInventoryChangesResponse.load(_response.body)
|
103
|
+
else
|
104
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
105
|
+
raise error_class.new(_response.body, code: code)
|
80
106
|
end
|
81
|
-
|
82
|
-
raise _response.body
|
83
107
|
end
|
84
108
|
|
85
109
|
# Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL
|
@@ -88,17 +112,23 @@ module Square
|
|
88
112
|
# @return [Square::Types::BatchGetInventoryCountsResponse]
|
89
113
|
def deprecated_batch_get_counts(request_options: {}, **params)
|
90
114
|
_request = Square::Internal::JSON::Request.new(
|
91
|
-
base_url: request_options[:base_url] || Square::Environment::
|
115
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
92
116
|
method: "POST",
|
93
117
|
path: "v2/inventory/batch-retrieve-counts",
|
94
118
|
body: Square::Types::BatchGetInventoryCountsRequest.new(params).to_h
|
95
119
|
)
|
96
|
-
|
97
|
-
|
98
|
-
|
120
|
+
begin
|
121
|
+
_response = @client.send(_request)
|
122
|
+
rescue Net::HTTPRequestTimeout
|
123
|
+
raise Square::Errors::TimeoutError
|
124
|
+
end
|
125
|
+
code = _response.code.to_i
|
126
|
+
if code.between?(200, 299)
|
127
|
+
Square::Types::BatchGetInventoryCountsResponse.load(_response.body)
|
128
|
+
else
|
129
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
130
|
+
raise error_class.new(_response.body, code: code)
|
99
131
|
end
|
100
|
-
|
101
|
-
raise _response.body
|
102
132
|
end
|
103
133
|
|
104
134
|
# Applies adjustments and counts to the provided item quantities.
|
@@ -110,17 +140,23 @@ module Square
|
|
110
140
|
# @return [Square::Types::BatchChangeInventoryResponse]
|
111
141
|
def batch_create_changes(request_options: {}, **params)
|
112
142
|
_request = Square::Internal::JSON::Request.new(
|
113
|
-
base_url: request_options[:base_url] || Square::Environment::
|
143
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
114
144
|
method: "POST",
|
115
145
|
path: "v2/inventory/changes/batch-create",
|
116
146
|
body: Square::Types::BatchChangeInventoryRequest.new(params).to_h
|
117
147
|
)
|
118
|
-
|
119
|
-
|
120
|
-
|
148
|
+
begin
|
149
|
+
_response = @client.send(_request)
|
150
|
+
rescue Net::HTTPRequestTimeout
|
151
|
+
raise Square::Errors::TimeoutError
|
152
|
+
end
|
153
|
+
code = _response.code.to_i
|
154
|
+
if code.between?(200, 299)
|
155
|
+
Square::Types::BatchChangeInventoryResponse.load(_response.body)
|
156
|
+
else
|
157
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
158
|
+
raise error_class.new(_response.body, code: code)
|
121
159
|
end
|
122
|
-
|
123
|
-
raise _response.body
|
124
160
|
end
|
125
161
|
|
126
162
|
# Returns historical physical counts and adjustments based on the
|
@@ -135,17 +171,23 @@ module Square
|
|
135
171
|
# @return [Square::Types::BatchGetInventoryChangesResponse]
|
136
172
|
def batch_get_changes(request_options: {}, **params)
|
137
173
|
_request = Square::Internal::JSON::Request.new(
|
138
|
-
base_url: request_options[:base_url] || Square::Environment::
|
174
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
139
175
|
method: "POST",
|
140
176
|
path: "v2/inventory/changes/batch-retrieve",
|
141
177
|
body: Square::Types::BatchRetrieveInventoryChangesRequest.new(params).to_h
|
142
178
|
)
|
143
|
-
|
144
|
-
|
145
|
-
|
179
|
+
begin
|
180
|
+
_response = @client.send(_request)
|
181
|
+
rescue Net::HTTPRequestTimeout
|
182
|
+
raise Square::Errors::TimeoutError
|
183
|
+
end
|
184
|
+
code = _response.code.to_i
|
185
|
+
if code.between?(200, 299)
|
186
|
+
Square::Types::BatchGetInventoryChangesResponse.load(_response.body)
|
187
|
+
else
|
188
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
189
|
+
raise error_class.new(_response.body, code: code)
|
146
190
|
end
|
147
|
-
|
148
|
-
raise _response.body
|
149
191
|
end
|
150
192
|
|
151
193
|
# Returns current counts for the provided
|
@@ -163,17 +205,23 @@ module Square
|
|
163
205
|
# @return [Square::Types::BatchGetInventoryCountsResponse]
|
164
206
|
def batch_get_counts(request_options: {}, **params)
|
165
207
|
_request = Square::Internal::JSON::Request.new(
|
166
|
-
base_url: request_options[:base_url] || Square::Environment::
|
208
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
167
209
|
method: "POST",
|
168
210
|
path: "v2/inventory/counts/batch-retrieve",
|
169
211
|
body: Square::Types::BatchGetInventoryCountsRequest.new(params).to_h
|
170
212
|
)
|
171
|
-
|
172
|
-
|
173
|
-
|
213
|
+
begin
|
214
|
+
_response = @client.send(_request)
|
215
|
+
rescue Net::HTTPRequestTimeout
|
216
|
+
raise Square::Errors::TimeoutError
|
217
|
+
end
|
218
|
+
code = _response.code.to_i
|
219
|
+
if code.between?(200, 299)
|
220
|
+
Square::Types::BatchGetInventoryCountsResponse.load(_response.body)
|
221
|
+
else
|
222
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
223
|
+
raise error_class.new(_response.body, code: code)
|
174
224
|
end
|
175
|
-
|
176
|
-
raise _response.body
|
177
225
|
end
|
178
226
|
|
179
227
|
# Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL
|
@@ -182,16 +230,22 @@ module Square
|
|
182
230
|
# @return [Square::Types::GetInventoryPhysicalCountResponse]
|
183
231
|
def deprecated_get_physical_count(request_options: {}, **params)
|
184
232
|
_request = Square::Internal::JSON::Request.new(
|
185
|
-
base_url: request_options[:base_url] || Square::Environment::
|
233
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
186
234
|
method: "GET",
|
187
235
|
path: "v2/inventory/physical-count/#{params[:physical_count_id]}"
|
188
236
|
)
|
189
|
-
|
190
|
-
|
191
|
-
|
237
|
+
begin
|
238
|
+
_response = @client.send(_request)
|
239
|
+
rescue Net::HTTPRequestTimeout
|
240
|
+
raise Square::Errors::TimeoutError
|
241
|
+
end
|
242
|
+
code = _response.code.to_i
|
243
|
+
if code.between?(200, 299)
|
244
|
+
Square::Types::GetInventoryPhysicalCountResponse.load(_response.body)
|
245
|
+
else
|
246
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
247
|
+
raise error_class.new(_response.body, code: code)
|
192
248
|
end
|
193
|
-
|
194
|
-
raise _response.body
|
195
249
|
end
|
196
250
|
|
197
251
|
# Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount)
|
@@ -200,16 +254,22 @@ module Square
|
|
200
254
|
# @return [Square::Types::GetInventoryPhysicalCountResponse]
|
201
255
|
def get_physical_count(request_options: {}, **params)
|
202
256
|
_request = Square::Internal::JSON::Request.new(
|
203
|
-
base_url: request_options[:base_url] || Square::Environment::
|
257
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
204
258
|
method: "GET",
|
205
259
|
path: "v2/inventory/physical-counts/#{params[:physical_count_id]}"
|
206
260
|
)
|
207
|
-
|
208
|
-
|
209
|
-
|
261
|
+
begin
|
262
|
+
_response = @client.send(_request)
|
263
|
+
rescue Net::HTTPRequestTimeout
|
264
|
+
raise Square::Errors::TimeoutError
|
265
|
+
end
|
266
|
+
code = _response.code.to_i
|
267
|
+
if code.between?(200, 299)
|
268
|
+
Square::Types::GetInventoryPhysicalCountResponse.load(_response.body)
|
269
|
+
else
|
270
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
271
|
+
raise error_class.new(_response.body, code: code)
|
210
272
|
end
|
211
|
-
|
212
|
-
raise _response.body
|
213
273
|
end
|
214
274
|
|
215
275
|
# Returns the [InventoryTransfer](entity:InventoryTransfer) object
|
@@ -218,16 +278,22 @@ module Square
|
|
218
278
|
# @return [Square::Types::GetInventoryTransferResponse]
|
219
279
|
def get_transfer(request_options: {}, **params)
|
220
280
|
_request = Square::Internal::JSON::Request.new(
|
221
|
-
base_url: request_options[:base_url] || Square::Environment::
|
281
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
222
282
|
method: "GET",
|
223
283
|
path: "v2/inventory/transfers/#{params[:transfer_id]}"
|
224
284
|
)
|
225
|
-
|
226
|
-
|
227
|
-
|
285
|
+
begin
|
286
|
+
_response = @client.send(_request)
|
287
|
+
rescue Net::HTTPRequestTimeout
|
288
|
+
raise Square::Errors::TimeoutError
|
289
|
+
end
|
290
|
+
code = _response.code.to_i
|
291
|
+
if code.between?(200, 299)
|
292
|
+
Square::Types::GetInventoryTransferResponse.load(_response.body)
|
293
|
+
else
|
294
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
295
|
+
raise error_class.new(_response.body, code: code)
|
228
296
|
end
|
229
|
-
|
230
|
-
raise _response.body
|
231
297
|
end
|
232
298
|
|
233
299
|
# Retrieves the current calculated stock count for a given
|
@@ -237,22 +303,31 @@ module Square
|
|
237
303
|
#
|
238
304
|
# @return [Square::Types::GetInventoryCountResponse]
|
239
305
|
def get(request_options: {}, **params)
|
240
|
-
_query_param_names =
|
306
|
+
_query_param_names = [
|
307
|
+
%w[location_ids cursor],
|
308
|
+
%i[location_ids cursor]
|
309
|
+
].flatten
|
241
310
|
_query = params.slice(*_query_param_names)
|
242
311
|
params = params.except(*_query_param_names)
|
243
312
|
|
244
313
|
_request = Square::Internal::JSON::Request.new(
|
245
|
-
base_url: request_options[:base_url] || Square::Environment::
|
314
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
246
315
|
method: "GET",
|
247
316
|
path: "v2/inventory/#{params[:catalog_object_id]}",
|
248
317
|
query: _query
|
249
318
|
)
|
250
|
-
|
251
|
-
|
252
|
-
|
319
|
+
begin
|
320
|
+
_response = @client.send(_request)
|
321
|
+
rescue Net::HTTPRequestTimeout
|
322
|
+
raise Square::Errors::TimeoutError
|
323
|
+
end
|
324
|
+
code = _response.code.to_i
|
325
|
+
if code.between?(200, 299)
|
326
|
+
Square::Types::GetInventoryCountResponse.load(_response.body)
|
327
|
+
else
|
328
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
329
|
+
raise error_class.new(_response.body, code: code)
|
253
330
|
end
|
254
|
-
|
255
|
-
raise _response.body
|
256
331
|
end
|
257
332
|
|
258
333
|
# Returns a set of physical counts and inventory adjustments for the
|
@@ -271,22 +346,31 @@ module Square
|
|
271
346
|
#
|
272
347
|
# @return [Square::Types::GetInventoryChangesResponse]
|
273
348
|
def changes(request_options: {}, **params)
|
274
|
-
_query_param_names =
|
349
|
+
_query_param_names = [
|
350
|
+
%w[location_ids cursor],
|
351
|
+
%i[location_ids cursor]
|
352
|
+
].flatten
|
275
353
|
_query = params.slice(*_query_param_names)
|
276
354
|
params = params.except(*_query_param_names)
|
277
355
|
|
278
356
|
_request = Square::Internal::JSON::Request.new(
|
279
|
-
base_url: request_options[:base_url] || Square::Environment::
|
357
|
+
base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
|
280
358
|
method: "GET",
|
281
359
|
path: "v2/inventory/#{params[:catalog_object_id]}/changes",
|
282
360
|
query: _query
|
283
361
|
)
|
284
|
-
|
285
|
-
|
286
|
-
|
362
|
+
begin
|
363
|
+
_response = @client.send(_request)
|
364
|
+
rescue Net::HTTPRequestTimeout
|
365
|
+
raise Square::Errors::TimeoutError
|
366
|
+
end
|
367
|
+
code = _response.code.to_i
|
368
|
+
if code.between?(200, 299)
|
369
|
+
Square::Types::GetInventoryChangesResponse.load(_response.body)
|
370
|
+
else
|
371
|
+
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
372
|
+
raise error_class.new(_response.body, code: code)
|
287
373
|
end
|
288
|
-
|
289
|
-
raise _response.body
|
290
374
|
end
|
291
375
|
end
|
292
376
|
end
|