leal 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3a2732500c8c1b1883576904d52230e44d4519f0cb028d7daededbc33136971
-  data.tar.gz: 02f7a1b104b6f134429e874a40fd9c280bd1019dd83b8d18380a5ec23abe3118
+  metadata.gz: 041ecf0ebe5dde00f2be312f6b3370c3061f09e3c7bd939d5188b280896a0b9c
+  data.tar.gz: e9a796a097d629b4208a22897e23ef2518b6380bfb27b7d7f58dd3f390289ce6
 SHA512:
-  metadata.gz: 2eae523c1952ea245b021ecc561b83b11e72473c079e21b48750b28139eb323002c7d4118c73f2ec4827de16984672e20e43c60c0441d07d1b9f213d55075787
-  data.tar.gz: 9d5ab64ba2e5184d295af1c73c2d99d0eabc8522f80845e895188a8835fa2b649c93046b2782ee76afdb0771e9aba0d34aa059717fcede8a951490318d99959c
+  metadata.gz: 02e7fd662bea9ac2def7bb857485148417e040eba292bb7bb0b478edba53e35e817a77359726a5fe21d14ed578c32b30bf92dda77fe09462b7b5409a60be0fca
+  data.tar.gz: ed17b2fc1af6d86ee1be7f351638b8fd0215deefc71bb3e9b8c31cc9c7aed322bcc1c72b51d12ace434c561c578270f0695339056f8d2ea90d4be6ce171928ac

data/.fern/metadata.json

@@ -2,9 +2,9 @@
   "cliVersion": "5.102.0",
   "generatorName": "fernapi/fern-ruby-sdk",
   "generatorVersion": "1.23.2",
-  "originGitCommit": "cf2e805c2a9dd96e6e7e0632ed8a5e47243a8d4f",
+  "originGitCommit": "254da807428bdf6c997fa3a10a7e4a5960b0a6d9",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "ciProvider": "github",
-  "sdkVersion": "0.0.14"
+  "sdkVersion": "0.0.15"
 }

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

@@ -16,6 +16,14 @@ module Leal
 
         field :name, -> { String }, optional: false, nullable: false
 
+        field :qr_style, -> { Leal::Cards::Types::CreateCardsRequestCardQrStyle }, optional: true, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: true, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: true, nullable: false
+
         field :show_member_field, -> { Internal::Types::Boolean }, optional: true, nullable: false
 
         field :show_stamps_to_reward_field, -> { Internal::Types::Boolean }, optional: true, nullable: false

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      module CreateCardsRequestCardQrStyle
+        extend Leal::Internal::Types::Enum
+
+        LINK = "link"
+        CODE = "code"
+      end
+    end
+  end
+end

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

@@ -24,6 +24,14 @@ module Leal
 
         field :name, -> { String }, optional: false, nullable: false
 
+        field :qr_style, -> { String }, optional: false, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: false, nullable: false
+
         field :rewards_count, -> { Integer }, optional: false, nullable: false
 
         field :show_member_field, -> { Internal::Types::Boolean }, optional: false, nullable: false

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

@@ -24,6 +24,14 @@ module Leal
 
         field :name, -> { String }, optional: false, nullable: false
 
+        field :qr_style, -> { String }, optional: false, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: false, nullable: false
+
         field :rewards_count, -> { Integer }, optional: false, nullable: false
 
         field :show_member_field, -> { Internal::Types::Boolean }, optional: false, nullable: false

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

@@ -24,6 +24,14 @@ module Leal
 
         field :name, -> { String }, optional: false, nullable: false
 
+        field :qr_style, -> { String }, optional: false, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: false, nullable: false
+
         field :rewards_count, -> { Integer }, optional: false, nullable: false
 
         field :show_member_field, -> { Internal::Types::Boolean }, optional: false, nullable: false

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

@@ -16,6 +16,14 @@ module Leal
 
         field :name, -> { String }, optional: true, nullable: false
 
+        field :qr_style, -> { Leal::Cards::Types::UpdateCardsRequestCardQrStyle }, optional: true, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: true, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: true, nullable: false
+
         field :show_member_field, -> { Internal::Types::Boolean }, optional: true, nullable: false
 
         field :show_stamps_to_reward_field, -> { Internal::Types::Boolean }, optional: true, nullable: false

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Leal
+  module Cards
+    module Types
+      module UpdateCardsRequestCardQrStyle
+        extend Leal::Internal::Types::Enum
+
+        LINK = "link"
+        CODE = "code"
+      end
+    end
+  end
+end

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

@@ -24,6 +24,14 @@ module Leal
 
         field :name, -> { String }, optional: false, nullable: false
 
+        field :qr_style, -> { String }, optional: false, nullable: false
+
+        field :referee_stamps, -> { Integer }, optional: false, nullable: false
+
+        field :referrals_enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :referrer_stamps, -> { Integer }, optional: false, nullable: false
+
         field :rewards_count, -> { Integer }, optional: false, nullable: false
 
         field :show_member_field, -> { Internal::Types::Boolean }, optional: false, nullable: false

data/lib/leal/client.rb

@@ -11,7 +11,7 @@ module Leal
       @raw_client = Leal::Internal::Http::RawClient.new(
         base_url: base_url || Leal::Environment::PRODUCTION,
         headers: {
-          "User-Agent" => "leal/0.0.14",
+          "User-Agent" => "leal/0.0.15",
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{token}"
         },

data/lib/leal/customer_cards/client.rb

@@ -149,8 +149,10 @@ module Leal
         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.
+      # Adds stamps to a customer's loyalty card. Triggers ledger entries (`entry_type` `api`),
+      # wallet pass updates, and push notifications. Pass `skip_notifications` to stamp silently.
+      # Call it for real visits or purchases: if this customer joined with a friend's invite, the
+      # first call pays out the referral to both of them.
       #
       # @param request_options [Hash]
       # @param params [Leal::CustomerCards::Types::StampCustomerCardsRequest]

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

@@ -28,6 +28,12 @@ module Leal
 
         field :progress_percentage, -> { Integer }, optional: false, nullable: false
 
+        field :referral_url, -> { String }, optional: false, nullable: false
+
+        field :referrals_count, -> { Integer }, optional: false, nullable: false
+
+        field :referred_by, -> { Leal::CustomerCards::Types::GetCustomerCardsResponseReferredBy }, optional: false, nullable: false
+
         field :stamps_count, -> { Integer }, optional: false, nullable: false
 
         field :stamps_remaining, -> { Integer }, optional: false, nullable: false

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class GetCustomerCardsResponseReferredBy < Internal::Types::Model
+        field :customer_card_id, -> { Integer }, optional: false, nullable: false
+
+        field :customer_id, -> { Integer }, optional: false, nullable: false
+
+        field :referral_id, -> { Integer }, optional: false, nullable: false
+
+        field :rewarded_at, -> { String }, optional: false, nullable: false
+
+        field :status, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

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

@@ -22,6 +22,8 @@ module Leal
 
         field :progress_percentage, -> { Integer }, optional: false, nullable: false
 
+        field :referral_url, -> { String }, optional: false, nullable: false
+
         field :stamps_count, -> { Integer }, optional: false, nullable: false
 
         field :stamps_remaining, -> { Integer }, optional: false, nullable: false

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

@@ -28,6 +28,12 @@ module Leal
 
         field :progress_percentage, -> { Integer }, optional: false, nullable: false
 
+        field :referral_url, -> { String }, optional: false, nullable: false
+
+        field :referrals_count, -> { Integer }, optional: false, nullable: false
+
+        field :referred_by, -> { Leal::CustomerCards::Types::StampCustomerCardsResponseReferredBy }, optional: false, nullable: false
+
         field :stamps_count, -> { Integer }, optional: false, nullable: false
 
         field :stamps_remaining, -> { Integer }, optional: false, nullable: false

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Leal
+  module CustomerCards
+    module Types
+      class StampCustomerCardsResponseReferredBy < Internal::Types::Model
+        field :customer_card_id, -> { Integer }, optional: false, nullable: false
+
+        field :customer_id, -> { Integer }, optional: false, nullable: false
+
+        field :referral_id, -> { Integer }, optional: false, nullable: false
+
+        field :rewarded_at, -> { String }, optional: false, nullable: false
+
+        field :status, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/customers/client.rb

@@ -11,7 +11,9 @@ module Leal
       end
 
       # Returns a paginated list of customers for the store. Use the `search` parameter to filter
-      # by name, email, phone, card code (barcode), or external reference ID. Alternatively, pass
+      # by name, email, phone, card code (barcode), or external reference ID. A scanned wallet pass
+      # QR can be passed as it is: newer passes hold a link with the card code after the `#`, and
+      # that is matched to the card exactly. Alternatively, pass
       # `source` AND `external_id` together to perform an exact lookup by an external reference -
       # the response will contain at most one customer.
       #

data/lib/leal/customers/types/create_customers_request.rb

@@ -10,6 +10,8 @@ module Leal
 
         field :customer, -> { Leal::Customers::Types::CreateCustomersRequestCustomer }, optional: false, nullable: false
 
+        field :referral_code, -> { String }, optional: true, nullable: false
+
         field :send_card_links, -> { Internal::Types::Boolean }, optional: true, nullable: false
       end
     end

data/lib/leal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leal
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/lib/leal/webhook_subscriptions/client.rb

@@ -55,7 +55,7 @@ module Leal
       # verify deliveries. The URL must be publicly reachable over https.
       #
       # Events: `customer.created`, `customer.updated`, `customer_card.created`, `stamp.earned`, `stamp.removed`,
-      # `reward.unlocked`, `reward.redeemed`, or `*` for all of them.
+      # `reward.unlocked`, `reward.redeemed`, `referral.created`, `referral.rewarded`, or `*` for all of them.
       #
       # @param request_options [Hash]
       # @param params [Leal::WebhookSubscriptions::Types::PostAPIV1AccountsAccountIDWebhookSubscriptionsRequest]

data/lib/leal.rb

@@ -40,9 +40,11 @@ require_relative "leal/stores/types/get_stores_response"
 require_relative "leal/stores/types/update_stores_request_account"
 require_relative "leal/stores/types/update_stores_response"
 require_relative "leal/cards/types/list_cards_response_item"
+require_relative "leal/cards/types/create_cards_request_card_qr_style"
 require_relative "leal/cards/types/create_cards_request_card"
 require_relative "leal/cards/types/create_cards_response"
 require_relative "leal/cards/types/get_cards_response"
+require_relative "leal/cards/types/update_cards_request_card_qr_style"
 require_relative "leal/cards/types/update_cards_request_card"
 require_relative "leal/cards/types/update_cards_response"
 require_relative "leal/customers/types/list_customers_response_pagination"
@@ -53,9 +55,11 @@ require_relative "leal/customers/types/get_customers_response"
 require_relative "leal/customers/types/update_customers_request_customer"
 require_relative "leal/customers/types/update_customers_response"
 require_relative "leal/customer_cards/types/list_customer_cards_response_item"
+require_relative "leal/customer_cards/types/get_customer_cards_response_referred_by"
 require_relative "leal/customer_cards/types/get_customer_cards_response"
 require_relative "leal/customer_cards/types/redeem_customer_cards_response_redemption"
 require_relative "leal/customer_cards/types/redeem_customer_cards_response"
+require_relative "leal/customer_cards/types/stamp_customer_cards_response_referred_by"
 require_relative "leal/customer_cards/types/stamp_customer_cards_response"
 require_relative "leal/locations/types/list_locations_response_item"
 require_relative "leal/locations/types/create_locations_request_location"

data/reference.md

@@ -508,7 +508,9 @@ client.cards.update(
 <dd>
 
 Returns a paginated list of customers for the store. Use the `search` parameter to filter
-by name, email, phone, card code (barcode), or external reference ID. Alternatively, pass
+by name, email, phone, card code (barcode), or external reference ID. A scanned wallet pass
+QR can be passed as it is: newer passes hold a link with the card code after the `#`, and
+that is matched to the card exactly. Alternatively, pass
 `source` AND `external_id` together to perform an exact lookup by an external reference -
 the response will contain at most one customer.
 </dd>
@@ -548,7 +550,7 @@ client.customers.list(account_id: 1)
 <dl>
 <dd>
 
-**search:** `String` — Search query to filter customers by name, email, phone, card code (barcode), or external reference ID
+**search:** `String` — Search query to filter customers by name, email, phone, card code (barcode, or the full scanned QR text), or external reference ID
     
 </dd>
 </dl>
@@ -678,6 +680,14 @@ client.customers.create(
 <dl>
 <dd>
 
+**referral_code:** `String` — Records the new customer as invited by another customer: the code is the last part of that customer's `referral_url`. Needs `card_id`, for the same card, with referrals on. Nothing is given now; both customers get their stamps when the new customer's card is first stamped for a visit
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **send_card_links:** `Internal::Types::Boolean` — When true, sends the card links to the customer via email/SMS after enrollment. Note: even without this flag, the response includes `apple_wallet_url` and `google_wallet_url` in each customer card object so you can deliver them yourself.
     
 </dd>
@@ -1128,8 +1138,10 @@ client.customer_cards.redeem(
 <dl>
 <dd>
 
-Adds stamps to a customer's loyalty card. Triggers ledger entries, wallet pass updates,
-and push notifications. Pass `skip_notifications` to stamp silently.
+Adds stamps to a customer's loyalty card. Triggers ledger entries (`entry_type` `api`),
+wallet pass updates, and push notifications. Pass `skip_notifications` to stamp silently.
+Call it for real visits or purchases: if this customer joined with a friend's invite, the
+first call pays out the referral to both of them.
 </dd>
 </dl>
 </dd>
@@ -2439,7 +2451,7 @@ client.webhook_subscriptions.get_api_v1accounts_account_id_webhook_subscriptions
 Subscribes a URL to one or more events. The response includes the signing `secret`; store it to
 verify deliveries. The URL must be publicly reachable over https.
 
-Events: `customer.created`, `customer.updated`, `customer_card.created`, `stamp.earned`, `stamp.removed`, `reward.unlocked`, `reward.redeemed`, or `*` for all of them.
+Events: `customer.created`, `customer.updated`, `customer_card.created`, `stamp.earned`, `stamp.removed`, `reward.unlocked`, `reward.redeemed`, `referral.created`, `referral.rewarded`, or `*` for all of them.
 </dd>
 </dl>
 </dd>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leal
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Leal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-11-06 00:00:00.000000000 Z
 dependencies: []
 description: The Leal Ruby library provides convenient access to the Leal API from
   Ruby.
@@ -29,6 +29,7 @@ files:
 - lib/leal/cards/client.rb
 - lib/leal/cards/types/create_cards_request.rb
 - lib/leal/cards/types/create_cards_request_card.rb
+- lib/leal/cards/types/create_cards_request_card_qr_style.rb
 - lib/leal/cards/types/create_cards_response.rb
 - lib/leal/cards/types/get_cards_request.rb
 - lib/leal/cards/types/get_cards_response.rb
@@ -36,11 +37,13 @@ files:
 - lib/leal/cards/types/list_cards_response_item.rb
 - lib/leal/cards/types/update_cards_request.rb
 - lib/leal/cards/types/update_cards_request_card.rb
+- lib/leal/cards/types/update_cards_request_card_qr_style.rb
 - lib/leal/cards/types/update_cards_response.rb
 - lib/leal/client.rb
 - lib/leal/customer_cards/client.rb
 - lib/leal/customer_cards/types/get_customer_cards_request.rb
 - lib/leal/customer_cards/types/get_customer_cards_response.rb
+- lib/leal/customer_cards/types/get_customer_cards_response_referred_by.rb
 - lib/leal/customer_cards/types/list_customer_cards_request.rb
 - lib/leal/customer_cards/types/list_customer_cards_response_item.rb
 - lib/leal/customer_cards/types/redeem_customer_cards_request.rb
@@ -48,6 +51,7 @@ files:
 - lib/leal/customer_cards/types/redeem_customer_cards_response_redemption.rb
 - lib/leal/customer_cards/types/stamp_customer_cards_request.rb
 - lib/leal/customer_cards/types/stamp_customer_cards_response.rb
+- lib/leal/customer_cards/types/stamp_customer_cards_response_referred_by.rb
 - lib/leal/customers/client.rb
 - lib/leal/customers/types/create_customers_request.rb
 - lib/leal/customers/types/create_customers_request_customer.rb