leal 0.0.9

data/lib/leal/cards/types/create_cards_request_card.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class CreateCardsRequestCard < Internal::Types::Model
+        field :card_color, -> { String }, optional: true, nullable: false
+
+        field :header_text, -> { String }, optional: true, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: true, nullable: false
+
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: true, nullable: false
+
+        field :stamp_color, -> { String }, optional: true, nullable: false
+
+        field :stamp_icon, -> { String }, optional: true, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: true, nullable: false
+
+        field :strip_color, -> { String }, optional: true, nullable: false
+
+        field :strip_preset, -> { String }, optional: true, nullable: false
+
+        field :strip_type, -> { String }, optional: true, nullable: false
+
+        field :text_color, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/create_cards_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class CreateCardsResponse < Internal::Types::Model
+        field :archived_at, -> { String }, optional: false, nullable: false
+
+        field :card_color, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :customer_cards_count, -> { Integer }, optional: false, nullable: false
+
+        field :header_text, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :rewards_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_icon, -> { String }, optional: false, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: false, nullable: false
+
+        field :strip_color, -> { String }, optional: false, nullable: false
+
+        field :strip_preset, -> { String }, optional: false, nullable: false
+
+        field :strip_type, -> { String }, optional: false, nullable: false
+
+        field :text_color, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class GetCardsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/get_cards_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class GetCardsResponse < Internal::Types::Model
+        field :archived_at, -> { String }, optional: false, nullable: false
+
+        field :card_color, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :customer_cards_count, -> { Integer }, optional: false, nullable: false
+
+        field :header_text, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :rewards_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_icon, -> { String }, optional: false, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: false, nullable: false
+
+        field :strip_color, -> { String }, optional: false, nullable: false
+
+        field :strip_preset, -> { String }, optional: false, nullable: false
+
+        field :strip_type, -> { String }, optional: false, nullable: false
+
+        field :text_color, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class ListCardsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :scope, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/list_cards_response_item.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class ListCardsResponseItem < Internal::Types::Model
+        field :archived_at, -> { String }, optional: false, nullable: false
+
+        field :card_color, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :customer_cards_count, -> { Integer }, optional: false, nullable: false
+
+        field :header_text, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :rewards_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_icon, -> { String }, optional: false, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: false, nullable: false
+
+        field :strip_color, -> { String }, optional: false, nullable: false
+
+        field :strip_preset, -> { String }, optional: false, nullable: false
+
+        field :strip_type, -> { String }, optional: false, nullable: false
+
+        field :text_color, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/update_cards_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class UpdateCardsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :card, -> { Leal::Cards::Types::UpdateCardsRequestCard }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/update_cards_request_card.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class UpdateCardsRequestCard < Internal::Types::Model
+        field :card_color, -> { String }, optional: true, nullable: false
+
+        field :header_text, -> { String }, optional: true, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: true, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: true, nullable: false
+
+        field :stamp_color, -> { String }, optional: true, nullable: false
+
+        field :stamp_icon, -> { String }, optional: true, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: true, nullable: false
+
+        field :strip_color, -> { String }, optional: true, nullable: false
+
+        field :strip_preset, -> { String }, optional: true, nullable: false
+
+        field :strip_type, -> { String }, optional: true, nullable: false
+
+        field :text_color, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/cards/types/update_cards_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      class UpdateCardsResponse < Internal::Types::Model
+        field :archived_at, -> { String }, optional: false, nullable: false
+
+        field :card_color, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :customer_cards_count, -> { Integer }, optional: false, nullable: false
+
+        field :header_text, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :initial_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :rewards_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamp_background_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_color, -> { String }, optional: false, nullable: false
+
+        field :stamp_icon, -> { String }, optional: false, nullable: false
+
+        field :stamps_required, -> { Integer }, optional: false, nullable: false
+
+        field :strip_color, -> { String }, optional: false, nullable: false
+
+        field :strip_preset, -> { String }, optional: false, nullable: false
+
+        field :strip_type, -> { String }, optional: false, nullable: false
+
+        field :text_color, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Leal
+  class Client
+    # @param token [String]
+    # @param base_url [String, nil]
+    # @param max_retries [Integer]
+    #
+    # @return [void]
+    def initialize(token:, base_url: nil, max_retries: 2)
+      @raw_client = Leal::Internal::Http::RawClient.new(
+        base_url: base_url || Leal::Environment::PRODUCTION,
+        headers: {
+          "User-Agent" => "leal/0.0.9",
+          "X-Fern-Language" => "Ruby",
+          Authorization: "Bearer #{token}"
+        },
+        max_retries: max_retries
+      )
+    end
+
+    # @return [Leal::Stores::Client]
+    def stores
+      @stores ||= Leal::Stores::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Cards::Client]
+    def cards
+      @cards ||= Leal::Cards::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Customers::Client]
+    def customers
+      @customers ||= Leal::Customers::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::CustomerCards::Client]
+    def customer_cards
+      @customer_cards ||= Leal::CustomerCards::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Locations::Client]
+    def locations
+      @locations ||= Leal::Locations::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Posters::Client]
+    def posters
+      @posters ||= Leal::Posters::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Rewards::Client]
+    def rewards
+      @rewards ||= Leal::Rewards::Client.new(client: @raw_client)
+    end
+
+    # @return [Leal::Status::Client]
+    def status
+      @status ||= Leal::Status::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/leal/customer_cards/client.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    class Client
+      # @param client [Leal::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns all loyalty cards enrolled for a specific customer, including stamp progress,
+      # status, wallet pass installation state, and wallet pass URLs (`apple_wallet_url` and
+      # `google_wallet_url`) that you can use to let customers add their loyalty card to
+      # Apple Wallet or Google Wallet from your own app or website.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer] :account_id
+      # @option params [Integer] :customer_id
+      #
+      # @example
+      #   client.customer_cards.list(
+      #     account_id: 1,
+      #     customer_id: 1
+      #   )
+      #
+      # @return [Array[Leal::CustomerCards::Types::ListCustomerCardsResponseItem]]
+      def list(request_options: {}, **params)
+        params = Leal::Internal::Types::Utils.normalize_keys(params)
+        request = Leal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/v1/accounts/#{URI.encode_uri_component(params[:account_id].to_s)}/customers/#{URI.encode_uri_component(params[:customer_id].to_s)}/customer_cards",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Leal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Leal::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Returns detailed information about a specific customer card, including stamp progress,
+      # a list of rewards the customer has earned enough stamps to redeem, and wallet pass URLs
+      # (`apple_wallet_url` and `google_wallet_url`) for adding the card to Apple Wallet or
+      # Google Wallet.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer] :account_id
+      # @option params [Integer] :customer_id
+      # @option params [Integer] :id
+      #
+      # @example
+      #   client.customer_cards.get(
+      #     account_id: 1,
+      #     customer_id: 1,
+      #     id: 1
+      #   )
+      #
+      # @return [Leal::CustomerCards::Types::GetCustomerCardsResponse]
+      def get(request_options: {}, **params)
+        params = Leal::Internal::Types::Utils.normalize_keys(params)
+        request = Leal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/v1/accounts/#{URI.encode_uri_component(params[:account_id].to_s)}/customers/#{URI.encode_uri_component(params[:customer_id].to_s)}/customer_cards/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Leal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Leal::CustomerCards::Types::GetCustomerCardsResponse.load(response.body)
+        else
+          error_class = Leal::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Redeems a reward for a customer, deducting the required stamps from their card.
+      # The customer must have enough stamps on this card to cover the reward's cost.
+      # Triggers wallet pass updates and push notifications.
+      #
+      # @param request_options [Hash]
+      # @param params [Leal::CustomerCards::Types::RedeemCustomerCardsRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer] :account_id
+      # @option params [Integer] :customer_id
+      # @option params [Integer] :id
+      #
+      # @example
+      #   client.customer_cards.redeem(
+      #     account_id: 1,
+      #     customer_id: 1,
+      #     id: 1,
+      #     reward_id: 1
+      #   )
+      #
+      # @return [Leal::CustomerCards::Types::RedeemCustomerCardsResponse]
+      def redeem(request_options: {}, **params)
+        params = Leal::Internal::Types::Utils.normalize_keys(params)
+        request_data = Leal::CustomerCards::Types::RedeemCustomerCardsRequest.new(params).to_h
+        non_body_param_names = %w[account_id customer_id id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Leal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "api/v1/accounts/#{URI.encode_uri_component(params[:account_id].to_s)}/customers/#{URI.encode_uri_component(params[:customer_id].to_s)}/customer_cards/#{URI.encode_uri_component(params[:id].to_s)}/redeem",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Leal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Leal::CustomerCards::Types::RedeemCustomerCardsResponse.load(response.body)
+        else
+          error_class = Leal::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Adds stamps to a customer's loyalty card. Triggers ledger entries, wallet pass updates,
+      # and push notifications. Pass `skip_notifications` to stamp silently.
+      #
+      # @param request_options [Hash]
+      # @param params [Leal::CustomerCards::Types::StampCustomerCardsRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer] :account_id
+      # @option params [Integer] :customer_id
+      # @option params [Integer] :id
+      #
+      # @example
+      #   client.customer_cards.stamp(
+      #     account_id: 1,
+      #     customer_id: 1,
+      #     id: 1,
+      #     stamps: 1
+      #   )
+      #
+      # @return [Leal::CustomerCards::Types::StampCustomerCardsResponse]
+      def stamp(request_options: {}, **params)
+        params = Leal::Internal::Types::Utils.normalize_keys(params)
+        request_data = Leal::CustomerCards::Types::StampCustomerCardsRequest.new(params).to_h
+        non_body_param_names = %w[account_id customer_id id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Leal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "api/v1/accounts/#{URI.encode_uri_component(params[:account_id].to_s)}/customers/#{URI.encode_uri_component(params[:customer_id].to_s)}/customer_cards/#{URI.encode_uri_component(params[:id].to_s)}/stamp",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Leal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Leal::CustomerCards::Types::StampCustomerCardsResponse.load(response.body)
+        else
+          error_class = Leal::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/leal/customer_cards/types/get_customer_cards_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class GetCustomerCardsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :customer_id, -> { Integer }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/customer_cards/types/get_customer_cards_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class GetCustomerCardsResponse < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :apple_wallet_url, -> { String }, optional: false, nullable: false
+
+        field :available_rewards, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+        field :card_id, -> { Integer }, optional: false, nullable: false
+
+        field :card_name, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :customer_id, -> { Integer }, optional: false, nullable: false
+
+        field :google_wallet_url, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :issued_at, -> { String }, optional: false, nullable: false
+
+        field :pass_installed, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :progress_percentage, -> { Integer }, optional: false, nullable: false
+
+        field :stamps_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamps_remaining, -> { Integer }, optional: false, nullable: false
+
+        field :status, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+
+        field :uuid, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/customer_cards/types/list_customer_cards_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class ListCustomerCardsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :customer_id, -> { Integer }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/customer_cards/types/list_customer_cards_response_item.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class ListCustomerCardsResponseItem < Internal::Types::Model
+        field :apple_wallet_url, -> { String }, optional: false, nullable: false
+
+        field :card_id, -> { Integer }, optional: false, nullable: false
+
+        field :card_name, -> { String }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :google_wallet_url, -> { String }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :issued_at, -> { String }, optional: false, nullable: false
+
+        field :pass_installed, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :progress_percentage, -> { Integer }, optional: false, nullable: false
+
+        field :stamps_count, -> { Integer }, optional: false, nullable: false
+
+        field :stamps_remaining, -> { Integer }, optional: false, nullable: false
+
+        field :status, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+
+        field :uuid, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end