square.rb 44.2.0.20251016 → 45.0.1.20260122
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/.fern/metadata.json +9 -0
- data/.fernignore +20 -0
- data/.rubocop.yml +60 -0
- data/LICENSE +1 -1
- data/Rakefile +29 -0
- data/custom.gemspec.rb +19 -0
- data/lib/square/apple_pay/client.rb +24 -10
- data/lib/square/bank_accounts/client.rb +144 -31
- data/lib/square/bank_accounts/types/create_bank_account_request.rb +13 -0
- data/lib/square/bank_accounts/types/disable_bank_account_request.rb +11 -0
- data/lib/square/bank_accounts/types/get_by_v_1_id_bank_accounts_request.rb +1 -1
- data/lib/square/bank_accounts/types/list_bank_accounts_request.rb +1 -0
- data/lib/square/bookings/client.rb +238 -100
- data/lib/square/bookings/custom_attribute_definitions/client.rb +139 -67
- data/lib/square/bookings/custom_attribute_definitions/types/create_booking_custom_attribute_definition_request.rb +1 -3
- data/lib/square/bookings/custom_attribute_definitions/types/update_booking_custom_attribute_definition_request.rb +1 -3
- data/lib/square/bookings/custom_attributes/client.rb +168 -76
- data/lib/square/bookings/custom_attributes/types/bulk_delete_booking_custom_attributes_request.rb +1 -3
- data/lib/square/bookings/custom_attributes/types/bulk_upsert_booking_custom_attributes_request.rb +1 -3
- data/lib/square/bookings/location_profiles/client.rb +44 -24
- data/lib/square/bookings/team_member_profiles/client.rb +66 -31
- data/lib/square/cards/client.rb +103 -45
- data/lib/square/cash_drawers/client.rb +3 -1
- data/lib/square/cash_drawers/shifts/client.rb +121 -61
- data/lib/square/catalog/client.rb +203 -91
- data/lib/square/catalog/images/client.rb +50 -20
- data/lib/square/catalog/object/client.rb +66 -29
- 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/catalog/types/batch_upsert_catalog_objects_request.rb +1 -3
- data/lib/square/catalog/types/search_catalog_items_request.rb +3 -9
- data/lib/square/catalog/types/search_catalog_objects_request.rb +1 -3
- data/lib/square/channels/client.rb +85 -38
- data/lib/square/checkout/client.rb +77 -31
- data/lib/square/checkout/payment_links/client.rb +120 -54
- data/lib/square/client.rb +8 -10
- data/lib/square/customers/cards/client.rb +43 -16
- data/lib/square/customers/client.rb +220 -97
- data/lib/square/customers/custom_attribute_definitions/client.rb +157 -74
- data/lib/square/customers/custom_attribute_definitions/types/batch_upsert_customer_custom_attributes_request.rb +1 -3
- data/lib/square/customers/custom_attribute_definitions/types/create_customer_custom_attribute_definition_request.rb +1 -3
- data/lib/square/customers/custom_attribute_definitions/types/update_customer_custom_attribute_definition_request.rb +1 -3
- data/lib/square/customers/custom_attributes/client.rb +117 -53
- data/lib/square/customers/groups/client.rb +156 -67
- data/lib/square/customers/segments/client.rb +62 -31
- data/lib/square/customers/types/bulk_create_customers_request.rb +1 -3
- data/lib/square/customers/types/bulk_update_customers_request.rb +1 -3
- data/lib/square/devices/client.rb +66 -31
- data/lib/square/devices/codes/client.rb +83 -38
- data/lib/square/disputes/client.rb +140 -60
- data/lib/square/disputes/evidence/client.rb +83 -39
- data/lib/square/employees/client.rb +66 -31
- data/lib/square/events/client.rb +80 -38
- data/lib/square/file_param.rb +77 -77
- data/lib/square/gift_cards/activities/client.rb +73 -31
- data/lib/square/gift_cards/client.rb +163 -69
- data/lib/square/internal/http/base_request.rb +6 -0
- data/lib/square/internal/http/raw_client.rb +111 -20
- data/lib/square/internal/iterators/cursor_item_iterator.rb +28 -0
- data/lib/square/internal/iterators/cursor_page_iterator.rb +51 -0
- data/lib/square/internal/iterators/item_iterator.rb +65 -0
- data/lib/square/internal/iterators/offset_item_iterator.rb +30 -0
- data/lib/square/internal/iterators/offset_page_iterator.rb +83 -0
- data/lib/square/internal/json/request.rb +2 -1
- data/lib/square/internal/multipart/multipart_request.rb +2 -1
- data/lib/square/internal/types/enum.rb +8 -0
- data/lib/square/internal/types/model/field.rb +11 -1
- data/lib/square/internal/types/model.rb +14 -4
- data/lib/square/internal/types/union.rb +88 -7
- data/lib/square/internal/types/utils.rb +20 -4
- data/lib/square/inventory/client.rb +100 -76
- data/lib/square/invoices/client.rb +228 -99
- data/lib/square/labor/break_types/client.rb +120 -53
- data/lib/square/labor/client.rb +205 -81
- data/lib/square/labor/employee_wages/client.rb +64 -31
- data/lib/square/labor/shifts/client.rb +94 -37
- data/lib/square/labor/team_member_wages/client.rb +64 -31
- data/lib/square/labor/types/bulk_publish_scheduled_shifts_request.rb +2 -6
- data/lib/square/labor/types/publish_scheduled_shift_request.rb +1 -3
- data/lib/square/labor/workweek_configs/client.rb +65 -32
- data/lib/square/locations/client.rb +102 -41
- data/lib/square/locations/custom_attribute_definitions/client.rb +135 -64
- data/lib/square/locations/custom_attribute_definitions/types/create_location_custom_attribute_definition_request.rb +1 -3
- data/lib/square/locations/custom_attribute_definitions/types/update_location_custom_attribute_definition_request.rb +1 -3
- data/lib/square/locations/custom_attributes/client.rb +156 -68
- data/lib/square/locations/custom_attributes/types/bulk_delete_location_custom_attributes_request.rb +1 -3
- data/lib/square/locations/custom_attributes/types/bulk_upsert_location_custom_attributes_request.rb +1 -3
- data/lib/square/locations/transactions/client.rb +93 -37
- data/lib/square/locations/types/create_checkout_request.rb +1 -3
- data/lib/square/loyalty/accounts/client.rb +109 -44
- data/lib/square/loyalty/accounts/types/search_loyalty_accounts_request.rb +1 -3
- data/lib/square/loyalty/client.rb +20 -8
- data/lib/square/loyalty/programs/client.rb +72 -29
- data/lib/square/loyalty/programs/promotions/client.rb +106 -46
- data/lib/square/loyalty/rewards/client.rb +96 -38
- data/lib/square/loyalty/rewards/types/search_loyalty_rewards_request.rb +1 -3
- data/lib/square/merchants/client.rb +60 -31
- data/lib/square/merchants/custom_attribute_definitions/client.rb +137 -65
- data/lib/square/merchants/custom_attribute_definitions/types/create_merchant_custom_attribute_definition_request.rb +1 -3
- data/lib/square/merchants/custom_attribute_definitions/types/update_merchant_custom_attribute_definition_request.rb +1 -3
- data/lib/square/merchants/custom_attributes/client.rb +156 -68
- data/lib/square/merchants/custom_attributes/types/bulk_delete_merchant_custom_attributes_request.rb +1 -3
- data/lib/square/merchants/custom_attributes/types/bulk_upsert_merchant_custom_attributes_request.rb +1 -3
- data/lib/square/o_auth/client.rb +76 -31
- data/lib/square/o_auth/types/obtain_token_request.rb +1 -0
- data/lib/square/orders/client.rb +156 -63
- data/lib/square/orders/custom_attribute_definitions/client.rb +137 -65
- data/lib/square/orders/custom_attribute_definitions/types/create_order_custom_attribute_definition_request.rb +1 -3
- data/lib/square/orders/custom_attribute_definitions/types/update_order_custom_attribute_definition_request.rb +1 -3
- data/lib/square/orders/custom_attributes/client.rb +159 -69
- data/lib/square/orders/custom_attributes/types/bulk_delete_order_custom_attributes_request.rb +1 -3
- data/lib/square/orders/custom_attributes/types/bulk_upsert_order_custom_attributes_request.rb +1 -3
- data/lib/square/orders/types/calculate_order_request.rb +1 -3
- data/lib/square/payments/client.rb +182 -70
- data/lib/square/payouts/client.rb +116 -54
- data/lib/square/refunds/client.rb +97 -40
- data/lib/square/refunds/types/refund_payment_request.rb +1 -3
- data/lib/square/sites/client.rb +26 -11
- data/lib/square/snippets/client.rb +73 -28
- data/lib/square/subscriptions/client.rb +271 -117
- data/lib/square/team/client.rb +81 -36
- data/lib/square/team_members/client.rb +119 -49
- data/lib/square/team_members/types/batch_create_team_members_request.rb +1 -3
- data/lib/square/team_members/types/batch_update_team_members_request.rb +1 -3
- data/lib/square/team_members/wage_setting/client.rb +48 -19
- data/lib/square/terminal/actions/client.rb +75 -30
- data/lib/square/terminal/checkouts/client.rb +76 -30
- data/lib/square/terminal/client.rb +60 -23
- data/lib/square/terminal/refunds/client.rb +78 -31
- data/lib/square/transfer_orders/client.rb +26 -21
- data/lib/square/types/address.rb +2 -1
- data/lib/square/types/application_details.rb +1 -3
- data/lib/square/types/application_type.rb +23 -0
- data/lib/square/types/availability.rb +3 -4
- data/lib/square/types/bank_account.rb +1 -0
- data/lib/square/types/batch_create_team_members_response.rb +1 -3
- data/lib/square/types/batch_create_vendors_response.rb +1 -3
- data/lib/square/types/batch_get_catalog_objects_response.rb +1 -3
- data/lib/square/types/batch_get_vendors_response.rb +1 -3
- data/lib/square/types/batch_update_team_members_response.rb +1 -3
- data/lib/square/types/batch_update_vendors_response.rb +1 -3
- data/lib/square/types/batch_upsert_catalog_objects_response.rb +1 -3
- data/lib/square/types/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.rb +2 -1
- data/lib/square/types/batch_upsert_customer_custom_attributes_response.rb +4 -4
- data/lib/square/types/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.rb +3 -1
- data/lib/square/types/booking.rb +2 -6
- data/lib/square/types/booking_created_event.rb +2 -1
- data/lib/square/types/booking_custom_attribute_definition_visible_created_event.rb +2 -1
- data/lib/square/types/booking_custom_attribute_definition_visible_deleted_event.rb +2 -1
- data/lib/square/types/booking_custom_attribute_definition_visible_updated_event.rb +2 -1
- data/lib/square/types/booking_custom_attribute_delete_request.rb +4 -2
- data/lib/square/types/booking_custom_attribute_delete_response.rb +3 -1
- data/lib/square/types/booking_custom_attribute_upsert_request.rb +2 -1
- data/lib/square/types/booking_custom_attribute_upsert_response.rb +3 -1
- data/lib/square/types/booking_updated_event.rb +2 -1
- data/lib/square/types/bulk_create_customers_response.rb +1 -3
- data/lib/square/types/bulk_delete_booking_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_delete_customers_response.rb +1 -3
- data/lib/square/types/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.rb +2 -1
- data/lib/square/types/bulk_delete_location_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.rb +2 -1
- data/lib/square/types/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.rb +2 -1
- data/lib/square/types/bulk_delete_merchant_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.rb +2 -1
- data/lib/square/types/bulk_delete_order_custom_attributes_response.rb +1 -3
- data/lib/square/types/bulk_publish_scheduled_shifts_response.rb +1 -3
- data/lib/square/types/bulk_retrieve_bookings_response.rb +1 -3
- data/lib/square/types/bulk_retrieve_channels_request_constants.rb +23 -0
- data/lib/square/types/bulk_retrieve_channels_response.rb +1 -3
- data/lib/square/types/bulk_retrieve_customers_response.rb +1 -3
- data/lib/square/types/bulk_retrieve_team_member_booking_profiles_response.rb +3 -4
- data/lib/square/types/bulk_update_customers_response.rb +1 -3
- data/lib/square/types/bulk_upsert_booking_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.rb +2 -1
- data/lib/square/types/bulk_upsert_location_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.rb +3 -1
- data/lib/square/types/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.rb +2 -1
- data/lib/square/types/bulk_upsert_merchant_custom_attributes_response.rb +4 -4
- data/lib/square/types/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.rb +3 -1
- data/lib/square/types/bulk_upsert_order_custom_attributes_response.rb +1 -3
- data/lib/square/types/business_appointment_settings.rb +4 -12
- data/lib/square/types/business_booking_profile.rb +2 -6
- data/lib/square/types/buy_now_pay_later_details.rb +1 -0
- data/lib/square/types/card.rb +2 -0
- data/lib/square/types/card_issuer_alert.rb +23 -0
- data/lib/square/types/catalog_category.rb +1 -3
- data/lib/square/types/catalog_custom_attribute_definition.rb +6 -18
- data/lib/square/types/catalog_custom_attribute_definition_selection_config.rb +1 -3
- data/lib/square/types/catalog_id_mapping.rb +1 -1
- data/lib/square/types/catalog_info_response.rb +1 -3
- data/lib/square/types/catalog_item.rb +6 -12
- data/lib/square/types/catalog_item_food_and_beverage_details.rb +2 -6
- data/lib/square/types/catalog_item_food_and_beverage_details_dietary_preference.rb +2 -6
- data/lib/square/types/catalog_item_food_and_beverage_details_ingredient.rb +2 -6
- data/lib/square/types/catalog_item_modifier_list_info.rb +6 -9
- data/lib/square/types/catalog_item_variation.rb +17 -13
- data/lib/square/types/catalog_modifier.rb +4 -4
- data/lib/square/types/catalog_modifier_list.rb +4 -2
- data/lib/square/types/catalog_modifier_override.rb +2 -2
- data/lib/square/types/catalog_modifier_toggle_override_type.rb +13 -0
- data/lib/square/types/catalog_object.rb +7 -3
- data/lib/square/types/catalog_object_base.rb +2 -4
- data/lib/square/types/catalog_object_category.rb +3 -4
- data/lib/square/types/catalog_object_custom_attribute_definition.rb +1 -3
- data/lib/square/types/catalog_object_quick_amounts_settings.rb +1 -3
- data/lib/square/types/catalog_object_reference.rb +1 -1
- data/lib/square/types/catalog_object_subscription_plan_variation.rb +1 -3
- data/lib/square/types/catalog_query.rb +11 -13
- data/lib/square/types/catalog_query_prefix.rb +2 -1
- data/lib/square/types/catalog_query_text.rb +2 -1
- data/lib/square/types/catalog_subscription_plan.rb +5 -5
- data/lib/square/types/catalog_subscription_plan_variation.rb +4 -2
- data/lib/square/types/catalog_v_1_id.rb +1 -1
- data/lib/square/types/catalog_version_updated_event_object.rb +1 -3
- data/lib/square/types/checkout.rb +1 -3
- data/lib/square/types/checkout_location_settings.rb +1 -3
- data/lib/square/types/checkout_location_settings_branding.rb +2 -6
- data/lib/square/types/checkout_merchant_settings.rb +1 -3
- data/lib/square/types/checkout_merchant_settings_payment_methods.rb +4 -12
- data/lib/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay.rb +2 -6
- data/lib/square/types/component.rb +4 -12
- data/lib/square/types/create_bank_account_response.rb +11 -0
- data/lib/square/types/create_booking_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/create_catalog_image_request.rb +1 -1
- data/lib/square/types/create_customer_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/create_location_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/create_merchant_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/create_order_custom_attribute_definition_response.rb +1 -3
- data/lib/square/types/create_transfer_order_data.rb +3 -4
- data/lib/square/types/create_webhook_subscription_response.rb +2 -1
- data/lib/square/types/custom_attribute.rb +1 -1
- data/lib/square/types/custom_attribute_definition.rb +1 -3
- data/lib/square/types/custom_attribute_definition_event_data_object.rb +1 -3
- data/lib/square/types/custom_field.rb +2 -1
- data/lib/square/types/customer_address_filter.rb +2 -1
- data/lib/square/types/customer_created_event.rb +4 -2
- data/lib/square/types/customer_created_event_event_context_merge.rb +2 -1
- data/lib/square/types/customer_creation_source_filter.rb +1 -3
- data/lib/square/types/customer_custom_attribute_filter.rb +2 -1
- data/lib/square/types/customer_custom_attribute_filter_value.rb +2 -1
- data/lib/square/types/customer_custom_attribute_filters.rb +7 -6
- data/lib/square/types/customer_custom_attribute_visible_updated_event.rb +6 -3
- data/lib/square/types/customer_deleted_event.rb +4 -2
- data/lib/square/types/customer_deleted_event_event_context_merge.rb +2 -1
- data/lib/square/types/customer_tax_ids.rb +4 -2
- data/lib/square/types/customer_updated_event.rb +4 -2
- data/lib/square/types/delete_booking_custom_attribute_definition_response.rb +5 -2
- data/lib/square/types/delete_booking_custom_attribute_response.rb +2 -1
- data/lib/square/types/delete_customer_custom_attribute_response.rb +2 -1
- data/lib/square/types/delete_location_custom_attribute_response.rb +2 -1
- data/lib/square/types/delete_merchant_custom_attribute_response.rb +2 -1
- data/lib/square/types/delete_subscription_action_response.rb +2 -1
- data/lib/square/types/delete_webhook_subscription_response.rb +2 -1
- data/lib/square/types/destination_details.rb +1 -3
- data/lib/square/types/device_checkout_options.rb +1 -0
- data/lib/square/types/device_component_details_ethernet_details.rb +1 -1
- data/lib/square/types/device_component_details_wi_fi_details.rb +1 -1
- data/lib/square/types/digital_wallet_details.rb +1 -0
- data/lib/square/types/disable_bank_account_response.rb +11 -0
- data/lib/square/types/dispute.rb +2 -1
- data/lib/square/types/dispute_evidence_added_event.rb +2 -1
- data/lib/square/types/dispute_evidence_created_event.rb +2 -1
- data/lib/square/types/employee_wage.rb +2 -1
- data/lib/square/types/error_code.rb +2 -0
- data/lib/square/types/event_data.rb +1 -3
- data/lib/square/types/fulfillment.rb +4 -7
- data/lib/square/types/fulfillment_delivery_details.rb +1 -3
- data/lib/square/types/fulfillment_pickup_details.rb +1 -3
- data/lib/square/types/get_bank_account_response.rb +1 -1
- data/lib/square/types/get_booking_request.rb +23 -0
- data/lib/square/types/get_business_booking_profile_request.rb +23 -0
- data/lib/square/types/get_card_request.rb +23 -0
- data/lib/square/types/get_catalog_object_response.rb +1 -3
- data/lib/square/types/get_customer_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/get_customer_custom_attribute_response.rb +2 -1
- data/lib/square/types/get_customer_group_request.rb +23 -0
- data/lib/square/types/get_customer_request.rb +23 -0
- data/lib/square/types/get_customer_segment_request.rb +23 -0
- data/lib/square/types/get_dispute_evidence_request.rb +23 -0
- data/lib/square/types/get_dispute_request.rb +23 -0
- data/lib/square/types/get_employee_request.rb +23 -0
- data/lib/square/types/get_gift_card_request.rb +23 -0
- data/lib/square/types/get_inventory_adjustment_request.rb +23 -0
- data/lib/square/types/get_inventory_physical_count_request.rb +23 -0
- data/lib/square/types/get_inventory_transfer_request.rb +23 -0
- data/lib/square/types/get_location_request.rb +23 -0
- data/lib/square/types/get_loyalty_account_request.rb +23 -0
- data/lib/square/types/get_loyalty_program_request.rb +23 -0
- data/lib/square/types/get_loyalty_promotion_request.rb +23 -0
- data/lib/square/types/get_loyalty_reward_request.rb +23 -0
- data/lib/square/types/get_merchant_request.rb +23 -0
- data/lib/square/types/get_order_request.rb +23 -0
- data/lib/square/types/get_payment_link_request.rb +23 -0
- data/lib/square/types/get_snippet_request.rb +23 -0
- data/lib/square/types/get_team_member_booking_profile_request.rb +23 -0
- data/lib/square/types/get_team_member_booking_profile_response.rb +1 -3
- data/lib/square/types/get_team_member_request.rb +23 -0
- data/lib/square/types/get_transaction_request.rb +23 -0
- data/lib/square/types/get_vendor_request.rb +23 -0
- data/lib/square/types/get_wage_setting_request.rb +23 -0
- data/lib/square/types/get_webhook_subscription_request.rb +23 -0
- data/lib/square/types/get_webhook_subscription_response.rb +2 -1
- data/lib/square/types/gift_card_activity.rb +8 -24
- data/lib/square/types/gift_card_activity_block_reason.rb +23 -0
- data/lib/square/types/gift_card_activity_unblock_reason.rb +23 -0
- data/lib/square/types/gift_card_activity_updated_event.rb +2 -1
- data/lib/square/types/inventory_count_updated_event_object.rb +1 -3
- data/lib/square/types/invoice.rb +6 -13
- data/lib/square/types/invoice_accepted_payment_methods.rb +2 -1
- data/lib/square/types/invoice_attachment.rb +1 -1
- data/lib/square/types/invoice_custom_field.rb +2 -1
- data/lib/square/types/invoice_payment_made_event.rb +2 -1
- data/lib/square/types/invoice_payment_request.rb +6 -8
- data/lib/square/types/invoice_refunded_event.rb +2 -1
- data/lib/square/types/invoice_sort_field.rb +23 -0
- data/lib/square/types/labor_scheduled_shift_created_event_object.rb +1 -1
- data/lib/square/types/labor_scheduled_shift_published_event_object.rb +1 -1
- data/lib/square/types/labor_scheduled_shift_updated_event_object.rb +1 -1
- data/lib/square/types/list_bank_accounts_response.rb +1 -1
- data/lib/square/types/list_booking_custom_attribute_definitions_response.rb +4 -4
- data/lib/square/types/list_booking_custom_attributes_response.rb +3 -4
- data/lib/square/types/list_cash_drawer_shift_events_response.rb +1 -3
- data/lib/square/types/list_cash_drawer_shifts_response.rb +1 -3
- data/lib/square/types/list_channels_request_constants.rb +23 -0
- data/lib/square/types/list_customer_custom_attribute_definitions_response.rb +4 -4
- data/lib/square/types/list_customer_custom_attributes_response.rb +3 -4
- data/lib/square/types/list_gift_card_activities_response.rb +1 -3
- data/lib/square/types/list_location_booking_profiles_response.rb +1 -3
- data/lib/square/types/list_location_custom_attribute_definitions_response.rb +4 -4
- data/lib/square/types/list_location_custom_attributes_response.rb +3 -4
- data/lib/square/types/list_loyalty_promotions_response.rb +1 -3
- data/lib/square/types/list_merchant_custom_attribute_definitions_response.rb +4 -4
- data/lib/square/types/list_merchant_custom_attributes_response.rb +3 -4
- data/lib/square/types/list_order_custom_attribute_definitions_response.rb +1 -3
- data/lib/square/types/list_order_custom_attributes_response.rb +1 -3
- data/lib/square/types/list_subscription_events_response.rb +1 -3
- data/lib/square/types/list_team_member_booking_profiles_response.rb +1 -3
- data/lib/square/types/list_team_member_wages_response.rb +1 -3
- data/lib/square/types/list_webhook_subscriptions_response.rb +1 -3
- data/lib/square/types/list_workweek_configs_response.rb +1 -3
- data/lib/square/types/location.rb +1 -3
- data/lib/square/types/location_booking_profile.rb +2 -1
- data/lib/square/types/location_custom_attribute_visible_updated_event.rb +6 -3
- data/lib/square/types/loyalty_account.rb +1 -3
- data/lib/square/types/loyalty_account_mapping_type.rb +23 -0
- data/lib/square/types/loyalty_event.rb +3 -4
- data/lib/square/types/loyalty_event_filter.rb +1 -3
- data/lib/square/types/loyalty_program.rb +4 -7
- data/lib/square/types/loyalty_program_accrual_rule.rb +3 -4
- data/lib/square/types/loyalty_program_reward_tier.rb +3 -1
- data/lib/square/types/loyalty_promotion_incentive.rb +2 -6
- data/lib/square/types/loyalty_promotion_incentive_points_addition_data.rb +2 -1
- data/lib/square/types/loyalty_promotion_incentive_points_multiplier_data.rb +2 -1
- data/lib/square/types/loyalty_promotion_trigger_limit.rb +2 -1
- data/lib/square/types/loyalty_reward.rb +4 -2
- data/lib/square/types/measurement_unit_generic.rb +23 -0
- data/lib/square/types/oauth_authorization_revoked_event_object.rb +1 -3
- data/lib/square/types/oauth_authorization_revoked_event_revocation_object.rb +1 -3
- data/lib/square/types/order.rb +2 -6
- data/lib/square/types/order_card_surcharge_treatment_type.rb +12 -0
- data/lib/square/types/order_custom_attribute_definition_owned_created_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_definition_owned_deleted_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_definition_owned_updated_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_definition_visible_created_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_definition_visible_deleted_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_definition_visible_updated_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_owned_deleted_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_owned_updated_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_visible_deleted_event.rb +2 -1
- data/lib/square/types/order_custom_attribute_visible_updated_event.rb +2 -1
- data/lib/square/types/order_fulfillment_updated.rb +1 -3
- data/lib/square/types/order_line_item.rb +4 -12
- data/lib/square/types/order_line_item_applied_tax.rb +1 -0
- data/lib/square/types/order_line_item_pricing_blocklists.rb +3 -6
- data/lib/square/types/order_line_item_pricing_blocklists_blocked_service_charge.rb +14 -0
- data/lib/square/types/order_return.rb +3 -9
- data/lib/square/types/order_return_line_item.rb +4 -12
- data/lib/square/types/order_return_service_charge.rb +3 -6
- data/lib/square/types/order_service_charge.rb +2 -6
- data/lib/square/types/payment.rb +1 -3
- data/lib/square/types/payment_link_related_resources.rb +1 -3
- data/lib/square/types/payment_refund.rb +1 -3
- data/lib/square/types/payout_entry.rb +24 -72
- data/lib/square/types/pre_populated_data.rb +2 -1
- data/lib/square/types/product_type.rb +23 -0
- data/lib/square/types/refund.rb +1 -3
- data/lib/square/types/retrieve_booking_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/retrieve_booking_custom_attribute_response.rb +2 -1
- data/lib/square/types/retrieve_location_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/retrieve_location_custom_attribute_response.rb +2 -1
- data/lib/square/types/retrieve_merchant_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/retrieve_merchant_custom_attribute_response.rb +2 -1
- data/lib/square/types/retrieve_order_custom_attribute_definition_response.rb +1 -3
- data/lib/square/types/scheduled_shift_filter.rb +3 -7
- data/lib/square/types/scheduled_shift_workday.rb +1 -3
- data/lib/square/types/search_availability_filter.rb +1 -3
- data/lib/square/types/search_catalog_items_response.rb +2 -1
- data/lib/square/types/search_catalog_objects_response.rb +1 -3
- data/lib/square/types/search_events_sort_field.rb +23 -0
- data/lib/square/types/search_loyalty_accounts_request_loyalty_account_query.rb +1 -3
- data/lib/square/types/search_loyalty_accounts_response.rb +1 -3
- data/lib/square/types/search_orders_date_time_filter.rb +2 -1
- data/lib/square/types/search_orders_fulfillment_filter.rb +2 -6
- data/lib/square/types/search_orders_source_filter.rb +2 -0
- data/lib/square/types/search_scheduled_shifts_response.rb +1 -3
- data/lib/square/types/search_transfer_orders_response.rb +1 -3
- data/lib/square/types/shift_filter.rb +3 -2
- data/lib/square/types/shift_query.rb +2 -1
- data/lib/square/types/shift_sort.rb +2 -1
- data/lib/square/types/shift_wage.rb +2 -1
- data/lib/square/types/shift_workday.rb +2 -1
- data/lib/square/types/snippet.rb +2 -1
- data/lib/square/types/standard_unit_description_group.rb +1 -3
- data/lib/square/types/subscription_event.rb +1 -3
- data/lib/square/types/subscription_phase.rb +2 -1
- data/lib/square/types/subscription_test_result.rb +5 -3
- data/lib/square/types/team_member_assigned_locations.rb +1 -3
- data/lib/square/types/team_member_booking_profile.rb +2 -1
- data/lib/square/types/tender.rb +2 -6
- data/lib/square/types/tender_buy_now_pay_later_details.rb +1 -3
- data/lib/square/types/terminal_refund.rb +2 -1
- data/lib/square/types/test_webhook_subscription_response.rb +5 -5
- data/lib/square/types/timecard_filter.rb +1 -1
- data/lib/square/types/transfer_order.rb +1 -3
- data/lib/square/types/transfer_order_filter.rb +1 -3
- data/lib/square/types/transfer_order_goods_receipt.rb +1 -3
- data/lib/square/types/update_booking_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/update_customer_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/update_location_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/update_merchant_custom_attribute_definition_response.rb +4 -4
- data/lib/square/types/update_order_custom_attribute_definition_response.rb +1 -3
- data/lib/square/types/update_transfer_order_data.rb +1 -3
- data/lib/square/types/update_webhook_subscription_response.rb +2 -1
- data/lib/square/types/update_webhook_subscription_signature_key_response.rb +3 -1
- data/lib/square/types/upsert_booking_custom_attribute_response.rb +2 -1
- data/lib/square/types/upsert_catalog_object_response.rb +1 -3
- data/lib/square/types/upsert_customer_custom_attribute_response.rb +2 -1
- data/lib/square/types/upsert_location_custom_attribute_response.rb +2 -1
- data/lib/square/types/upsert_merchant_custom_attribute_response.rb +2 -1
- data/lib/square/types/v_1_get_payment_request.rb +23 -0
- data/lib/square/types/v_1_get_settlement_request.rb +23 -0
- data/lib/square/types/v_1_order.rb +1 -3
- data/lib/square/types/vendor_created_event_object_operation.rb +23 -0
- data/lib/square/types/vendor_updated_event_object_operation.rb +23 -0
- data/lib/square/types/wage_setting.rb +1 -3
- data/lib/square/v_1_transactions/client.rb +72 -29
- data/lib/square/vendors/client.rb +126 -51
- data/lib/square/vendors/types/batch_update_vendors_request.rb +1 -3
- data/lib/square/version.rb +1 -1
- data/lib/square/webhooks/client.rb +3 -1
- data/lib/square/webhooks/event_types/client.rb +25 -14
- data/lib/square/webhooks/subscriptions/client.rb +164 -69
- data/lib/square.rb +57 -5
- data/lib/square_legacy/utilities/webhooks_helper.rb +1 -1
- data/reference.md +29588 -0
- data/wiremock/docker-compose.test.yml +14 -0
- data/wiremock/wiremock-mappings.json +1 -0
- metadata +69 -45
- data/lib/square/mobile/client.rb +0 -50
- data/lib/square/mobile/types/create_mobile_authorization_code_request.rb +0 -11
- data/lib/square/types/create_mobile_authorization_code_response.rb +0 -13
- data/test/square/integration/client_tests/test_cash_drawers.rb +0 -27
- data/test/square/integration/client_tests/test_catalog.rb +0 -704
- data/test/square/integration/client_tests/test_customers.rb +0 -65
- data/test/square/integration/client_tests/test_customers_groups.rb +0 -144
- data/test/square/integration/client_tests/test_customers_segments.rb +0 -36
- data/test/square/integration/client_tests/test_devices.rb +0 -67
- data/test/square/integration/client_tests/test_inventory.rb +0 -28
- data/test/square/integration/client_tests/test_locations.rb +0 -18
- data/test/square/integration/client_tests/test_merchants.rb +0 -40
- data/test/square/integration/client_tests/test_mobile.rb +0 -21
- data/test/square/integration/client_tests/test_orders.rb +0 -177
- data/test/square/integration/client_tests/test_payments.rb +0 -167
- data/test/square/integration/client_tests/test_refunds.rb +0 -133
- data/test/square/integration/client_tests/test_team_members.rb +0 -97
- data/test/square/integration/client_tests/test_terminal.rb +0 -107
- data/test/square/integration/integration_test_base.rb +0 -16
- data/test/square/integration/testdata/image.jpeg +0 -0
- data/test/square/internal/multipart/test_form_data.rb +0 -311
- data/test/square/internal/types/test_array.rb +0 -37
- data/test/square/internal/types/test_boolean.rb +0 -35
- data/test/square/internal/types/test_enum.rb +0 -42
- data/test/square/internal/types/test_hash.rb +0 -50
- data/test/square/internal/types/test_model.rb +0 -105
- data/test/square/internal/types/test_union.rb +0 -52
- data/test/square/internal/types/test_utils.rb +0 -216
- data/test/square_legacy/api/api_test_base.rb +0 -27
- data/test/square_legacy/api/test_catalog_api.rb +0 -57
- data/test/square_legacy/api/test_customers_api.rb +0 -43
- data/test/square_legacy/api/test_employees_api.rb +0 -34
- data/test/square_legacy/api/test_labor_api.rb +0 -82
- data/test/square_legacy/api/test_locations_api.rb +0 -22
- data/test/square_legacy/api/test_merchants_api.rb +0 -38
- data/test/square_legacy/api/test_payments_api.rb +0 -40
- data/test/square_legacy/api/test_refunds_api.rb +0 -42
- data/test/square_legacy/http_response_catcher.rb +0 -14
- data/test/square_legacy/webhooks/test_webhooks_helper.rb +0 -153
- data/test/test_helper.rb +0 -123
data/lib/square/team/client.rb
CHANGED
|
@@ -3,87 +3,119 @@
|
|
|
3
3
|
module Square
|
|
4
4
|
module Team
|
|
5
5
|
class Client
|
|
6
|
-
# @
|
|
6
|
+
# @param client [Square::Internal::Http::RawClient]
|
|
7
|
+
#
|
|
8
|
+
# @return [void]
|
|
7
9
|
def initialize(client:)
|
|
8
10
|
@client = client
|
|
9
11
|
end
|
|
10
12
|
|
|
11
13
|
# Lists jobs in a seller account. Results are sorted by title in ascending order.
|
|
12
14
|
#
|
|
15
|
+
# @param request_options [Hash]
|
|
16
|
+
# @param params [Hash]
|
|
17
|
+
# @option request_options [String] :base_url
|
|
18
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
19
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
20
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
21
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
22
|
+
# @option params [String, nil] :cursor
|
|
23
|
+
#
|
|
13
24
|
# @return [Square::Types::ListJobsResponse]
|
|
14
25
|
def list_jobs(request_options: {}, **params)
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
].
|
|
19
|
-
|
|
20
|
-
params.except(*_query_param_names)
|
|
26
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
27
|
+
query_param_names = %i[cursor]
|
|
28
|
+
query_params = {}
|
|
29
|
+
query_params["cursor"] = params[:cursor] if params.key?(:cursor)
|
|
30
|
+
params.except(*query_param_names)
|
|
21
31
|
|
|
22
|
-
|
|
23
|
-
base_url: request_options[:base_url]
|
|
32
|
+
request = Square::Internal::JSON::Request.new(
|
|
33
|
+
base_url: request_options[:base_url],
|
|
24
34
|
method: "GET",
|
|
25
35
|
path: "v2/team-members/jobs",
|
|
26
|
-
query:
|
|
36
|
+
query: query_params,
|
|
37
|
+
request_options: request_options
|
|
27
38
|
)
|
|
28
39
|
begin
|
|
29
|
-
|
|
40
|
+
response = @client.send(request)
|
|
30
41
|
rescue Net::HTTPRequestTimeout
|
|
31
42
|
raise Square::Errors::TimeoutError
|
|
32
43
|
end
|
|
33
|
-
code =
|
|
44
|
+
code = response.code.to_i
|
|
34
45
|
if code.between?(200, 299)
|
|
35
|
-
Square::Types::ListJobsResponse.load(
|
|
46
|
+
Square::Types::ListJobsResponse.load(response.body)
|
|
36
47
|
else
|
|
37
48
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
38
|
-
raise error_class.new(
|
|
49
|
+
raise error_class.new(response.body, code: code)
|
|
39
50
|
end
|
|
40
51
|
end
|
|
41
52
|
|
|
42
53
|
# Creates a job in a seller account. A job defines a title and tip eligibility. Note that
|
|
43
54
|
# compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting.
|
|
44
55
|
#
|
|
56
|
+
# @param request_options [Hash]
|
|
57
|
+
# @param params [Square::Team::Types::CreateJobRequest]
|
|
58
|
+
# @option request_options [String] :base_url
|
|
59
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
60
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
61
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
62
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
63
|
+
#
|
|
45
64
|
# @return [Square::Types::CreateJobResponse]
|
|
46
65
|
def create_job(request_options: {}, **params)
|
|
47
|
-
|
|
48
|
-
|
|
66
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
67
|
+
request = Square::Internal::JSON::Request.new(
|
|
68
|
+
base_url: request_options[:base_url],
|
|
49
69
|
method: "POST",
|
|
50
70
|
path: "v2/team-members/jobs",
|
|
51
|
-
body: params
|
|
71
|
+
body: Square::Team::Types::CreateJobRequest.new(params).to_h,
|
|
72
|
+
request_options: request_options
|
|
52
73
|
)
|
|
53
74
|
begin
|
|
54
|
-
|
|
75
|
+
response = @client.send(request)
|
|
55
76
|
rescue Net::HTTPRequestTimeout
|
|
56
77
|
raise Square::Errors::TimeoutError
|
|
57
78
|
end
|
|
58
|
-
code =
|
|
79
|
+
code = response.code.to_i
|
|
59
80
|
if code.between?(200, 299)
|
|
60
|
-
Square::Types::CreateJobResponse.load(
|
|
81
|
+
Square::Types::CreateJobResponse.load(response.body)
|
|
61
82
|
else
|
|
62
83
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
63
|
-
raise error_class.new(
|
|
84
|
+
raise error_class.new(response.body, code: code)
|
|
64
85
|
end
|
|
65
86
|
end
|
|
66
87
|
|
|
67
88
|
# Retrieves a specified job.
|
|
68
89
|
#
|
|
90
|
+
# @param request_options [Hash]
|
|
91
|
+
# @param params [Hash]
|
|
92
|
+
# @option request_options [String] :base_url
|
|
93
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
94
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
95
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
96
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
97
|
+
# @option params [String] :job_id
|
|
98
|
+
#
|
|
69
99
|
# @return [Square::Types::RetrieveJobResponse]
|
|
70
100
|
def retrieve_job(request_options: {}, **params)
|
|
71
|
-
|
|
72
|
-
|
|
101
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
102
|
+
request = Square::Internal::JSON::Request.new(
|
|
103
|
+
base_url: request_options[:base_url],
|
|
73
104
|
method: "GET",
|
|
74
|
-
path: "v2/team-members/jobs/#{params[:job_id]}"
|
|
105
|
+
path: "v2/team-members/jobs/#{params[:job_id]}",
|
|
106
|
+
request_options: request_options
|
|
75
107
|
)
|
|
76
108
|
begin
|
|
77
|
-
|
|
109
|
+
response = @client.send(request)
|
|
78
110
|
rescue Net::HTTPRequestTimeout
|
|
79
111
|
raise Square::Errors::TimeoutError
|
|
80
112
|
end
|
|
81
|
-
code =
|
|
113
|
+
code = response.code.to_i
|
|
82
114
|
if code.between?(200, 299)
|
|
83
|
-
Square::Types::RetrieveJobResponse.load(
|
|
115
|
+
Square::Types::RetrieveJobResponse.load(response.body)
|
|
84
116
|
else
|
|
85
117
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
86
|
-
raise error_class.new(
|
|
118
|
+
raise error_class.new(response.body, code: code)
|
|
87
119
|
end
|
|
88
120
|
end
|
|
89
121
|
|
|
@@ -91,27 +123,40 @@ module Square
|
|
|
91
123
|
# `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to
|
|
92
124
|
# tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.
|
|
93
125
|
#
|
|
126
|
+
# @param request_options [Hash]
|
|
127
|
+
# @param params [Square::Team::Types::UpdateJobRequest]
|
|
128
|
+
# @option request_options [String] :base_url
|
|
129
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
130
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
131
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
132
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
133
|
+
# @option params [String] :job_id
|
|
134
|
+
#
|
|
94
135
|
# @return [Square::Types::UpdateJobResponse]
|
|
95
136
|
def update_job(request_options: {}, **params)
|
|
96
|
-
|
|
137
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
138
|
+
request_data = Square::Team::Types::UpdateJobRequest.new(params).to_h
|
|
139
|
+
non_body_param_names = ["job_id"]
|
|
140
|
+
body = request_data.except(*non_body_param_names)
|
|
97
141
|
|
|
98
|
-
|
|
99
|
-
base_url: request_options[:base_url]
|
|
142
|
+
request = Square::Internal::JSON::Request.new(
|
|
143
|
+
base_url: request_options[:base_url],
|
|
100
144
|
method: "PUT",
|
|
101
145
|
path: "v2/team-members/jobs/#{params[:job_id]}",
|
|
102
|
-
body:
|
|
146
|
+
body: body,
|
|
147
|
+
request_options: request_options
|
|
103
148
|
)
|
|
104
149
|
begin
|
|
105
|
-
|
|
150
|
+
response = @client.send(request)
|
|
106
151
|
rescue Net::HTTPRequestTimeout
|
|
107
152
|
raise Square::Errors::TimeoutError
|
|
108
153
|
end
|
|
109
|
-
code =
|
|
154
|
+
code = response.code.to_i
|
|
110
155
|
if code.between?(200, 299)
|
|
111
|
-
Square::Types::UpdateJobResponse.load(
|
|
156
|
+
Square::Types::UpdateJobResponse.load(response.body)
|
|
112
157
|
else
|
|
113
158
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
114
|
-
raise error_class.new(
|
|
159
|
+
raise error_class.new(response.body, code: code)
|
|
115
160
|
end
|
|
116
161
|
end
|
|
117
162
|
end
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
module Square
|
|
4
4
|
module TeamMembers
|
|
5
5
|
class Client
|
|
6
|
-
# @
|
|
6
|
+
# @param client [Square::Internal::Http::RawClient]
|
|
7
|
+
#
|
|
8
|
+
# @return [void]
|
|
7
9
|
def initialize(client:)
|
|
8
10
|
@client = client
|
|
9
11
|
end
|
|
@@ -13,27 +15,38 @@ module Square
|
|
|
13
15
|
# - `given_name`
|
|
14
16
|
# - `family_name`
|
|
15
17
|
#
|
|
16
|
-
# Learn about [Troubleshooting the Team
|
|
18
|
+
# Learn about [Troubleshooting the Team
|
|
19
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).
|
|
20
|
+
#
|
|
21
|
+
# @param request_options [Hash]
|
|
22
|
+
# @param params [Square::Types::CreateTeamMemberRequest]
|
|
23
|
+
# @option request_options [String] :base_url
|
|
24
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
25
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
26
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
27
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
17
28
|
#
|
|
18
29
|
# @return [Square::Types::CreateTeamMemberResponse]
|
|
19
30
|
def create(request_options: {}, **params)
|
|
20
|
-
|
|
21
|
-
|
|
31
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
32
|
+
request = Square::Internal::JSON::Request.new(
|
|
33
|
+
base_url: request_options[:base_url],
|
|
22
34
|
method: "POST",
|
|
23
35
|
path: "v2/team-members",
|
|
24
|
-
body: Square::Types::CreateTeamMemberRequest.new(params).to_h
|
|
36
|
+
body: Square::Types::CreateTeamMemberRequest.new(params).to_h,
|
|
37
|
+
request_options: request_options
|
|
25
38
|
)
|
|
26
39
|
begin
|
|
27
|
-
|
|
40
|
+
response = @client.send(request)
|
|
28
41
|
rescue Net::HTTPRequestTimeout
|
|
29
42
|
raise Square::Errors::TimeoutError
|
|
30
43
|
end
|
|
31
|
-
code =
|
|
44
|
+
code = response.code.to_i
|
|
32
45
|
if code.between?(200, 299)
|
|
33
|
-
Square::Types::CreateTeamMemberResponse.load(
|
|
46
|
+
Square::Types::CreateTeamMemberResponse.load(response.body)
|
|
34
47
|
else
|
|
35
48
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
36
|
-
raise error_class.new(
|
|
49
|
+
raise error_class.new(response.body, code: code)
|
|
37
50
|
end
|
|
38
51
|
end
|
|
39
52
|
|
|
@@ -42,27 +55,38 @@ module Square
|
|
|
42
55
|
# the request cannot be successfully processed, the request is not marked as failed, but the body of the response
|
|
43
56
|
# contains explicit error information for the failed create.
|
|
44
57
|
#
|
|
45
|
-
# Learn about [Troubleshooting the Team
|
|
58
|
+
# Learn about [Troubleshooting the Team
|
|
59
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members).
|
|
60
|
+
#
|
|
61
|
+
# @param request_options [Hash]
|
|
62
|
+
# @param params [Square::TeamMembers::Types::BatchCreateTeamMembersRequest]
|
|
63
|
+
# @option request_options [String] :base_url
|
|
64
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
65
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
66
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
67
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
46
68
|
#
|
|
47
69
|
# @return [Square::Types::BatchCreateTeamMembersResponse]
|
|
48
70
|
def batch_create(request_options: {}, **params)
|
|
49
|
-
|
|
50
|
-
|
|
71
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
72
|
+
request = Square::Internal::JSON::Request.new(
|
|
73
|
+
base_url: request_options[:base_url],
|
|
51
74
|
method: "POST",
|
|
52
75
|
path: "v2/team-members/bulk-create",
|
|
53
|
-
body: params
|
|
76
|
+
body: Square::TeamMembers::Types::BatchCreateTeamMembersRequest.new(params).to_h,
|
|
77
|
+
request_options: request_options
|
|
54
78
|
)
|
|
55
79
|
begin
|
|
56
|
-
|
|
80
|
+
response = @client.send(request)
|
|
57
81
|
rescue Net::HTTPRequestTimeout
|
|
58
82
|
raise Square::Errors::TimeoutError
|
|
59
83
|
end
|
|
60
|
-
code =
|
|
84
|
+
code = response.code.to_i
|
|
61
85
|
if code.between?(200, 299)
|
|
62
|
-
Square::Types::BatchCreateTeamMembersResponse.load(
|
|
86
|
+
Square::Types::BatchCreateTeamMembersResponse.load(response.body)
|
|
63
87
|
else
|
|
64
88
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
65
|
-
raise error_class.new(
|
|
89
|
+
raise error_class.new(response.body, code: code)
|
|
66
90
|
end
|
|
67
91
|
end
|
|
68
92
|
|
|
@@ -70,27 +94,38 @@ module Square
|
|
|
70
94
|
# This process is non-transactional and processes as much of the request as possible. If one of the updates in
|
|
71
95
|
# the request cannot be successfully processed, the request is not marked as failed, but the body of the response
|
|
72
96
|
# contains explicit error information for the failed update.
|
|
73
|
-
# Learn about [Troubleshooting the Team
|
|
97
|
+
# Learn about [Troubleshooting the Team
|
|
98
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members).
|
|
99
|
+
#
|
|
100
|
+
# @param request_options [Hash]
|
|
101
|
+
# @param params [Square::TeamMembers::Types::BatchUpdateTeamMembersRequest]
|
|
102
|
+
# @option request_options [String] :base_url
|
|
103
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
104
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
105
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
106
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
74
107
|
#
|
|
75
108
|
# @return [Square::Types::BatchUpdateTeamMembersResponse]
|
|
76
109
|
def batch_update(request_options: {}, **params)
|
|
77
|
-
|
|
78
|
-
|
|
110
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
111
|
+
request = Square::Internal::JSON::Request.new(
|
|
112
|
+
base_url: request_options[:base_url],
|
|
79
113
|
method: "POST",
|
|
80
114
|
path: "v2/team-members/bulk-update",
|
|
81
|
-
body: params
|
|
115
|
+
body: Square::TeamMembers::Types::BatchUpdateTeamMembersRequest.new(params).to_h,
|
|
116
|
+
request_options: request_options
|
|
82
117
|
)
|
|
83
118
|
begin
|
|
84
|
-
|
|
119
|
+
response = @client.send(request)
|
|
85
120
|
rescue Net::HTTPRequestTimeout
|
|
86
121
|
raise Square::Errors::TimeoutError
|
|
87
122
|
end
|
|
88
|
-
code =
|
|
123
|
+
code = response.code.to_i
|
|
89
124
|
if code.between?(200, 299)
|
|
90
|
-
Square::Types::BatchUpdateTeamMembersResponse.load(
|
|
125
|
+
Square::Types::BatchUpdateTeamMembersResponse.load(response.body)
|
|
91
126
|
else
|
|
92
127
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
93
|
-
raise error_class.new(
|
|
128
|
+
raise error_class.new(response.body, code: code)
|
|
94
129
|
end
|
|
95
130
|
end
|
|
96
131
|
|
|
@@ -98,76 +133,111 @@ module Square
|
|
|
98
133
|
# The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether
|
|
99
134
|
# the team member is the Square account owner.
|
|
100
135
|
#
|
|
136
|
+
# @param request_options [Hash]
|
|
137
|
+
# @param params [Square::TeamMembers::Types::SearchTeamMembersRequest]
|
|
138
|
+
# @option request_options [String] :base_url
|
|
139
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
140
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
141
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
142
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
143
|
+
#
|
|
101
144
|
# @return [Square::Types::SearchTeamMembersResponse]
|
|
102
145
|
def search(request_options: {}, **params)
|
|
103
|
-
|
|
104
|
-
|
|
146
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
147
|
+
request = Square::Internal::JSON::Request.new(
|
|
148
|
+
base_url: request_options[:base_url],
|
|
105
149
|
method: "POST",
|
|
106
150
|
path: "v2/team-members/search",
|
|
107
|
-
body: params
|
|
151
|
+
body: Square::TeamMembers::Types::SearchTeamMembersRequest.new(params).to_h,
|
|
152
|
+
request_options: request_options
|
|
108
153
|
)
|
|
109
154
|
begin
|
|
110
|
-
|
|
155
|
+
response = @client.send(request)
|
|
111
156
|
rescue Net::HTTPRequestTimeout
|
|
112
157
|
raise Square::Errors::TimeoutError
|
|
113
158
|
end
|
|
114
|
-
code =
|
|
159
|
+
code = response.code.to_i
|
|
115
160
|
if code.between?(200, 299)
|
|
116
|
-
Square::Types::SearchTeamMembersResponse.load(
|
|
161
|
+
Square::Types::SearchTeamMembersResponse.load(response.body)
|
|
117
162
|
else
|
|
118
163
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
119
|
-
raise error_class.new(
|
|
164
|
+
raise error_class.new(response.body, code: code)
|
|
120
165
|
end
|
|
121
166
|
end
|
|
122
167
|
|
|
123
168
|
# Retrieves a `TeamMember` object for the given `TeamMember.id`.
|
|
124
|
-
# Learn about [Troubleshooting the Team
|
|
169
|
+
# Learn about [Troubleshooting the Team
|
|
170
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).
|
|
171
|
+
#
|
|
172
|
+
# @param request_options [Hash]
|
|
173
|
+
# @param params [Hash]
|
|
174
|
+
# @option request_options [String] :base_url
|
|
175
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
176
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
177
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
178
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
179
|
+
# @option params [String] :team_member_id
|
|
125
180
|
#
|
|
126
181
|
# @return [Square::Types::GetTeamMemberResponse]
|
|
127
182
|
def get(request_options: {}, **params)
|
|
128
|
-
|
|
129
|
-
|
|
183
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
184
|
+
request = Square::Internal::JSON::Request.new(
|
|
185
|
+
base_url: request_options[:base_url],
|
|
130
186
|
method: "GET",
|
|
131
|
-
path: "v2/team-members/#{params[:team_member_id]}"
|
|
187
|
+
path: "v2/team-members/#{params[:team_member_id]}",
|
|
188
|
+
request_options: request_options
|
|
132
189
|
)
|
|
133
190
|
begin
|
|
134
|
-
|
|
191
|
+
response = @client.send(request)
|
|
135
192
|
rescue Net::HTTPRequestTimeout
|
|
136
193
|
raise Square::Errors::TimeoutError
|
|
137
194
|
end
|
|
138
|
-
code =
|
|
195
|
+
code = response.code.to_i
|
|
139
196
|
if code.between?(200, 299)
|
|
140
|
-
Square::Types::GetTeamMemberResponse.load(
|
|
197
|
+
Square::Types::GetTeamMemberResponse.load(response.body)
|
|
141
198
|
else
|
|
142
199
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
143
|
-
raise error_class.new(
|
|
200
|
+
raise error_class.new(response.body, code: code)
|
|
144
201
|
end
|
|
145
202
|
end
|
|
146
203
|
|
|
147
204
|
# Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.
|
|
148
|
-
# Learn about [Troubleshooting the Team
|
|
205
|
+
# Learn about [Troubleshooting the Team
|
|
206
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).
|
|
207
|
+
#
|
|
208
|
+
# @param request_options [Hash]
|
|
209
|
+
# @param params [Square::Types::UpdateTeamMemberRequest]
|
|
210
|
+
# @option request_options [String] :base_url
|
|
211
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
212
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
213
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
214
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
215
|
+
# @option params [String] :team_member_id
|
|
149
216
|
#
|
|
150
217
|
# @return [Square::Types::UpdateTeamMemberResponse]
|
|
151
218
|
def update(request_options: {}, **params)
|
|
152
|
-
|
|
219
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
220
|
+
path_param_names = %i[team_member_id]
|
|
221
|
+
body_params = params.except(*path_param_names)
|
|
153
222
|
|
|
154
|
-
|
|
155
|
-
base_url: request_options[:base_url]
|
|
223
|
+
request = Square::Internal::JSON::Request.new(
|
|
224
|
+
base_url: request_options[:base_url],
|
|
156
225
|
method: "PUT",
|
|
157
226
|
path: "v2/team-members/#{params[:team_member_id]}",
|
|
158
|
-
body:
|
|
227
|
+
body: Square::Types::UpdateTeamMemberRequest.new(body_params).to_h,
|
|
228
|
+
request_options: request_options
|
|
159
229
|
)
|
|
160
230
|
begin
|
|
161
|
-
|
|
231
|
+
response = @client.send(request)
|
|
162
232
|
rescue Net::HTTPRequestTimeout
|
|
163
233
|
raise Square::Errors::TimeoutError
|
|
164
234
|
end
|
|
165
|
-
code =
|
|
235
|
+
code = response.code.to_i
|
|
166
236
|
if code.between?(200, 299)
|
|
167
|
-
Square::Types::UpdateTeamMemberResponse.load(
|
|
237
|
+
Square::Types::UpdateTeamMemberResponse.load(response.body)
|
|
168
238
|
else
|
|
169
239
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
170
|
-
raise error_class.new(
|
|
240
|
+
raise error_class.new(response.body, code: code)
|
|
171
241
|
end
|
|
172
242
|
end
|
|
173
243
|
|
|
@@ -4,9 +4,7 @@ module Square
|
|
|
4
4
|
module TeamMembers
|
|
5
5
|
module Types
|
|
6
6
|
class BatchCreateTeamMembersRequest < Internal::Types::Model
|
|
7
|
-
field :team_members,
|
|
8
|
-
Internal::Types::Hash[String, Square::Types::CreateTeamMemberRequest]
|
|
9
|
-
}, optional: false, nullable: false
|
|
7
|
+
field :team_members, -> { Internal::Types::Hash[String, Square::Types::CreateTeamMemberRequest] }, optional: false, nullable: false
|
|
10
8
|
end
|
|
11
9
|
end
|
|
12
10
|
end
|
|
@@ -4,9 +4,7 @@ module Square
|
|
|
4
4
|
module TeamMembers
|
|
5
5
|
module Types
|
|
6
6
|
class BatchUpdateTeamMembersRequest < Internal::Types::Model
|
|
7
|
-
field :team_members,
|
|
8
|
-
Internal::Types::Hash[String, Square::Types::UpdateTeamMemberRequest]
|
|
9
|
-
}, optional: false, nullable: false
|
|
7
|
+
field :team_members, -> { Internal::Types::Hash[String, Square::Types::UpdateTeamMemberRequest] }, optional: false, nullable: false
|
|
10
8
|
end
|
|
11
9
|
end
|
|
12
10
|
end
|
|
@@ -4,7 +4,9 @@ module Square
|
|
|
4
4
|
module TeamMembers
|
|
5
5
|
module WageSetting
|
|
6
6
|
class Client
|
|
7
|
-
# @
|
|
7
|
+
# @param client [Square::Internal::Http::RawClient]
|
|
8
|
+
#
|
|
9
|
+
# @return [void]
|
|
8
10
|
def initialize(client:)
|
|
9
11
|
@client = client
|
|
10
12
|
end
|
|
@@ -13,27 +15,39 @@ module Square
|
|
|
13
15
|
# by `TeamMember.id`. For more information, see
|
|
14
16
|
# [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).
|
|
15
17
|
#
|
|
16
|
-
# Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or
|
|
18
|
+
# Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or
|
|
19
|
+
# [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers)
|
|
17
20
|
# to get this information directly from the `TeamMember.wage_setting` field.
|
|
18
21
|
#
|
|
22
|
+
# @param request_options [Hash]
|
|
23
|
+
# @param params [Hash]
|
|
24
|
+
# @option request_options [String] :base_url
|
|
25
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
26
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
27
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
28
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
29
|
+
# @option params [String] :team_member_id
|
|
30
|
+
#
|
|
19
31
|
# @return [Square::Types::GetWageSettingResponse]
|
|
20
32
|
def get(request_options: {}, **params)
|
|
21
|
-
|
|
22
|
-
|
|
33
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
34
|
+
request = Square::Internal::JSON::Request.new(
|
|
35
|
+
base_url: request_options[:base_url],
|
|
23
36
|
method: "GET",
|
|
24
|
-
path: "v2/team-members/#{params[:team_member_id]}/wage-setting"
|
|
37
|
+
path: "v2/team-members/#{params[:team_member_id]}/wage-setting",
|
|
38
|
+
request_options: request_options
|
|
25
39
|
)
|
|
26
40
|
begin
|
|
27
|
-
|
|
41
|
+
response = @client.send(request)
|
|
28
42
|
rescue Net::HTTPRequestTimeout
|
|
29
43
|
raise Square::Errors::TimeoutError
|
|
30
44
|
end
|
|
31
|
-
code =
|
|
45
|
+
code = response.code.to_i
|
|
32
46
|
if code.between?(200, 299)
|
|
33
|
-
Square::Types::GetWageSettingResponse.load(
|
|
47
|
+
Square::Types::GetWageSettingResponse.load(response.body)
|
|
34
48
|
else
|
|
35
49
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
36
|
-
raise error_class.new(
|
|
50
|
+
raise error_class.new(response.body, code: code)
|
|
37
51
|
end
|
|
38
52
|
end
|
|
39
53
|
|
|
@@ -41,32 +55,47 @@ module Square
|
|
|
41
55
|
# `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise,
|
|
42
56
|
# it fully replaces the `WageSetting` object for the team member.
|
|
43
57
|
# The `WageSetting` is returned on a successful update. For more information, see
|
|
44
|
-
# [Troubleshooting the Team
|
|
58
|
+
# [Troubleshooting the Team
|
|
59
|
+
# API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).
|
|
45
60
|
#
|
|
46
|
-
# Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or
|
|
61
|
+
# Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or
|
|
62
|
+
# [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember)
|
|
47
63
|
# to manage the `TeamMember.wage_setting` field directly.
|
|
48
64
|
#
|
|
65
|
+
# @param request_options [Hash]
|
|
66
|
+
# @param params [Square::TeamMembers::WageSetting::Types::UpdateWageSettingRequest]
|
|
67
|
+
# @option request_options [String] :base_url
|
|
68
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
69
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
70
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
71
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
72
|
+
# @option params [String] :team_member_id
|
|
73
|
+
#
|
|
49
74
|
# @return [Square::Types::UpdateWageSettingResponse]
|
|
50
75
|
def update(request_options: {}, **params)
|
|
51
|
-
|
|
76
|
+
params = Square::Internal::Types::Utils.normalize_keys(params)
|
|
77
|
+
request_data = Square::TeamMembers::WageSetting::Types::UpdateWageSettingRequest.new(params).to_h
|
|
78
|
+
non_body_param_names = ["team_member_id"]
|
|
79
|
+
body = request_data.except(*non_body_param_names)
|
|
52
80
|
|
|
53
|
-
|
|
54
|
-
base_url: request_options[:base_url]
|
|
81
|
+
request = Square::Internal::JSON::Request.new(
|
|
82
|
+
base_url: request_options[:base_url],
|
|
55
83
|
method: "PUT",
|
|
56
84
|
path: "v2/team-members/#{params[:team_member_id]}/wage-setting",
|
|
57
|
-
body:
|
|
85
|
+
body: body,
|
|
86
|
+
request_options: request_options
|
|
58
87
|
)
|
|
59
88
|
begin
|
|
60
|
-
|
|
89
|
+
response = @client.send(request)
|
|
61
90
|
rescue Net::HTTPRequestTimeout
|
|
62
91
|
raise Square::Errors::TimeoutError
|
|
63
92
|
end
|
|
64
|
-
code =
|
|
93
|
+
code = response.code.to_i
|
|
65
94
|
if code.between?(200, 299)
|
|
66
|
-
Square::Types::UpdateWageSettingResponse.load(
|
|
95
|
+
Square::Types::UpdateWageSettingResponse.load(response.body)
|
|
67
96
|
else
|
|
68
97
|
error_class = Square::Errors::ResponseError.subclass_for_code(code)
|
|
69
|
-
raise error_class.new(
|
|
98
|
+
raise error_class.new(response.body, code: code)
|
|
70
99
|
end
|
|
71
100
|
end
|
|
72
101
|
end
|