square.rb 44.1.0.20250924 → 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.
Files changed (541) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +9 -0
  3. data/.fernignore +20 -0
  4. data/.rubocop.yml +60 -0
  5. data/LICENSE +1 -1
  6. data/Rakefile +29 -0
  7. data/custom.gemspec.rb +19 -0
  8. data/lib/square/apple_pay/client.rb +24 -10
  9. data/lib/square/bank_accounts/client.rb +144 -31
  10. data/lib/square/bank_accounts/types/create_bank_account_request.rb +13 -0
  11. data/lib/square/bank_accounts/types/disable_bank_account_request.rb +11 -0
  12. data/lib/square/bank_accounts/types/get_by_v_1_id_bank_accounts_request.rb +1 -1
  13. data/lib/square/bank_accounts/types/list_bank_accounts_request.rb +1 -0
  14. data/lib/square/bookings/client.rb +238 -100
  15. data/lib/square/bookings/custom_attribute_definitions/client.rb +139 -67
  16. data/lib/square/bookings/custom_attribute_definitions/types/create_booking_custom_attribute_definition_request.rb +1 -3
  17. data/lib/square/bookings/custom_attribute_definitions/types/update_booking_custom_attribute_definition_request.rb +1 -3
  18. data/lib/square/bookings/custom_attributes/client.rb +168 -76
  19. data/lib/square/bookings/custom_attributes/types/bulk_delete_booking_custom_attributes_request.rb +1 -3
  20. data/lib/square/bookings/custom_attributes/types/bulk_upsert_booking_custom_attributes_request.rb +1 -3
  21. data/lib/square/bookings/location_profiles/client.rb +44 -24
  22. data/lib/square/bookings/team_member_profiles/client.rb +66 -31
  23. data/lib/square/cards/client.rb +103 -45
  24. data/lib/square/cash_drawers/client.rb +3 -1
  25. data/lib/square/cash_drawers/shifts/client.rb +121 -61
  26. data/lib/square/catalog/client.rb +203 -91
  27. data/lib/square/catalog/images/client.rb +50 -20
  28. data/lib/square/catalog/object/client.rb +66 -29
  29. data/lib/square/catalog/object/types/delete_object_request.rb +1 -1
  30. data/lib/square/catalog/object/types/get_object_request.rb +1 -1
  31. data/lib/square/catalog/types/batch_upsert_catalog_objects_request.rb +1 -3
  32. data/lib/square/catalog/types/search_catalog_items_request.rb +3 -9
  33. data/lib/square/catalog/types/search_catalog_objects_request.rb +1 -3
  34. data/lib/square/channels/client.rb +131 -0
  35. data/lib/square/channels/types/bulk_retrieve_channels_request.rb +11 -0
  36. data/lib/square/channels/types/get_channels_request.rb +11 -0
  37. data/lib/square/channels/types/list_channels_request.rb +15 -0
  38. data/lib/square/checkout/client.rb +77 -31
  39. data/lib/square/checkout/payment_links/client.rb +120 -54
  40. data/lib/square/client.rb +18 -10
  41. data/lib/square/customers/cards/client.rb +43 -16
  42. data/lib/square/customers/client.rb +220 -97
  43. data/lib/square/customers/custom_attribute_definitions/client.rb +157 -74
  44. data/lib/square/customers/custom_attribute_definitions/types/batch_upsert_customer_custom_attributes_request.rb +1 -3
  45. data/lib/square/customers/custom_attribute_definitions/types/create_customer_custom_attribute_definition_request.rb +1 -3
  46. data/lib/square/customers/custom_attribute_definitions/types/update_customer_custom_attribute_definition_request.rb +1 -3
  47. data/lib/square/customers/custom_attributes/client.rb +117 -53
  48. data/lib/square/customers/groups/client.rb +156 -67
  49. data/lib/square/customers/segments/client.rb +62 -31
  50. data/lib/square/customers/types/bulk_create_customers_request.rb +1 -3
  51. data/lib/square/customers/types/bulk_update_customers_request.rb +1 -3
  52. data/lib/square/devices/client.rb +66 -31
  53. data/lib/square/devices/codes/client.rb +83 -38
  54. data/lib/square/disputes/client.rb +140 -60
  55. data/lib/square/disputes/evidence/client.rb +83 -39
  56. data/lib/square/employees/client.rb +66 -31
  57. data/lib/square/events/client.rb +80 -38
  58. data/lib/square/file_param.rb +77 -77
  59. data/lib/square/gift_cards/activities/client.rb +73 -31
  60. data/lib/square/gift_cards/client.rb +163 -69
  61. data/lib/square/internal/http/base_request.rb +6 -0
  62. data/lib/square/internal/http/raw_client.rb +111 -20
  63. data/lib/square/internal/iterators/cursor_item_iterator.rb +28 -0
  64. data/lib/square/internal/iterators/cursor_page_iterator.rb +51 -0
  65. data/lib/square/internal/iterators/item_iterator.rb +65 -0
  66. data/lib/square/internal/iterators/offset_item_iterator.rb +30 -0
  67. data/lib/square/internal/iterators/offset_page_iterator.rb +83 -0
  68. data/lib/square/internal/json/request.rb +2 -1
  69. data/lib/square/internal/multipart/multipart_request.rb +2 -1
  70. data/lib/square/internal/types/enum.rb +8 -0
  71. data/lib/square/internal/types/model/field.rb +11 -1
  72. data/lib/square/internal/types/model.rb +14 -4
  73. data/lib/square/internal/types/union.rb +88 -7
  74. data/lib/square/internal/types/utils.rb +20 -4
  75. data/lib/square/inventory/client.rb +100 -76
  76. data/lib/square/invoices/client.rb +228 -99
  77. data/lib/square/labor/break_types/client.rb +120 -53
  78. data/lib/square/labor/client.rb +205 -81
  79. data/lib/square/labor/employee_wages/client.rb +64 -31
  80. data/lib/square/labor/shifts/client.rb +94 -37
  81. data/lib/square/labor/team_member_wages/client.rb +64 -31
  82. data/lib/square/labor/types/bulk_publish_scheduled_shifts_request.rb +2 -6
  83. data/lib/square/labor/types/publish_scheduled_shift_request.rb +1 -3
  84. data/lib/square/labor/workweek_configs/client.rb +65 -32
  85. data/lib/square/locations/client.rb +102 -41
  86. data/lib/square/locations/custom_attribute_definitions/client.rb +135 -64
  87. data/lib/square/locations/custom_attribute_definitions/types/create_location_custom_attribute_definition_request.rb +1 -3
  88. data/lib/square/locations/custom_attribute_definitions/types/update_location_custom_attribute_definition_request.rb +1 -3
  89. data/lib/square/locations/custom_attributes/client.rb +156 -68
  90. data/lib/square/locations/custom_attributes/types/bulk_delete_location_custom_attributes_request.rb +1 -3
  91. data/lib/square/locations/custom_attributes/types/bulk_upsert_location_custom_attributes_request.rb +1 -3
  92. data/lib/square/locations/transactions/client.rb +93 -37
  93. data/lib/square/locations/types/create_checkout_request.rb +1 -3
  94. data/lib/square/loyalty/accounts/client.rb +109 -44
  95. data/lib/square/loyalty/accounts/types/search_loyalty_accounts_request.rb +1 -3
  96. data/lib/square/loyalty/client.rb +20 -8
  97. data/lib/square/loyalty/programs/client.rb +72 -29
  98. data/lib/square/loyalty/programs/promotions/client.rb +106 -46
  99. data/lib/square/loyalty/programs/promotions/types/cancel_promotions_request.rb +1 -1
  100. data/lib/square/loyalty/programs/promotions/types/get_promotions_request.rb +1 -1
  101. data/lib/square/loyalty/rewards/client.rb +96 -38
  102. data/lib/square/loyalty/rewards/types/search_loyalty_rewards_request.rb +1 -3
  103. data/lib/square/merchants/client.rb +60 -31
  104. data/lib/square/merchants/custom_attribute_definitions/client.rb +137 -65
  105. data/lib/square/merchants/custom_attribute_definitions/types/create_merchant_custom_attribute_definition_request.rb +1 -3
  106. data/lib/square/merchants/custom_attribute_definitions/types/update_merchant_custom_attribute_definition_request.rb +1 -3
  107. data/lib/square/merchants/custom_attributes/client.rb +156 -68
  108. data/lib/square/merchants/custom_attributes/types/bulk_delete_merchant_custom_attributes_request.rb +1 -3
  109. data/lib/square/merchants/custom_attributes/types/bulk_upsert_merchant_custom_attributes_request.rb +1 -3
  110. data/lib/square/o_auth/client.rb +76 -31
  111. data/lib/square/o_auth/types/obtain_token_request.rb +1 -0
  112. data/lib/square/orders/client.rb +156 -63
  113. data/lib/square/orders/custom_attribute_definitions/client.rb +137 -65
  114. data/lib/square/orders/custom_attribute_definitions/types/create_order_custom_attribute_definition_request.rb +1 -3
  115. data/lib/square/orders/custom_attribute_definitions/types/update_order_custom_attribute_definition_request.rb +1 -3
  116. data/lib/square/orders/custom_attributes/client.rb +159 -69
  117. data/lib/square/orders/custom_attributes/types/bulk_delete_order_custom_attributes_request.rb +1 -3
  118. data/lib/square/orders/custom_attributes/types/bulk_upsert_order_custom_attributes_request.rb +1 -3
  119. data/lib/square/orders/types/calculate_order_request.rb +1 -3
  120. data/lib/square/payments/client.rb +182 -70
  121. data/lib/square/payouts/client.rb +116 -54
  122. data/lib/square/refunds/client.rb +97 -40
  123. data/lib/square/refunds/types/refund_payment_request.rb +1 -3
  124. data/lib/square/sites/client.rb +26 -11
  125. data/lib/square/snippets/client.rb +73 -28
  126. data/lib/square/subscriptions/client.rb +271 -117
  127. data/lib/square/team/client.rb +81 -36
  128. data/lib/square/team_members/client.rb +119 -49
  129. data/lib/square/team_members/types/batch_create_team_members_request.rb +1 -3
  130. data/lib/square/team_members/types/batch_update_team_members_request.rb +1 -3
  131. data/lib/square/team_members/wage_setting/client.rb +48 -19
  132. data/lib/square/terminal/actions/client.rb +75 -30
  133. data/lib/square/terminal/checkouts/client.rb +76 -30
  134. data/lib/square/terminal/client.rb +60 -23
  135. data/lib/square/terminal/refunds/client.rb +78 -31
  136. data/lib/square/transfer_orders/client.rb +292 -0
  137. data/lib/square/transfer_orders/types/cancel_transfer_order_request.rb +13 -0
  138. data/lib/square/transfer_orders/types/create_transfer_order_request.rb +12 -0
  139. data/lib/square/transfer_orders/types/delete_transfer_orders_request.rb +12 -0
  140. data/lib/square/transfer_orders/types/get_transfer_orders_request.rb +11 -0
  141. data/lib/square/transfer_orders/types/receive_transfer_order_request.rb +14 -0
  142. data/lib/square/transfer_orders/types/search_transfer_orders_request.rb +13 -0
  143. data/lib/square/transfer_orders/types/start_transfer_order_request.rb +13 -0
  144. data/lib/square/transfer_orders/types/update_transfer_order_request.rb +14 -0
  145. data/lib/square/types/address.rb +2 -1
  146. data/lib/square/types/application_details.rb +1 -3
  147. data/lib/square/types/application_type.rb +23 -0
  148. data/lib/square/types/availability.rb +3 -4
  149. data/lib/square/types/bank_account.rb +1 -0
  150. data/lib/square/types/batch_create_team_members_response.rb +1 -3
  151. data/lib/square/types/batch_create_vendors_response.rb +1 -3
  152. data/lib/square/types/batch_get_catalog_objects_response.rb +1 -3
  153. data/lib/square/types/batch_get_vendors_response.rb +1 -3
  154. data/lib/square/types/batch_update_team_members_response.rb +1 -3
  155. data/lib/square/types/batch_update_vendors_response.rb +1 -3
  156. data/lib/square/types/batch_upsert_catalog_objects_response.rb +1 -3
  157. data/lib/square/types/batch_upsert_customer_custom_attributes_request_customer_custom_attribute_upsert_request.rb +2 -1
  158. data/lib/square/types/batch_upsert_customer_custom_attributes_response.rb +4 -4
  159. data/lib/square/types/batch_upsert_customer_custom_attributes_response_customer_custom_attribute_upsert_response.rb +3 -1
  160. data/lib/square/types/booking.rb +2 -6
  161. data/lib/square/types/booking_created_event.rb +2 -1
  162. data/lib/square/types/booking_custom_attribute_definition_visible_created_event.rb +2 -1
  163. data/lib/square/types/booking_custom_attribute_definition_visible_deleted_event.rb +2 -1
  164. data/lib/square/types/booking_custom_attribute_definition_visible_updated_event.rb +2 -1
  165. data/lib/square/types/booking_custom_attribute_delete_request.rb +4 -2
  166. data/lib/square/types/booking_custom_attribute_delete_response.rb +3 -1
  167. data/lib/square/types/booking_custom_attribute_upsert_request.rb +2 -1
  168. data/lib/square/types/booking_custom_attribute_upsert_response.rb +3 -1
  169. data/lib/square/types/booking_updated_event.rb +2 -1
  170. data/lib/square/types/bulk_create_customers_response.rb +1 -3
  171. data/lib/square/types/bulk_delete_booking_custom_attributes_response.rb +4 -4
  172. data/lib/square/types/bulk_delete_customers_response.rb +1 -3
  173. data/lib/square/types/bulk_delete_location_custom_attributes_request_location_custom_attribute_delete_request.rb +2 -1
  174. data/lib/square/types/bulk_delete_location_custom_attributes_response.rb +4 -4
  175. data/lib/square/types/bulk_delete_location_custom_attributes_response_location_custom_attribute_delete_response.rb +2 -1
  176. data/lib/square/types/bulk_delete_merchant_custom_attributes_request_merchant_custom_attribute_delete_request.rb +2 -1
  177. data/lib/square/types/bulk_delete_merchant_custom_attributes_response.rb +4 -4
  178. data/lib/square/types/bulk_delete_merchant_custom_attributes_response_merchant_custom_attribute_delete_response.rb +2 -1
  179. data/lib/square/types/bulk_delete_order_custom_attributes_response.rb +1 -3
  180. data/lib/square/types/bulk_publish_scheduled_shifts_response.rb +1 -3
  181. data/lib/square/types/bulk_retrieve_bookings_response.rb +1 -3
  182. data/lib/square/types/bulk_retrieve_channels_request_constants.rb +23 -0
  183. data/lib/square/types/bulk_retrieve_channels_response.rb +12 -0
  184. data/lib/square/types/bulk_retrieve_customers_response.rb +1 -3
  185. data/lib/square/types/bulk_retrieve_team_member_booking_profiles_response.rb +3 -4
  186. data/lib/square/types/bulk_update_customers_response.rb +1 -3
  187. data/lib/square/types/bulk_upsert_booking_custom_attributes_response.rb +4 -4
  188. data/lib/square/types/bulk_upsert_location_custom_attributes_request_location_custom_attribute_upsert_request.rb +2 -1
  189. data/lib/square/types/bulk_upsert_location_custom_attributes_response.rb +4 -4
  190. data/lib/square/types/bulk_upsert_location_custom_attributes_response_location_custom_attribute_upsert_response.rb +3 -1
  191. data/lib/square/types/bulk_upsert_merchant_custom_attributes_request_merchant_custom_attribute_upsert_request.rb +2 -1
  192. data/lib/square/types/bulk_upsert_merchant_custom_attributes_response.rb +4 -4
  193. data/lib/square/types/bulk_upsert_merchant_custom_attributes_response_merchant_custom_attribute_upsert_response.rb +3 -1
  194. data/lib/square/types/bulk_upsert_order_custom_attributes_response.rb +1 -3
  195. data/lib/square/types/business_appointment_settings.rb +4 -12
  196. data/lib/square/types/business_booking_profile.rb +2 -6
  197. data/lib/square/types/buy_now_pay_later_details.rb +1 -0
  198. data/lib/square/types/cancel_transfer_order_response.rb +11 -0
  199. data/lib/square/types/card.rb +2 -0
  200. data/lib/square/types/card_issuer_alert.rb +23 -0
  201. data/lib/square/types/catalog_category.rb +1 -3
  202. data/lib/square/types/catalog_custom_attribute_definition.rb +6 -18
  203. data/lib/square/types/catalog_custom_attribute_definition_selection_config.rb +1 -3
  204. data/lib/square/types/catalog_id_mapping.rb +1 -1
  205. data/lib/square/types/catalog_info_response.rb +1 -3
  206. data/lib/square/types/catalog_item.rb +6 -12
  207. data/lib/square/types/catalog_item_food_and_beverage_details.rb +2 -6
  208. data/lib/square/types/catalog_item_food_and_beverage_details_dietary_preference.rb +2 -6
  209. data/lib/square/types/catalog_item_food_and_beverage_details_ingredient.rb +2 -6
  210. data/lib/square/types/catalog_item_modifier_list_info.rb +6 -9
  211. data/lib/square/types/catalog_item_variation.rb +17 -13
  212. data/lib/square/types/catalog_modifier.rb +4 -4
  213. data/lib/square/types/catalog_modifier_list.rb +4 -2
  214. data/lib/square/types/catalog_modifier_override.rb +2 -2
  215. data/lib/square/types/catalog_modifier_toggle_override_type.rb +13 -0
  216. data/lib/square/types/catalog_object.rb +7 -3
  217. data/lib/square/types/catalog_object_base.rb +2 -4
  218. data/lib/square/types/catalog_object_category.rb +3 -4
  219. data/lib/square/types/catalog_object_custom_attribute_definition.rb +1 -3
  220. data/lib/square/types/catalog_object_quick_amounts_settings.rb +1 -3
  221. data/lib/square/types/catalog_object_reference.rb +1 -1
  222. data/lib/square/types/catalog_object_subscription_plan_variation.rb +1 -3
  223. data/lib/square/types/catalog_query.rb +11 -13
  224. data/lib/square/types/catalog_query_prefix.rb +2 -1
  225. data/lib/square/types/catalog_query_text.rb +2 -1
  226. data/lib/square/types/catalog_subscription_plan.rb +5 -5
  227. data/lib/square/types/catalog_subscription_plan_variation.rb +4 -2
  228. data/lib/square/types/catalog_v_1_id.rb +1 -1
  229. data/lib/square/types/catalog_version_updated_event_object.rb +1 -3
  230. data/lib/square/types/channel.rb +16 -0
  231. data/lib/square/types/channel_status.rb +12 -0
  232. data/lib/square/types/checkout.rb +1 -3
  233. data/lib/square/types/checkout_location_settings.rb +1 -3
  234. data/lib/square/types/checkout_location_settings_branding.rb +2 -6
  235. data/lib/square/types/checkout_merchant_settings.rb +1 -3
  236. data/lib/square/types/checkout_merchant_settings_payment_methods.rb +4 -12
  237. data/lib/square/types/checkout_merchant_settings_payment_methods_afterpay_clearpay.rb +2 -6
  238. data/lib/square/types/component.rb +4 -12
  239. data/lib/square/types/create_bank_account_response.rb +11 -0
  240. data/lib/square/types/create_booking_custom_attribute_definition_response.rb +4 -4
  241. data/lib/square/types/create_catalog_image_request.rb +1 -1
  242. data/lib/square/types/create_customer_custom_attribute_definition_response.rb +4 -4
  243. data/lib/square/types/create_location_custom_attribute_definition_response.rb +4 -4
  244. data/lib/square/types/create_merchant_custom_attribute_definition_response.rb +4 -4
  245. data/lib/square/types/create_order_custom_attribute_definition_response.rb +1 -3
  246. data/lib/square/types/create_transfer_order_data.rb +19 -0
  247. data/lib/square/types/create_transfer_order_line_data.rb +12 -0
  248. data/lib/square/types/create_transfer_order_response.rb +11 -0
  249. data/lib/square/types/create_webhook_subscription_response.rb +2 -1
  250. data/lib/square/types/custom_attribute.rb +1 -1
  251. data/lib/square/types/custom_attribute_definition.rb +1 -3
  252. data/lib/square/types/custom_attribute_definition_event_data_object.rb +1 -3
  253. data/lib/square/types/custom_field.rb +2 -1
  254. data/lib/square/types/customer_address_filter.rb +2 -1
  255. data/lib/square/types/customer_created_event.rb +4 -2
  256. data/lib/square/types/customer_created_event_event_context_merge.rb +2 -1
  257. data/lib/square/types/customer_creation_source_filter.rb +1 -3
  258. data/lib/square/types/customer_custom_attribute_filter.rb +2 -1
  259. data/lib/square/types/customer_custom_attribute_filter_value.rb +2 -1
  260. data/lib/square/types/customer_custom_attribute_filters.rb +7 -6
  261. data/lib/square/types/customer_custom_attribute_visible_updated_event.rb +6 -3
  262. data/lib/square/types/customer_deleted_event.rb +4 -2
  263. data/lib/square/types/customer_deleted_event_event_context_merge.rb +2 -1
  264. data/lib/square/types/customer_tax_ids.rb +4 -2
  265. data/lib/square/types/customer_updated_event.rb +4 -2
  266. data/lib/square/types/delete_booking_custom_attribute_definition_response.rb +5 -2
  267. data/lib/square/types/delete_booking_custom_attribute_response.rb +2 -1
  268. data/lib/square/types/delete_customer_custom_attribute_response.rb +2 -1
  269. data/lib/square/types/delete_location_custom_attribute_response.rb +2 -1
  270. data/lib/square/types/delete_merchant_custom_attribute_response.rb +2 -1
  271. data/lib/square/types/delete_subscription_action_response.rb +2 -1
  272. data/lib/square/types/delete_transfer_order_response.rb +10 -0
  273. data/lib/square/types/delete_webhook_subscription_response.rb +2 -1
  274. data/lib/square/types/destination_details.rb +1 -3
  275. data/lib/square/types/device_checkout_options.rb +1 -0
  276. data/lib/square/types/device_component_details_ethernet_details.rb +1 -1
  277. data/lib/square/types/device_component_details_wi_fi_details.rb +1 -1
  278. data/lib/square/types/digital_wallet_details.rb +1 -0
  279. data/lib/square/types/disable_bank_account_response.rb +11 -0
  280. data/lib/square/types/dispute.rb +2 -1
  281. data/lib/square/types/dispute_evidence_added_event.rb +2 -1
  282. data/lib/square/types/dispute_evidence_created_event.rb +2 -1
  283. data/lib/square/types/employee_wage.rb +2 -1
  284. data/lib/square/types/error_code.rb +2 -0
  285. data/lib/square/types/event_data.rb +1 -3
  286. data/lib/square/types/fulfillment.rb +4 -7
  287. data/lib/square/types/fulfillment_delivery_details.rb +1 -3
  288. data/lib/square/types/fulfillment_pickup_details.rb +1 -3
  289. data/lib/square/types/get_bank_account_response.rb +1 -1
  290. data/lib/square/types/get_booking_request.rb +23 -0
  291. data/lib/square/types/get_business_booking_profile_request.rb +23 -0
  292. data/lib/square/types/get_card_request.rb +23 -0
  293. data/lib/square/types/get_catalog_object_response.rb +1 -3
  294. data/lib/square/types/get_customer_custom_attribute_definition_response.rb +4 -4
  295. data/lib/square/types/get_customer_custom_attribute_response.rb +2 -1
  296. data/lib/square/types/get_customer_group_request.rb +23 -0
  297. data/lib/square/types/get_customer_request.rb +23 -0
  298. data/lib/square/types/get_customer_segment_request.rb +23 -0
  299. data/lib/square/types/get_dispute_evidence_request.rb +23 -0
  300. data/lib/square/types/get_dispute_request.rb +23 -0
  301. data/lib/square/types/get_employee_request.rb +23 -0
  302. data/lib/square/types/get_gift_card_request.rb +23 -0
  303. data/lib/square/types/get_inventory_adjustment_request.rb +23 -0
  304. data/lib/square/types/get_inventory_physical_count_request.rb +23 -0
  305. data/lib/square/types/get_inventory_transfer_request.rb +23 -0
  306. data/lib/square/types/get_location_request.rb +23 -0
  307. data/lib/square/types/get_loyalty_account_request.rb +23 -0
  308. data/lib/square/types/get_loyalty_program_request.rb +23 -0
  309. data/lib/square/types/get_loyalty_promotion_request.rb +23 -0
  310. data/lib/square/types/get_loyalty_reward_request.rb +23 -0
  311. data/lib/square/types/get_merchant_request.rb +23 -0
  312. data/lib/square/types/get_order_request.rb +23 -0
  313. data/lib/square/types/get_payment_link_request.rb +23 -0
  314. data/lib/square/types/get_snippet_request.rb +23 -0
  315. data/lib/square/types/get_team_member_booking_profile_request.rb +23 -0
  316. data/lib/square/types/get_team_member_booking_profile_response.rb +1 -3
  317. data/lib/square/types/get_team_member_request.rb +23 -0
  318. data/lib/square/types/get_transaction_request.rb +23 -0
  319. data/lib/square/types/get_vendor_request.rb +23 -0
  320. data/lib/square/types/get_wage_setting_request.rb +23 -0
  321. data/lib/square/types/get_webhook_subscription_request.rb +23 -0
  322. data/lib/square/types/get_webhook_subscription_response.rb +2 -1
  323. data/lib/square/types/gift_card_activity.rb +8 -24
  324. data/lib/square/types/gift_card_activity_block_reason.rb +23 -0
  325. data/lib/square/types/gift_card_activity_unblock_reason.rb +23 -0
  326. data/lib/square/types/gift_card_activity_updated_event.rb +2 -1
  327. data/lib/square/types/inventory_count_updated_event_object.rb +1 -3
  328. data/lib/square/types/invoice.rb +6 -13
  329. data/lib/square/types/invoice_accepted_payment_methods.rb +2 -1
  330. data/lib/square/types/invoice_attachment.rb +1 -1
  331. data/lib/square/types/invoice_custom_field.rb +2 -1
  332. data/lib/square/types/invoice_payment_made_event.rb +2 -1
  333. data/lib/square/types/invoice_payment_request.rb +6 -8
  334. data/lib/square/types/invoice_refunded_event.rb +2 -1
  335. data/lib/square/types/invoice_sort_field.rb +23 -0
  336. data/lib/square/types/labor_scheduled_shift_created_event_object.rb +1 -1
  337. data/lib/square/types/labor_scheduled_shift_published_event_object.rb +1 -1
  338. data/lib/square/types/labor_scheduled_shift_updated_event_object.rb +1 -1
  339. data/lib/square/types/list_bank_accounts_response.rb +1 -1
  340. data/lib/square/types/list_booking_custom_attribute_definitions_response.rb +4 -4
  341. data/lib/square/types/list_booking_custom_attributes_response.rb +3 -4
  342. data/lib/square/types/list_cash_drawer_shift_events_response.rb +1 -3
  343. data/lib/square/types/list_cash_drawer_shifts_response.rb +1 -3
  344. data/lib/square/types/list_channels_request_constants.rb +23 -0
  345. data/lib/square/types/list_channels_response.rb +11 -0
  346. data/lib/square/types/list_customer_custom_attribute_definitions_response.rb +4 -4
  347. data/lib/square/types/list_customer_custom_attributes_response.rb +3 -4
  348. data/lib/square/types/list_gift_card_activities_response.rb +1 -3
  349. data/lib/square/types/list_location_booking_profiles_response.rb +1 -3
  350. data/lib/square/types/list_location_custom_attribute_definitions_response.rb +4 -4
  351. data/lib/square/types/list_location_custom_attributes_response.rb +3 -4
  352. data/lib/square/types/list_loyalty_promotions_response.rb +1 -3
  353. data/lib/square/types/list_merchant_custom_attribute_definitions_response.rb +4 -4
  354. data/lib/square/types/list_merchant_custom_attributes_response.rb +3 -4
  355. data/lib/square/types/list_order_custom_attribute_definitions_response.rb +1 -3
  356. data/lib/square/types/list_order_custom_attributes_response.rb +1 -3
  357. data/lib/square/types/list_subscription_events_response.rb +1 -3
  358. data/lib/square/types/list_team_member_booking_profiles_response.rb +1 -3
  359. data/lib/square/types/list_team_member_wages_response.rb +1 -3
  360. data/lib/square/types/list_webhook_subscriptions_response.rb +1 -3
  361. data/lib/square/types/list_workweek_configs_response.rb +1 -3
  362. data/lib/square/types/location.rb +1 -3
  363. data/lib/square/types/location_booking_profile.rb +2 -1
  364. data/lib/square/types/location_custom_attribute_visible_updated_event.rb +6 -3
  365. data/lib/square/types/loyalty_account.rb +1 -3
  366. data/lib/square/types/loyalty_account_mapping_type.rb +23 -0
  367. data/lib/square/types/loyalty_event.rb +3 -4
  368. data/lib/square/types/loyalty_event_filter.rb +1 -3
  369. data/lib/square/types/loyalty_program.rb +4 -7
  370. data/lib/square/types/loyalty_program_accrual_rule.rb +3 -4
  371. data/lib/square/types/loyalty_program_reward_tier.rb +3 -1
  372. data/lib/square/types/loyalty_promotion_incentive.rb +2 -6
  373. data/lib/square/types/loyalty_promotion_incentive_points_addition_data.rb +2 -1
  374. data/lib/square/types/loyalty_promotion_incentive_points_multiplier_data.rb +2 -1
  375. data/lib/square/types/loyalty_promotion_trigger_limit.rb +2 -1
  376. data/lib/square/types/loyalty_reward.rb +4 -2
  377. data/lib/square/types/measurement_unit_generic.rb +23 -0
  378. data/lib/square/types/oauth_authorization_revoked_event_object.rb +1 -3
  379. data/lib/square/types/oauth_authorization_revoked_event_revocation_object.rb +1 -3
  380. data/lib/square/types/order.rb +2 -6
  381. data/lib/square/types/order_card_surcharge_treatment_type.rb +12 -0
  382. data/lib/square/types/order_custom_attribute_definition_owned_created_event.rb +2 -1
  383. data/lib/square/types/order_custom_attribute_definition_owned_deleted_event.rb +2 -1
  384. data/lib/square/types/order_custom_attribute_definition_owned_updated_event.rb +2 -1
  385. data/lib/square/types/order_custom_attribute_definition_visible_created_event.rb +2 -1
  386. data/lib/square/types/order_custom_attribute_definition_visible_deleted_event.rb +2 -1
  387. data/lib/square/types/order_custom_attribute_definition_visible_updated_event.rb +2 -1
  388. data/lib/square/types/order_custom_attribute_owned_deleted_event.rb +2 -1
  389. data/lib/square/types/order_custom_attribute_owned_updated_event.rb +2 -1
  390. data/lib/square/types/order_custom_attribute_visible_deleted_event.rb +2 -1
  391. data/lib/square/types/order_custom_attribute_visible_updated_event.rb +2 -1
  392. data/lib/square/types/order_fulfillment_updated.rb +1 -3
  393. data/lib/square/types/order_line_item.rb +4 -12
  394. data/lib/square/types/order_line_item_applied_tax.rb +1 -0
  395. data/lib/square/types/order_line_item_pricing_blocklists.rb +3 -6
  396. data/lib/square/types/order_line_item_pricing_blocklists_blocked_service_charge.rb +14 -0
  397. data/lib/square/types/order_return.rb +3 -9
  398. data/lib/square/types/order_return_line_item.rb +4 -12
  399. data/lib/square/types/order_return_service_charge.rb +3 -6
  400. data/lib/square/types/order_service_charge.rb +2 -6
  401. data/lib/square/types/payment.rb +1 -3
  402. data/lib/square/types/payment_link_related_resources.rb +1 -3
  403. data/lib/square/types/payment_refund.rb +1 -3
  404. data/lib/square/types/payout_entry.rb +24 -72
  405. data/lib/square/types/pre_populated_data.rb +2 -1
  406. data/lib/square/types/product_type.rb +23 -0
  407. data/lib/square/types/receive_transfer_order_response.rb +11 -0
  408. data/lib/square/types/reference.rb +10 -0
  409. data/lib/square/types/reference_type.rb +25 -0
  410. data/lib/square/types/refund.rb +1 -3
  411. data/lib/square/types/retrieve_booking_custom_attribute_definition_response.rb +4 -4
  412. data/lib/square/types/retrieve_booking_custom_attribute_response.rb +2 -1
  413. data/lib/square/types/retrieve_channel_response.rb +10 -0
  414. data/lib/square/types/retrieve_location_custom_attribute_definition_response.rb +4 -4
  415. data/lib/square/types/retrieve_location_custom_attribute_response.rb +2 -1
  416. data/lib/square/types/retrieve_merchant_custom_attribute_definition_response.rb +4 -4
  417. data/lib/square/types/retrieve_merchant_custom_attribute_response.rb +2 -1
  418. data/lib/square/types/retrieve_order_custom_attribute_definition_response.rb +1 -3
  419. data/lib/square/types/retrieve_transfer_order_response.rb +11 -0
  420. data/lib/square/types/scheduled_shift_filter.rb +3 -7
  421. data/lib/square/types/scheduled_shift_workday.rb +1 -3
  422. data/lib/square/types/search_availability_filter.rb +1 -3
  423. data/lib/square/types/search_catalog_items_response.rb +2 -1
  424. data/lib/square/types/search_catalog_objects_response.rb +1 -3
  425. data/lib/square/types/search_events_sort_field.rb +23 -0
  426. data/lib/square/types/search_loyalty_accounts_request_loyalty_account_query.rb +1 -3
  427. data/lib/square/types/search_loyalty_accounts_response.rb +1 -3
  428. data/lib/square/types/search_orders_date_time_filter.rb +2 -1
  429. data/lib/square/types/search_orders_fulfillment_filter.rb +2 -6
  430. data/lib/square/types/search_orders_source_filter.rb +2 -0
  431. data/lib/square/types/search_scheduled_shifts_response.rb +1 -3
  432. data/lib/square/types/search_transfer_orders_response.rb +12 -0
  433. data/lib/square/types/shift_filter.rb +3 -2
  434. data/lib/square/types/shift_query.rb +2 -1
  435. data/lib/square/types/shift_sort.rb +2 -1
  436. data/lib/square/types/shift_wage.rb +2 -1
  437. data/lib/square/types/shift_workday.rb +2 -1
  438. data/lib/square/types/snippet.rb +2 -1
  439. data/lib/square/types/standard_unit_description_group.rb +1 -3
  440. data/lib/square/types/start_transfer_order_response.rb +11 -0
  441. data/lib/square/types/subscription_event.rb +1 -3
  442. data/lib/square/types/subscription_phase.rb +2 -1
  443. data/lib/square/types/subscription_test_result.rb +5 -3
  444. data/lib/square/types/team_member_assigned_locations.rb +1 -3
  445. data/lib/square/types/team_member_booking_profile.rb +2 -1
  446. data/lib/square/types/tender.rb +2 -6
  447. data/lib/square/types/tender_buy_now_pay_later_details.rb +1 -3
  448. data/lib/square/types/terminal_refund.rb +2 -1
  449. data/lib/square/types/test_webhook_subscription_response.rb +5 -5
  450. data/lib/square/types/timecard_filter.rb +1 -1
  451. data/lib/square/types/transfer_order.rb +35 -0
  452. data/lib/square/types/transfer_order_created_event.rb +14 -0
  453. data/lib/square/types/transfer_order_created_event_data.rb +11 -0
  454. data/lib/square/types/transfer_order_created_event_object.rb +9 -0
  455. data/lib/square/types/transfer_order_deleted_event.rb +14 -0
  456. data/lib/square/types/transfer_order_deleted_event_data.rb +11 -0
  457. data/lib/square/types/transfer_order_filter.rb +12 -0
  458. data/lib/square/types/transfer_order_goods_receipt.rb +27 -0
  459. data/lib/square/types/transfer_order_goods_receipt_line_item.rb +13 -0
  460. data/lib/square/types/transfer_order_line.rb +18 -0
  461. data/lib/square/types/transfer_order_query.rb +11 -0
  462. data/lib/square/types/transfer_order_sort.rb +11 -0
  463. data/lib/square/types/transfer_order_sort_field.rb +12 -0
  464. data/lib/square/types/transfer_order_status.rb +15 -0
  465. data/lib/square/types/transfer_order_updated_event.rb +14 -0
  466. data/lib/square/types/transfer_order_updated_event_data.rb +11 -0
  467. data/lib/square/types/transfer_order_updated_event_object.rb +9 -0
  468. data/lib/square/types/update_booking_custom_attribute_definition_response.rb +4 -4
  469. data/lib/square/types/update_customer_custom_attribute_definition_response.rb +4 -4
  470. data/lib/square/types/update_location_custom_attribute_definition_response.rb +4 -4
  471. data/lib/square/types/update_merchant_custom_attribute_definition_response.rb +4 -4
  472. data/lib/square/types/update_order_custom_attribute_definition_response.rb +1 -3
  473. data/lib/square/types/update_transfer_order_data.rb +15 -0
  474. data/lib/square/types/update_transfer_order_line_data.rb +13 -0
  475. data/lib/square/types/update_transfer_order_response.rb +11 -0
  476. data/lib/square/types/update_webhook_subscription_response.rb +2 -1
  477. data/lib/square/types/update_webhook_subscription_signature_key_response.rb +3 -1
  478. data/lib/square/types/upsert_booking_custom_attribute_response.rb +2 -1
  479. data/lib/square/types/upsert_catalog_object_response.rb +1 -3
  480. data/lib/square/types/upsert_customer_custom_attribute_response.rb +2 -1
  481. data/lib/square/types/upsert_location_custom_attribute_response.rb +2 -1
  482. data/lib/square/types/upsert_merchant_custom_attribute_response.rb +2 -1
  483. data/lib/square/types/v_1_get_payment_request.rb +23 -0
  484. data/lib/square/types/v_1_get_settlement_request.rb +23 -0
  485. data/lib/square/types/v_1_order.rb +1 -3
  486. data/lib/square/types/vendor_created_event_object_operation.rb +23 -0
  487. data/lib/square/types/vendor_updated_event_object_operation.rb +23 -0
  488. data/lib/square/types/wage_setting.rb +1 -3
  489. data/lib/square/v_1_transactions/client.rb +72 -29
  490. data/lib/square/vendors/client.rb +126 -51
  491. data/lib/square/vendors/types/batch_update_vendors_request.rb +1 -3
  492. data/lib/square/version.rb +1 -1
  493. data/lib/square/webhooks/client.rb +3 -1
  494. data/lib/square/webhooks/event_types/client.rb +25 -14
  495. data/lib/square/webhooks/subscriptions/client.rb +164 -69
  496. data/lib/square.rb +106 -5
  497. data/lib/square_legacy/utilities/webhooks_helper.rb +1 -1
  498. data/reference.md +29588 -0
  499. data/wiremock/docker-compose.test.yml +14 -0
  500. data/wiremock/wiremock-mappings.json +1 -0
  501. metadata +118 -45
  502. data/lib/square/mobile/client.rb +0 -50
  503. data/lib/square/mobile/types/create_mobile_authorization_code_request.rb +0 -11
  504. data/lib/square/types/create_mobile_authorization_code_response.rb +0 -13
  505. data/test/square/integration/client_tests/test_cash_drawers.rb +0 -27
  506. data/test/square/integration/client_tests/test_catalog.rb +0 -704
  507. data/test/square/integration/client_tests/test_customers.rb +0 -65
  508. data/test/square/integration/client_tests/test_customers_groups.rb +0 -144
  509. data/test/square/integration/client_tests/test_customers_segments.rb +0 -36
  510. data/test/square/integration/client_tests/test_devices.rb +0 -67
  511. data/test/square/integration/client_tests/test_inventory.rb +0 -28
  512. data/test/square/integration/client_tests/test_locations.rb +0 -18
  513. data/test/square/integration/client_tests/test_merchants.rb +0 -40
  514. data/test/square/integration/client_tests/test_mobile.rb +0 -21
  515. data/test/square/integration/client_tests/test_orders.rb +0 -177
  516. data/test/square/integration/client_tests/test_payments.rb +0 -167
  517. data/test/square/integration/client_tests/test_refunds.rb +0 -133
  518. data/test/square/integration/client_tests/test_team_members.rb +0 -97
  519. data/test/square/integration/client_tests/test_terminal.rb +0 -107
  520. data/test/square/integration/integration_test_base.rb +0 -16
  521. data/test/square/integration/testdata/image.jpeg +0 -0
  522. data/test/square/internal/multipart/test_form_data.rb +0 -311
  523. data/test/square/internal/types/test_array.rb +0 -37
  524. data/test/square/internal/types/test_boolean.rb +0 -35
  525. data/test/square/internal/types/test_enum.rb +0 -42
  526. data/test/square/internal/types/test_hash.rb +0 -50
  527. data/test/square/internal/types/test_model.rb +0 -105
  528. data/test/square/internal/types/test_union.rb +0 -52
  529. data/test/square/internal/types/test_utils.rb +0 -216
  530. data/test/square_legacy/api/api_test_base.rb +0 -27
  531. data/test/square_legacy/api/test_catalog_api.rb +0 -57
  532. data/test/square_legacy/api/test_customers_api.rb +0 -43
  533. data/test/square_legacy/api/test_employees_api.rb +0 -34
  534. data/test/square_legacy/api/test_labor_api.rb +0 -82
  535. data/test/square_legacy/api/test_locations_api.rb +0 -22
  536. data/test/square_legacy/api/test_merchants_api.rb +0 -38
  537. data/test/square_legacy/api/test_payments_api.rb +0 -40
  538. data/test/square_legacy/api/test_refunds_api.rb +0 -42
  539. data/test/square_legacy/http_response_catcher.rb +0 -14
  540. data/test/square_legacy/webhooks/test_webhooks_helper.rb +0 -153
  541. data/test/test_helper.rb +0 -123
@@ -2,12 +2,12 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) response.
5
+ # Represents a
6
+ # [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition)
7
+ # response.
6
8
  # Either `custom_attribute_definition` or `errors` is present in the response.
7
9
  class RetrieveMerchantCustomAttributeDefinitionResponse < Internal::Types::Model
8
- field :custom_attribute_definition, lambda {
9
- Square::Types::CustomAttributeDefinition
10
- }, optional: true, nullable: false
10
+ field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
11
11
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
12
12
  end
13
13
  end
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response.
5
+ # Represents a
6
+ # [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response.
6
7
  # Either `custom_attribute_definition` or `errors` is present in the response.
7
8
  class RetrieveMerchantCustomAttributeResponse < Internal::Types::Model
8
9
  field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: true, nullable: false
@@ -4,9 +4,7 @@ module Square
4
4
  module Types
5
5
  # Represents a response from getting an order custom attribute definition.
6
6
  class RetrieveOrderCustomAttributeDefinitionResponse < Internal::Types::Model
7
- field :custom_attribute_definition, lambda {
8
- Square::Types::CustomAttributeDefinition
9
- }, optional: true, nullable: false
7
+ field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
10
8
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
11
9
  end
12
10
  end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Response containing the requested transfer order
6
+ class RetrieveTransferOrderResponse < Internal::Types::Model
7
+ field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
8
+ field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
9
+ end
10
+ end
11
+ end
@@ -7,15 +7,11 @@ module Square
7
7
  class ScheduledShiftFilter < Internal::Types::Model
8
8
  field :location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
9
  field :start, -> { Square::Types::TimeRange }, optional: true, nullable: false
10
- field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false
10
+ field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false, api_name: "end"
11
11
  field :workday, -> { Square::Types::ScheduledShiftWorkday }, optional: true, nullable: false
12
12
  field :team_member_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
13
- field :assignment_status, lambda {
14
- Square::Types::ScheduledShiftFilterAssignmentStatus
15
- }, optional: true, nullable: false
16
- field :scheduled_shift_statuses, lambda {
17
- Internal::Types::Array[Square::Types::ScheduledShiftFilterScheduledShiftStatus]
18
- }, optional: true, nullable: false
13
+ field :assignment_status, -> { Square::Types::ScheduledShiftFilterAssignmentStatus }, optional: true, nullable: false
14
+ field :scheduled_shift_statuses, -> { Internal::Types::Array[Square::Types::ScheduledShiftFilterScheduledShiftStatus] }, optional: true, nullable: false
19
15
  end
20
16
  end
21
17
  end
@@ -6,9 +6,7 @@ module Square
6
6
  # a `Shift` must start or end in before passing the filter condition.
7
7
  class ScheduledShiftWorkday < Internal::Types::Model
8
8
  field :date_range, -> { Square::Types::DateRange }, optional: true, nullable: false
9
- field :match_scheduled_shifts_by, lambda {
10
- Square::Types::ScheduledShiftWorkdayMatcher
11
- }, optional: true, nullable: false
9
+ field :match_scheduled_shifts_by, -> { Square::Types::ScheduledShiftWorkdayMatcher }, optional: true, nullable: false
12
10
  field :default_timezone, -> { String }, optional: true, nullable: false
13
11
  end
14
12
  end
@@ -6,9 +6,7 @@ module Square
6
6
  class SearchAvailabilityFilter < Internal::Types::Model
7
7
  field :start_at_range, -> { Square::Types::TimeRange }, optional: false, nullable: false
8
8
  field :location_id, -> { String }, optional: true, nullable: false
9
- field :segment_filters, lambda {
10
- Internal::Types::Array[Square::Types::SegmentFilter]
11
- }, optional: true, nullable: false
9
+ field :segment_filters, -> { Internal::Types::Array[Square::Types::SegmentFilter] }, optional: true, nullable: false
12
10
  field :booking_id, -> { String }, optional: true, nullable: false
13
11
  end
14
12
  end
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.
5
+ # Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)
6
+ # endpoint.
6
7
  class SearchCatalogItemsResponse < Internal::Types::Model
7
8
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
8
9
  field :items, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
@@ -6,9 +6,7 @@ module Square
6
6
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
7
7
  field :cursor, -> { String }, optional: true, nullable: false
8
8
  field :objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
9
- field :related_objects, lambda {
10
- Internal::Types::Array[Square::Types::CatalogObject]
11
- }, optional: true, nullable: false
9
+ field :related_objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
12
10
  field :latest_time, -> { String }, optional: true, nullable: false
13
11
  end
14
12
  end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ module SearchEventsSortField
6
+ # SearchEventsSortField is an alias for Object
7
+
8
+ # @option str [String]
9
+ #
10
+ # @return [untyped]
11
+ def self.load(str)
12
+ ::JSON.parse(str)
13
+ end
14
+
15
+ # @option value [untyped]
16
+ #
17
+ # @return [String]
18
+ def self.dump(value)
19
+ ::JSON.generate(value)
20
+ end
21
+ end
22
+ end
23
+ end
@@ -4,9 +4,7 @@ module Square
4
4
  module Types
5
5
  # The search criteria for the loyalty accounts.
6
6
  class SearchLoyaltyAccountsRequestLoyaltyAccountQuery < Internal::Types::Model
7
- field :mappings, lambda {
8
- Internal::Types::Array[Square::Types::LoyaltyAccountMapping]
9
- }, optional: true, nullable: false
7
+ field :mappings, -> { Internal::Types::Array[Square::Types::LoyaltyAccountMapping] }, optional: true, nullable: false
10
8
  field :customer_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
11
9
  end
12
10
  end
@@ -5,9 +5,7 @@ module Square
5
5
  # A response that includes loyalty accounts that satisfy the search criteria.
6
6
  class SearchLoyaltyAccountsResponse < Internal::Types::Model
7
7
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
8
- field :loyalty_accounts, lambda {
9
- Internal::Types::Array[Square::Types::LoyaltyAccount]
10
- }, optional: true, nullable: false
8
+ field :loyalty_accounts, -> { Internal::Types::Array[Square::Types::LoyaltyAccount] }, optional: true, nullable: false
11
9
  field :cursor, -> { String }, optional: true, nullable: false
12
10
  end
13
11
  end
@@ -15,7 +15,8 @@ module Square
15
15
  # to the same field you filter for. For example, if you set the `CLOSED_AT` field
16
16
  # in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to
17
17
  # `CLOSED_AT`. Otherwise, `SearchOrders` throws an error.
18
- # [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)
18
+ # [Learn more about filtering orders by time
19
+ # range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)
19
20
  class SearchOrdersDateTimeFilter < Internal::Types::Model
20
21
  field :created_at, -> { Square::Types::TimeRange }, optional: true, nullable: false
21
22
  field :updated_at, -> { Square::Types::TimeRange }, optional: true, nullable: false
@@ -4,12 +4,8 @@ module Square
4
4
  module Types
5
5
  # Filter based on [order fulfillment](entity:Fulfillment) information.
6
6
  class SearchOrdersFulfillmentFilter < Internal::Types::Model
7
- field :fulfillment_types, lambda {
8
- Internal::Types::Array[Square::Types::FulfillmentType]
9
- }, optional: true, nullable: false
10
- field :fulfillment_states, lambda {
11
- Internal::Types::Array[Square::Types::FulfillmentState]
12
- }, optional: true, nullable: false
7
+ field :fulfillment_types, -> { Internal::Types::Array[Square::Types::FulfillmentType] }, optional: true, nullable: false
8
+ field :fulfillment_states, -> { Internal::Types::Array[Square::Types::FulfillmentState] }, optional: true, nullable: false
13
9
  end
14
10
  end
15
11
  end
@@ -5,6 +5,8 @@ module Square
5
5
  # A filter based on order `source` information.
6
6
  class SearchOrdersSourceFilter < Internal::Types::Model
7
7
  field :source_names, -> { Internal::Types::Array[String] }, optional: true, nullable: false
8
+ field :source_application_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
+ field :source_client_ous, -> { Internal::Types::Array[String] }, optional: true, nullable: false
8
10
  end
9
11
  end
10
12
  end
@@ -5,9 +5,7 @@ module Square
5
5
  # Represents a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) response.
6
6
  # Either `scheduled_shifts` or `errors` is present in the response.
7
7
  class SearchScheduledShiftsResponse < Internal::Types::Model
8
- field :scheduled_shifts, lambda {
9
- Internal::Types::Array[Square::Types::ScheduledShift]
10
- }, optional: true, nullable: false
8
+ field :scheduled_shifts, -> { Internal::Types::Array[Square::Types::ScheduledShift] }, optional: true, nullable: false
11
9
  field :cursor, -> { String }, optional: true, nullable: false
12
10
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
13
11
  end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Response for searching transfer orders
6
+ class SearchTransferOrdersResponse < Internal::Types::Model
7
+ field :transfer_orders, -> { Internal::Types::Array[Square::Types::TransferOrder] }, optional: true, nullable: false
8
+ field :cursor, -> { String }, optional: true, nullable: false
9
+ field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -5,13 +5,14 @@ module Square
5
5
  # Defines a filter used in a search for `Shift` records. `AND` logic is
6
6
  # used by Square's servers to apply each filter property specified.
7
7
  #
8
- # Deprecated at Square API version 2025-05-21. See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
8
+ # Deprecated at Square API version 2025-05-21. See the [migration
9
+ # notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
9
10
  class ShiftFilter < Internal::Types::Model
10
11
  field :location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
11
12
  field :employee_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
12
13
  field :status, -> { Square::Types::ShiftFilterStatus }, optional: true, nullable: false
13
14
  field :start, -> { Square::Types::TimeRange }, optional: true, nullable: false
14
- field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false
15
+ field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false, api_name: "end"
15
16
  field :workday, -> { Square::Types::ShiftWorkday }, optional: true, nullable: false
16
17
  field :team_member_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
17
18
  end
@@ -4,7 +4,8 @@ module Square
4
4
  module Types
5
5
  # The parameters of a `Shift` search query, which includes filter and sort options.
6
6
  #
7
- # Deprecated at Square API version 2025-05-21. See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
7
+ # Deprecated at Square API version 2025-05-21. See the [migration
8
+ # notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
8
9
  class ShiftQuery < Internal::Types::Model
9
10
  field :filter, -> { Square::Types::ShiftFilter }, optional: true, nullable: false
10
11
  field :sort, -> { Square::Types::ShiftSort }, optional: true, nullable: false
@@ -4,7 +4,8 @@ module Square
4
4
  module Types
5
5
  # Sets the sort order of search results.
6
6
  #
7
- # Deprecated at Square API version 2025-05-21. See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
7
+ # Deprecated at Square API version 2025-05-21. See the [migration
8
+ # notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
8
9
  class ShiftSort < Internal::Types::Model
9
10
  field :field, -> { Square::Types::ShiftSortField }, optional: true, nullable: false
10
11
  field :order, -> { Square::Types::SortOrder }, optional: true, nullable: false
@@ -4,7 +4,8 @@ module Square
4
4
  module Types
5
5
  # The hourly wage rate used to compensate an employee for this shift.
6
6
  #
7
- # Deprecated at Square API version 2025-05-21. See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
7
+ # Deprecated at Square API version 2025-05-21. See the [migration
8
+ # notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
8
9
  class ShiftWage < Internal::Types::Model
9
10
  field :title, -> { String }, optional: true, nullable: false
10
11
  field :hourly_rate, -> { Square::Types::Money }, optional: true, nullable: false
@@ -5,7 +5,8 @@ module Square
5
5
  # A `Shift` search query filter parameter that sets a range of days that
6
6
  # a `Shift` must start or end in before passing the filter condition.
7
7
  #
8
- # Deprecated at Square API version 2025-05-21. See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
8
+ # Deprecated at Square API version 2025-05-21. See the [migration
9
+ # notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
9
10
  class ShiftWorkday < Internal::Types::Model
10
11
  field :date_range, -> { Square::Types::DateRange }, optional: true, nullable: false
11
12
  field :match_shifts_by, -> { Square::Types::ShiftWorkdayMatcher }, optional: true, nullable: false
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages.
5
+ # Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element
6
+ # of all pages on the site, except for checkout pages.
6
7
  class Snippet < Internal::Types::Model
7
8
  field :id, -> { String }, optional: true, nullable: false
8
9
  field :site_id, -> { String }, optional: true, nullable: false
@@ -4,9 +4,7 @@ module Square
4
4
  module Types
5
5
  # Group of standard measurement units.
6
6
  class StandardUnitDescriptionGroup < Internal::Types::Model
7
- field :standard_unit_descriptions, lambda {
8
- Internal::Types::Array[Square::Types::StandardUnitDescription]
9
- }, optional: true, nullable: false
7
+ field :standard_unit_descriptions, -> { Internal::Types::Array[Square::Types::StandardUnitDescription] }, optional: true, nullable: false
10
8
  field :language_code, -> { String }, optional: true, nullable: false
11
9
  end
12
10
  end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Response for starting a transfer order.
6
+ class StartTransferOrderResponse < Internal::Types::Model
7
+ field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
8
+ field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
9
+ end
10
+ end
11
+ end
@@ -5,9 +5,7 @@ module Square
5
5
  # Describes changes to a subscription and the subscription status.
6
6
  class SubscriptionEvent < Internal::Types::Model
7
7
  field :id, -> { String }, optional: false, nullable: false
8
- field :subscription_event_type, lambda {
9
- Square::Types::SubscriptionEventSubscriptionEventType
10
- }, optional: false, nullable: false
8
+ field :subscription_event_type, -> { Square::Types::SubscriptionEventSubscriptionEventType }, optional: false, nullable: false
11
9
  field :effective_date, -> { String }, optional: false, nullable: false
12
10
  field :monthly_billing_anchor_date, -> { Integer }, optional: true, nullable: false
13
11
  field :info, -> { Square::Types::SubscriptionEventInfo }, optional: true, nullable: false
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
5
+ # Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and
6
+ # Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
6
7
  class SubscriptionPhase < Internal::Types::Model
7
8
  field :uid, -> { String }, optional: true, nullable: false
8
9
  field :cadence, -> { Square::Types::SubscriptionCadence }, optional: false, nullable: false
@@ -2,14 +2,16 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Represents the details of a webhook subscription, including notification URL,
6
- # event types, and signature key.
5
+ # Represents the result of testing a webhook subscription. Note: The actual API returns these fields at the root
6
+ # level of TestWebhookSubscriptionResponse, not nested under this object.
7
7
  class SubscriptionTestResult < Internal::Types::Model
8
8
  field :id, -> { String }, optional: true, nullable: false
9
9
  field :status_code, -> { Integer }, optional: true, nullable: false
10
- field :payload, -> { String }, optional: true, nullable: false
10
+ field :payload, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
11
11
  field :created_at, -> { String }, optional: true, nullable: false
12
12
  field :updated_at, -> { String }, optional: true, nullable: false
13
+ field :notification_url, -> { String }, optional: true, nullable: false
14
+ field :passes_filter, -> { Internal::Types::Boolean }, optional: true, nullable: false
13
15
  end
14
16
  end
15
17
  end
@@ -4,9 +4,7 @@ module Square
4
4
  module Types
5
5
  # An object that represents a team member's assignment to locations.
6
6
  class TeamMemberAssignedLocations < Internal::Types::Model
7
- field :assignment_type, lambda {
8
- Square::Types::TeamMemberAssignedLocationsAssignmentType
9
- }, optional: true, nullable: false
7
+ field :assignment_type, -> { Square::Types::TeamMemberAssignedLocationsAssignmentType }, optional: true, nullable: false
10
8
  field :location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
11
9
  end
12
10
  end
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.
5
+ # The booking profile of a seller's team member, including the team member's ID, display name, description and
6
+ # whether the team member can be booked as a service provider.
6
7
  class TeamMemberBookingProfile < Internal::Types::Model
7
8
  field :team_member_id, -> { String }, optional: true, nullable: false
8
9
  field :description, -> { String }, optional: true, nullable: false
@@ -17,13 +17,9 @@ module Square
17
17
  field :card_details, -> { Square::Types::TenderCardDetails }, optional: true, nullable: false
18
18
  field :cash_details, -> { Square::Types::TenderCashDetails }, optional: true, nullable: false
19
19
  field :bank_account_details, -> { Square::Types::TenderBankAccountDetails }, optional: true, nullable: false
20
- field :buy_now_pay_later_details, lambda {
21
- Square::Types::TenderBuyNowPayLaterDetails
22
- }, optional: true, nullable: false
20
+ field :buy_now_pay_later_details, -> { Square::Types::TenderBuyNowPayLaterDetails }, optional: true, nullable: false
23
21
  field :square_account_details, -> { Square::Types::TenderSquareAccountDetails }, optional: true, nullable: false
24
- field :additional_recipients, lambda {
25
- Internal::Types::Array[Square::Types::AdditionalRecipient]
26
- }, optional: true, nullable: false
22
+ field :additional_recipients, -> { Internal::Types::Array[Square::Types::AdditionalRecipient] }, optional: true, nullable: false
27
23
  field :payment_id, -> { String }, optional: true, nullable: false
28
24
  end
29
25
  end
@@ -4,9 +4,7 @@ module Square
4
4
  module Types
5
5
  # Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.
6
6
  class TenderBuyNowPayLaterDetails < Internal::Types::Model
7
- field :buy_now_pay_later_brand, lambda {
8
- Square::Types::TenderBuyNowPayLaterDetailsBrand
9
- }, optional: true, nullable: false
7
+ field :buy_now_pay_later_brand, -> { Square::Types::TenderBuyNowPayLaterDetailsBrand }, optional: true, nullable: false
10
8
  field :status, -> { Square::Types::TenderBuyNowPayLaterDetailsStatus }, optional: true, nullable: false
11
9
  end
12
10
  end
@@ -2,7 +2,8 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.
5
+ # Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network)
6
+ # payment refunds.
6
7
  class TerminalRefund < Internal::Types::Model
7
8
  field :id, -> { String }, optional: true, nullable: false
8
9
  field :refund_id, -> { String }, optional: true, nullable: false
@@ -2,14 +2,14 @@
2
2
 
3
3
  module Square
4
4
  module Types
5
- # Defines the fields that are included in the response body of
6
- # a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint.
7
- #
8
- # Note: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not
9
- # present.
5
+ # Defines the fields that are included in the response body of a request to the TestWebhookSubscription endpoint.
10
6
  class TestWebhookSubscriptionResponse < Internal::Types::Model
11
7
  field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
12
8
  field :subscription_test_result, -> { Square::Types::SubscriptionTestResult }, optional: true, nullable: false
9
+ field :notification_url, -> { String }, optional: true, nullable: false
10
+ field :status_code, -> { Integer }, optional: true, nullable: false
11
+ field :passes_filter, -> { Internal::Types::Boolean }, optional: true, nullable: false
12
+ field :payload, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
13
13
  end
14
14
  end
15
15
  end
@@ -8,7 +8,7 @@ module Square
8
8
  field :location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
9
  field :status, -> { Square::Types::TimecardFilterStatus }, optional: true, nullable: false
10
10
  field :start, -> { Square::Types::TimeRange }, optional: true, nullable: false
11
- field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false
11
+ field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false, api_name: "end"
12
12
  field :workday, -> { Square::Types::TimecardWorkday }, optional: true, nullable: false
13
13
  field :team_member_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
14
14
  end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Represents a transfer order for moving [CatalogItemVariation](entity:CatalogItemVariation)s
6
+ # between [Location](entity:Location)s. Transfer orders track the entire lifecycle of an inventory
7
+ # transfer, including:
8
+ # - What items and quantities are being moved
9
+ # - Source and destination locations
10
+ # - Current [TransferOrderStatus](entity:TransferOrderStatus)
11
+ # - Shipping information and tracking
12
+ # - Which [TeamMember](entity:TeamMember) initiated the transfer
13
+ #
14
+ # This object is commonly used to:
15
+ # - Track [CatalogItemVariation](entity:CatalogItemVariation) movements between [Location](entity:Location)s
16
+ # - Reconcile expected vs received quantities
17
+ # - Monitor transfer progress and shipping status
18
+ # - Audit inventory movement history
19
+ class TransferOrder < Internal::Types::Model
20
+ field :id, -> { String }, optional: true, nullable: false
21
+ field :source_location_id, -> { String }, optional: true, nullable: false
22
+ field :destination_location_id, -> { String }, optional: true, nullable: false
23
+ field :status, -> { Square::Types::TransferOrderStatus }, optional: true, nullable: false
24
+ field :created_at, -> { String }, optional: true, nullable: false
25
+ field :updated_at, -> { String }, optional: true, nullable: false
26
+ field :expected_at, -> { String }, optional: true, nullable: false
27
+ field :completed_at, -> { String }, optional: true, nullable: false
28
+ field :notes, -> { String }, optional: true, nullable: false
29
+ field :tracking_number, -> { String }, optional: true, nullable: false
30
+ field :created_by_team_member_id, -> { String }, optional: true, nullable: false
31
+ field :line_items, -> { Internal::Types::Array[Square::Types::TransferOrderLine] }, optional: true, nullable: false
32
+ field :version, -> { Integer }, optional: true, nullable: false
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Published when a transfer_order is created.
6
+ class TransferOrderCreatedEvent < Internal::Types::Model
7
+ field :merchant_id, -> { String }, optional: true, nullable: false
8
+ field :type, -> { String }, optional: true, nullable: false
9
+ field :event_id, -> { String }, optional: true, nullable: false
10
+ field :created_at, -> { String }, optional: true, nullable: false
11
+ field :data, -> { Square::Types::TransferOrderCreatedEventData }, optional: true, nullable: false
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ class TransferOrderCreatedEventData < Internal::Types::Model
6
+ field :type, -> { String }, optional: true, nullable: false
7
+ field :id, -> { String }, optional: true, nullable: false
8
+ field :object, -> { Square::Types::TransferOrderCreatedEventObject }, optional: true, nullable: false
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ class TransferOrderCreatedEventObject < Internal::Types::Model
6
+ field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Published when a transfer_order is deleted.
6
+ class TransferOrderDeletedEvent < Internal::Types::Model
7
+ field :merchant_id, -> { String }, optional: true, nullable: false
8
+ field :type, -> { String }, optional: true, nullable: false
9
+ field :event_id, -> { String }, optional: true, nullable: false
10
+ field :created_at, -> { String }, optional: true, nullable: false
11
+ field :data, -> { Square::Types::TransferOrderDeletedEventData }, optional: true, nullable: false
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ class TransferOrderDeletedEventData < Internal::Types::Model
6
+ field :type, -> { String }, optional: true, nullable: false
7
+ field :id, -> { String }, optional: true, nullable: false
8
+ field :deleted, -> { Internal::Types::Boolean }, optional: true, nullable: false
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # Filter criteria for searching transfer orders
6
+ class TransferOrderFilter < Internal::Types::Model
7
+ field :source_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
8
+ field :destination_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
9
+ field :statuses, -> { Internal::Types::Array[Square::Types::TransferOrderStatus] }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Square
4
+ module Types
5
+ # The goods receipt details for a transfer order. This object represents a single receipt
6
+ # of goods against a transfer order, tracking:
7
+ #
8
+ # - Which [CatalogItemVariation](entity:CatalogItemVariation)s were received
9
+ # - Quantities received in good condition
10
+ # - Quantities damaged during transit/handling
11
+ # - Quantities canceled during receipt
12
+ #
13
+ # Multiple goods receipts can be created for a single transfer order to handle:
14
+ # - Partial deliveries
15
+ # - Multiple shipments
16
+ # - Split receipts across different dates
17
+ # - Cancellations of specific quantities
18
+ #
19
+ # Each receipt automatically:
20
+ # - Updates the transfer order status
21
+ # - Adjusts received quantities
22
+ # - Updates inventory levels at both source and destination [Location](entity:Location)s
23
+ class TransferOrderGoodsReceipt < Internal::Types::Model
24
+ field :line_items, -> { Internal::Types::Array[Square::Types::TransferOrderGoodsReceiptLineItem] }, optional: true, nullable: false
25
+ end
26
+ end
27
+ end