leal 0.0.13 → 0.0.15

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>
@@ -2349,6 +2361,608 @@ client.rewards.update(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Webhook Subscriptions
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">get_api_v1accounts_account_id_webhook_subscriptions</a>(account_id:) -> Internal::Types::Array[Leal::WebhookSubscriptions::Types::GetAPIV1AccountsAccountIDWebhookSubscriptionsResponseItem]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns every webhook subscription for the store, oldest first. Signing secrets are not included; fetch a single subscription to read its secret.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.get_api_v1accounts_account_id_webhook_subscriptions(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**event:** `String` — Only return subscriptions that list this event (or `*`)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">post_api_v1accounts_account_id_webhook_subscriptions</a>(account_id:, request) -> Leal::WebhookSubscriptions::Types::PostAPIV1AccountsAccountIDWebhookSubscriptionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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`, `referral.created`, `referral.rewarded`, or `*` for all of them.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.post_api_v1accounts_account_id_webhook_subscriptions(
+  account_id: 1,
+  target_url: "target_url"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**description:** `String` — Your own label, up to 255 characters
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**enabled:** `Internal::Types::Boolean` — Create the subscription disabled by passing false (defaults to true)
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**event:** `String` — A single event to subscribe to. Same as `events` with one entry
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**events:** `Internal::Types::Array[String]` — Events to subscribe to, or `["*"]` for every event. Required unless `event` is given
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**payload_format:** `String` — `envelope` (default) or `flat`. `flat` sends the bare data object and cannot be combined with `*`
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**target_url:** `String` — Public https URL that will receive the POST requests
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">get_api_v1accounts_account_id_webhook_subscriptions_id</a>(account_id:, id:) -> Leal::WebhookSubscriptions::Types::GetAPIV1AccountsAccountIDWebhookSubscriptionsIDResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single subscription, including its signing secret and the result of the most recent delivery.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.get_api_v1accounts_account_id_webhook_subscriptions_id(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**id:** `Integer` — Webhook subscription ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">delete_api_v1accounts_account_id_webhook_subscriptions_id</a>(account_id:, id:) -> </code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Stops deliveries and deletes the subscription. This cannot be undone.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.delete_api_v1accounts_account_id_webhook_subscriptions_id(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**id:** `Integer` — Webhook subscription ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">patch_api_v1accounts_account_id_webhook_subscriptions_id</a>(account_id:, id:, request) -> Leal::WebhookSubscriptions::Types::PatchAPIV1AccountsAccountIDWebhookSubscriptionsIDResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Changes the URL, events, label or payload format, or turns the subscription off and on. Re-enabling a subscription that was disabled for failing clears its failure state.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.patch_api_v1accounts_account_id_webhook_subscriptions_id(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**id:** `Integer` — Webhook subscription ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**description:** `String` — Your own label, up to 255 characters
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**enabled:** `Internal::Types::Boolean` — false to pause deliveries, true to resume them
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**event:** `String` — A single event. Same as `events` with one entry
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**events:** `Internal::Types::Array[String]` — Replaces the list of events, or `["*"]` for every event
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**payload_format:** `String` — `envelope` or `flat`
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**target_url:** `String` — Public https URL that will receive the POST requests
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret</a>(account_id:, id:) -> Leal::WebhookSubscriptions::Types::PostAPIV1AccountsAccountIDWebhookSubscriptionsIDRotateSecretResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Replaces the subscription's signing secret. Deliveries are signed with the new secret straight away, so update your receiver at the same time.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**id:** `Integer` — Webhook subscription ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.webhook_subscriptions.<a href="/lib/leal/webhook_subscriptions/client.rb">post_api_v1accounts_account_id_webhook_subscriptions_id_test</a>(account_id:, id:) -> Leal::WebhookSubscriptions::Types::PostAPIV1AccountsAccountIDWebhookSubscriptionsIDTestResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Immediately sends a signed `webhook.test` event to the subscription's URL and reports what
+happened, so you can check your endpoint and signature verification without waiting for real
+activity. Test events are not retried and do not count towards disabling the subscription.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.webhook_subscriptions.post_api_v1accounts_account_id_webhook_subscriptions_id_test(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Integer` — Store (account) ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**id:** `Integer` — Webhook subscription ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Leal::WebhookSubscriptions::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leal
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Leal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-16 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
@@ -142,6 +146,20 @@ files:
 - lib/leal/types/error.rb
 - lib/leal/types/error_errors.rb
 - lib/leal/version.rb
+- lib/leal/webhook_subscriptions/client.rb
+- lib/leal/webhook_subscriptions/types/delete_api_v1accounts_account_id_webhook_subscriptions_id_request.rb
+- lib/leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_id_request.rb
+- lib/leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_id_response.rb
+- lib/leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_request.rb
+- lib/leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_response_item.rb
+- lib/leal/webhook_subscriptions/types/patch_api_v1accounts_account_id_webhook_subscriptions_id_request.rb
+- lib/leal/webhook_subscriptions/types/patch_api_v1accounts_account_id_webhook_subscriptions_id_response.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret_request.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret_response.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_test_request.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_test_response.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_request.rb
+- lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_response.rb
 - reference.md
 homepage:
 licenses: []