leal 0.0.13 → 0.0.14

data/lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Leal
+  module WebhookSubscriptions
+    module Types
+      class PostAPIV1AccountsAccountIDWebhookSubscriptionsRequest < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :event, -> { String }, optional: true, nullable: false
+
+        field :events, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :payload_format, -> { String }, optional: true, nullable: false
+
+        field :target_url, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Leal
+  module WebhookSubscriptions
+    module Types
+      class PostAPIV1AccountsAccountIDWebhookSubscriptionsResponse < Internal::Types::Model
+        field :account_id, -> { Integer }, optional: false, nullable: false
+
+        field :created_at, -> { String }, optional: false, nullable: false
+
+        field :description, -> { String }, optional: false, nullable: false
+
+        field :disabled_at, -> { String }, optional: false, nullable: false
+
+        field :disabled_reason, -> { String }, optional: false, nullable: false
+
+        field :enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :event, -> { String }, optional: false, nullable: false
+
+        field :events, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+        field :id, -> { Integer }, optional: false, nullable: false
+
+        field :last_delivery_at, -> { String }, optional: false, nullable: false
+
+        field :last_delivery_error, -> { String }, optional: false, nullable: false
+
+        field :last_delivery_status, -> { Integer }, optional: false, nullable: false
+
+        field :payload_format, -> { String }, optional: false, nullable: false
+
+        field :secret, -> { String }, optional: false, nullable: false
+
+        field :target_url, -> { String }, optional: false, nullable: false
+
+        field :updated_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/leal.rb

@@ -75,6 +75,12 @@ require_relative "leal/rewards/types/create_rewards_response"
 require_relative "leal/rewards/types/get_rewards_response"
 require_relative "leal/rewards/types/update_rewards_request_reward"
 require_relative "leal/rewards/types/update_rewards_response"
+require_relative "leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_response_item"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_response"
+require_relative "leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_id_response"
+require_relative "leal/webhook_subscriptions/types/patch_api_v1accounts_account_id_webhook_subscriptions_id_response"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret_response"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_test_response"
 require_relative "leal/status/types/check_status_response_rate_limit"
 require_relative "leal/status/types/check_status_response_versioning"
 require_relative "leal/status/types/check_status_response"
@@ -117,5 +123,13 @@ require_relative "leal/rewards/types/create_rewards_request"
 require_relative "leal/rewards/types/get_rewards_request"
 require_relative "leal/rewards/types/delete_rewards_request"
 require_relative "leal/rewards/types/update_rewards_request"
+require_relative "leal/webhook_subscriptions/client"
+require_relative "leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_request"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_request"
+require_relative "leal/webhook_subscriptions/types/get_api_v1accounts_account_id_webhook_subscriptions_id_request"
+require_relative "leal/webhook_subscriptions/types/delete_api_v1accounts_account_id_webhook_subscriptions_id_request"
+require_relative "leal/webhook_subscriptions/types/patch_api_v1accounts_account_id_webhook_subscriptions_id_request"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_rotate_secret_request"
+require_relative "leal/webhook_subscriptions/types/post_api_v1accounts_account_id_webhook_subscriptions_id_test_request"
 require_relative "leal/status/client"
 require_relative "leal/environment"

data/reference.md

@@ -2349,6 +2349,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`, 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>