square.rb 43.0.0.20250618 → 44.0.0.0

data/lib/square/bookings/custom_attributes/types/get_custom_attributes_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module CustomAttributes
+      module Types
+        class GetCustomAttributesRequest < Internal::Types::Model
+          field :booking_id, -> { String }, optional: false, nullable: false
+          field :key, -> { String }, optional: false, nullable: false
+          field :with_definition, -> { Internal::Types::Boolean }, optional: true, nullable: false
+          field :version, -> { Integer }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/custom_attributes/types/list_custom_attributes_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module CustomAttributes
+      module Types
+        class ListCustomAttributesRequest < Internal::Types::Model
+          field :booking_id, -> { String }, optional: false, nullable: false
+          field :limit, -> { Integer }, optional: true, nullable: false
+          field :cursor, -> { String }, optional: true, nullable: false
+          field :with_definitions, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/custom_attributes/types/upsert_booking_custom_attribute_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module CustomAttributes
+      module Types
+        class UpsertBookingCustomAttributeRequest < Internal::Types::Model
+          field :booking_id, -> { String }, optional: false, nullable: false
+          field :key, -> { String }, optional: false, nullable: false
+          field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: false, nullable: false
+          field :idempotency_key, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/location_profiles/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module LocationProfiles
+      class Client
+        # @return [Square::Bookings::LocationProfiles::Client]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Lists location booking profiles of a seller.
+        #
+        # @return [Square::Types::ListLocationBookingProfilesResponse]
+        def list(request_options: {}, **params)
+          _query_param_names = %w[limit cursor]
+          _query = params.slice(*_query_param_names)
+          params.except(*_query_param_names)
+
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/bookings/location-booking-profiles",
+            query: _query
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::ListLocationBookingProfilesResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/location_profiles/types/list_location_profiles_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module LocationProfiles
+      module Types
+        class ListLocationProfilesRequest < Internal::Types::Model
+          field :limit, -> { Integer }, optional: true, nullable: false
+          field :cursor, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/team_member_profiles/client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module TeamMemberProfiles
+      class Client
+        # @return [Square::Bookings::TeamMemberProfiles::Client]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Lists booking profiles for team members.
+        #
+        # @return [Square::Types::ListTeamMemberBookingProfilesResponse]
+        def list(request_options: {}, **params)
+          _query_param_names = %w[bookable_only limit cursor location_id]
+          _query = params.slice(*_query_param_names)
+          params.except(*_query_param_names)
+
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/bookings/team-member-booking-profiles",
+            query: _query
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::ListTeamMemberBookingProfilesResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+
+        # Retrieves a team member's booking profile.
+        #
+        # @return [Square::Types::GetTeamMemberBookingProfileResponse]
+        def get(request_options: {}, **params)
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/bookings/team-member-booking-profiles/#{params[:team_member_id]}"
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::GetTeamMemberBookingProfileResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/team_member_profiles/types/get_team_member_profiles_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module TeamMemberProfiles
+      module Types
+        class GetTeamMemberProfilesRequest < Internal::Types::Model
+          field :team_member_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/team_member_profiles/types/list_team_member_profiles_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module TeamMemberProfiles
+      module Types
+        class ListTeamMemberProfilesRequest < Internal::Types::Model
+          field :bookable_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
+          field :limit, -> { Integer }, optional: true, nullable: false
+          field :cursor, -> { String }, optional: true, nullable: false
+          field :location_id, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/bookings/types/bulk_retrieve_bookings_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class BulkRetrieveBookingsRequest < Internal::Types::Model
+        field :booking_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/bulk_retrieve_team_member_booking_profiles_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class BulkRetrieveTeamMemberBookingProfilesRequest < Internal::Types::Model
+        field :team_member_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/cancel_booking_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class CancelBookingRequest < Internal::Types::Model
+        field :booking_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: true, nullable: false
+        field :booking_version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/create_booking_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class CreateBookingRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: true, nullable: false
+        field :booking, -> { Square::Types::Booking }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/get_bookings_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class GetBookingsRequest < Internal::Types::Model
+        field :booking_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/list_bookings_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class ListBookingsRequest < Internal::Types::Model
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :cursor, -> { String }, optional: true, nullable: false
+        field :customer_id, -> { String }, optional: true, nullable: false
+        field :team_member_id, -> { String }, optional: true, nullable: false
+        field :location_id, -> { String }, optional: true, nullable: false
+        field :start_at_min, -> { String }, optional: true, nullable: false
+        field :start_at_max, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/retrieve_location_booking_profile_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class RetrieveLocationBookingProfileRequest < Internal::Types::Model
+        field :location_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/search_availability_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class SearchAvailabilityRequest < Internal::Types::Model
+        field :query, -> { Square::Types::SearchAvailabilityQuery }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bookings/types/update_booking_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Bookings
+    module Types
+      class UpdateBookingRequest < Internal::Types::Model
+        field :booking_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: true, nullable: false
+        field :booking, -> { Square::Types::Booking }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/cards/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Square
+  module Cards
+    class Client
+      # @return [Square::Cards::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieves a list of cards owned by the account making the request.
+      # A max of 25 cards will be returned.
+      #
+      # @return [Square::Types::ListCardsResponse]
+      def list(request_options: {}, **params)
+        _query_param_names = %w[cursor customer_id include_disabled reference_id sort_order]
+        _query = params.slice(*_query_param_names)
+        params.except(*_query_param_names)
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "GET",
+          path: "v2/cards",
+          query: _query
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::ListCardsResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Adds a card on file to an existing merchant.
+      #
+      # @return [Square::Types::CreateCardResponse]
+      def create(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/cards",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::CreateCardResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Retrieves details for a specific Card.
+      #
+      # @return [Square::Types::GetCardResponse]
+      def get(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "GET",
+          path: "v2/cards/#{params[:card_id]}"
+        )
+        _response = @client.send(_request)
+        return Square::Types::GetCardResponse.load(_response.body) if _response.code >= "200" && _response.code < "300"
+
+        raise _response.body
+      end
+
+      # Disables the card, preventing any further updates or charges.
+      # Disabling an already disabled card is allowed but has no effect.
+      #
+      # @return [Square::Types::DisableCardResponse]
+      def disable(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/cards/#{params[:card_id]}/disable"
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::DisableCardResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+    end
+  end
+end

data/lib/square/cards/types/create_card_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Cards
+    module Types
+      class CreateCardRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :source_id, -> { String }, optional: false, nullable: false
+        field :verification_token, -> { String }, optional: true, nullable: false
+        field :card, -> { Square::Types::Card }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/cards/types/disable_cards_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Cards
+    module Types
+      class DisableCardsRequest < Internal::Types::Model
+        field :card_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/cards/types/get_cards_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Cards
+    module Types
+      class GetCardsRequest < Internal::Types::Model
+        field :card_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/cards/types/list_cards_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Cards
+    module Types
+      class ListCardsRequest < Internal::Types::Model
+        field :cursor, -> { String }, optional: true, nullable: false
+        field :customer_id, -> { String }, optional: true, nullable: false
+        field :include_disabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :reference_id, -> { String }, optional: true, nullable: false
+        field :sort_order, -> { Square::Types::SortOrder }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/cash_drawers/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Square
+  module CashDrawers
+    class Client
+      # @return [Square::CashDrawers::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Square::Shifts::Client]
+      def shifts
+        @shifts ||= Square::CashDrawers::Shifts::Client.new(client: @client)
+      end
+    end
+  end
+end

data/lib/square/cash_drawers/shifts/client.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Square
+  module CashDrawers
+    module Shifts
+      class Client
+        # @return [Square::CashDrawers::Shifts::Client]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Provides the details for all of the cash drawer shifts for a location
+        # in a date range.
+        #
+        # @return [Square::Types::ListCashDrawerShiftsResponse]
+        def list(request_options: {}, **params)
+          _query_param_names = %w[location_id sort_order begin_time end_time limit cursor]
+          _query = params.slice(*_query_param_names)
+          params.except(*_query_param_names)
+
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/cash-drawers/shifts",
+            query: _query
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::ListCashDrawerShiftsResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+
+        # Provides the summary details for a single cash drawer shift. See
+        # [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events.
+        #
+        # @return [Square::Types::GetCashDrawerShiftResponse]
+        def get(request_options: {}, **params)
+          _query_param_names = ["location_id"]
+          _query = params.slice(*_query_param_names)
+          params = params.except(*_query_param_names)
+
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/cash-drawers/shifts/#{params[:shift_id]}",
+            query: _query
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::GetCashDrawerShiftResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+
+        # Provides a paginated list of events for a single cash drawer shift.
+        #
+        # @return [Square::Types::ListCashDrawerShiftEventsResponse]
+        def list_events(request_options: {}, **params)
+          _query_param_names = %w[location_id limit cursor]
+          _query = params.slice(*_query_param_names)
+          params = params.except(*_query_param_names)
+
+          _request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+            method: "GET",
+            path: "v2/cash-drawers/shifts/#{params[:shift_id]}/events",
+            query: _query
+          )
+          _response = @client.send(_request)
+          if _response.code >= "200" && _response.code < "300"
+            return Square::Types::ListCashDrawerShiftEventsResponse.load(_response.body)
+          end
+
+          raise _response.body
+        end
+      end
+    end
+  end
+end

data/lib/square/cash_drawers/shifts/types/get_shifts_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module CashDrawers
+    module Shifts
+      module Types
+        class GetShiftsRequest < Internal::Types::Model
+          field :shift_id, -> { String }, optional: false, nullable: false
+          field :location_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/cash_drawers/shifts/types/list_events_shifts_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module CashDrawers
+    module Shifts
+      module Types
+        class ListEventsShiftsRequest < Internal::Types::Model
+          field :shift_id, -> { String }, optional: false, nullable: false
+          field :location_id, -> { String }, optional: false, nullable: false
+          field :limit, -> { Integer }, optional: true, nullable: false
+          field :cursor, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/square/cash_drawers/shifts/types/list_shifts_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Square
+  module CashDrawers
+    module Shifts
+      module Types
+        class ListShiftsRequest < Internal::Types::Model
+          field :location_id, -> { String }, optional: false, nullable: false
+          field :sort_order, -> { Square::Types::SortOrder }, optional: true, nullable: false
+          field :begin_time, -> { String }, optional: true, nullable: false
+          field :end_time, -> { String }, optional: true, nullable: false
+          field :limit, -> { Integer }, optional: true, nullable: false
+          field :cursor, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end