square.rb 38.0.0.20240515 → 38.1.0.20240604

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6495ce763a5a125e487f6c89dc548204e3b09ea93cc8a07b1a9014ff3654478d
-  data.tar.gz: 67b51c072fa51dacd86c5f4ee9ecb8bad36132fe1ee464eed149034569d8626a
+  metadata.gz: b73fd15878a8ff8550633dfb652ac398522bb103de8c0e67d357e7587c638da7
+  data.tar.gz: 877ad477b92af86e1a709d10c629119c7f4fa8f0b0be6861097aad04ed5e55d8
 SHA512:
-  metadata.gz: 901ff8752e5de5167d3cb7544d68f0591b916440da61ff2c53fac4abe6296c70007fb26946eef41952fc83c85ad05735ba464fcf511f4ae1e7e3e4e5f51645ea
-  data.tar.gz: b89fffe2fca17d46e05c94a0745f2e8dda7d97b757fb8332701902d0c011c5240fa8b39e29feaced02d3788b4bfb319b65037d3bb24106f04083d225def83a08
+  metadata.gz: 6fdeb75512114a6047d5545f2dae44cf729a0c2683586098004fc5dd5a6add3f7d5109a258788331c9b9d071b8b6b5df40ef1185abe4b62652dd7c972fcc0b62
+  data.tar.gz: 25f54e977e5ab0b4c359db3513803a14a6e5fd201a94fbc1ce3c8225a124b5f6377440a783547d1a3c993e78479c1ca4f01943d447571b4ee0642471a3cc0dd0

data/lib/square/api/base_api.rb

@@ -5,7 +5,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/38.0.0.20240515 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/38.1.0.20240604 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/events_api.rb

@@ -0,0 +1,84 @@
+module Square
+  # EventsApi
+  class EventsApi < BaseApi
+    # Search for Square API events that occur within a 28-day timeframe.
+    # @param [SearchEventsRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [SearchEventsResponse Hash] response from the API call
+    def search_events(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/events',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Disables events to prevent them from being searchable.
+    # All events are disabled by default. You must enable events to make them
+    # searchable.
+    # Disabling events for a specific time period prevents them from being
+    # searchable, even if you re-enable them later.
+    # @return [DisableEventsResponse Hash] response from the API call
+    def disable_events
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/events/disable',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Enables events to make them searchable. Only events that occur while in
+    # the enabled state are searchable.
+    # @return [EnableEventsResponse Hash] response from the API call
+    def enable_events
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/events/enable',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Lists all event types that you can subscribe to as webhooks or query using
+    # the Events API.
+    # @param [String] api_version Optional parameter: The API version for which
+    # to list event types. Setting this field overrides the default version used
+    # by the application.
+    # @return [ListEventTypesResponse Hash] response from the API call
+    def list_event_types(api_version: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/events/types',
+                                     'default')
+                   .query_param(new_parameter(api_version, key: 'api_version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+  end
+end

data/lib/square/client.rb

@@ -5,7 +5,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '38.0.0.20240515'
+      '38.1.0.20240604'
     end
 
     def square_version
@@ -118,6 +118,12 @@ module Square
       @employees ||= EmployeesApi.new @global_configuration
     end
 
+    # Access to events controller.
+    # @return [EventsApi] Returns the controller instance.
+    def events
+      @events ||= EventsApi.new @global_configuration
+    end
+
     # Access to gift_cards controller.
     # @return [GiftCardsApi] Returns the controller instance.
     def gift_cards
@@ -268,7 +274,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-05-15',
+      bearer_auth_credentials: nil, square_version: '2024-06-04',
       user_agent_detail: '', additional_headers: {}, config: nil
     )
       @config = if config.nil?

data/lib/square/configuration.rb

@@ -7,8 +7,8 @@ module Square
     end
 
     # The attribute readers for properties.
-    attr_reader :environment, :custom_url, :bearer_auth_credentials, :square_version,
-                :user_agent_detail
+    attr_reader :environment, :custom_url, :bearer_auth_credentials,
+                :square_version, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -24,7 +24,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-05-15',
+      bearer_auth_credentials: nil, square_version: '2024-06-04',
       user_agent_detail: '', additional_headers: {}
     )
 

data/lib/square.rb

@@ -48,6 +48,7 @@ require_relative 'square/api/customer_segments_api'
 require_relative 'square/api/devices_api'
 require_relative 'square/api/disputes_api'
 require_relative 'square/api/employees_api'
+require_relative 'square/api/events_api'
 require_relative 'square/api/gift_cards_api'
 require_relative 'square/api/gift_card_activities_api'
 require_relative 'square/api/inventory_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 38.0.0.20240515
+  version: 38.1.0.20240604
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -112,6 +112,7 @@ files:
 - lib/square/api/devices_api.rb
 - lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
+- lib/square/api/events_api.rb
 - lib/square/api/gift_card_activities_api.rb
 - lib/square/api/gift_cards_api.rb
 - lib/square/api/inventory_api.rb