RubyGems - leal - Versions diffs - 0.0.9 - Mend

leal 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (127) hide show

checksums.yaml +7 -0
data/.fern/metadata.json +10 -0
data/.fernignore +1 -0
data/.rubocop.yml +103 -0
data/CONTRIBUTING.md +120 -0
data/LICENSE +21 -0
data/README.md +185 -0
data/Rakefile +20 -0
data/custom.gemspec.rb +16 -0
data/lib/leal/cards/client.rb +193 -0
data/lib/leal/cards/types/create_cards_request.rb +13 -0
data/lib/leal/cards/types/create_cards_request_card.rb +33 -0
data/lib/leal/cards/types/create_cards_response.rb +45 -0
data/lib/leal/cards/types/get_cards_request.rb +13 -0
data/lib/leal/cards/types/get_cards_response.rb +45 -0
data/lib/leal/cards/types/list_cards_request.rb +13 -0
data/lib/leal/cards/types/list_cards_response_item.rb +45 -0
data/lib/leal/cards/types/update_cards_request.rb +15 -0
data/lib/leal/cards/types/update_cards_request_card.rb +33 -0
data/lib/leal/cards/types/update_cards_response.rb +45 -0
data/lib/leal/client.rb +62 -0
data/lib/leal/customer_cards/client.rb +203 -0
data/lib/leal/customer_cards/types/get_customer_cards_request.rb +15 -0
data/lib/leal/customer_cards/types/get_customer_cards_response.rb +43 -0
data/lib/leal/customer_cards/types/list_customer_cards_request.rb +13 -0
data/lib/leal/customer_cards/types/list_customer_cards_response_item.rb +37 -0
data/lib/leal/customer_cards/types/redeem_customer_cards_request.rb +17 -0
data/lib/leal/customer_cards/types/redeem_customer_cards_response.rb +13 -0
data/lib/leal/customer_cards/types/redeem_customer_cards_response_redemption.rb +21 -0
data/lib/leal/customer_cards/types/stamp_customer_cards_request.rb +19 -0
data/lib/leal/customer_cards/types/stamp_customer_cards_response.rb +43 -0
data/lib/leal/customers/client.rb +217 -0
data/lib/leal/customers/types/create_customers_request.rb +17 -0
data/lib/leal/customers/types/create_customers_request_customer.rb +23 -0
data/lib/leal/customers/types/create_customers_response.rb +35 -0
data/lib/leal/customers/types/get_customers_request.rb +13 -0
data/lib/leal/customers/types/get_customers_response.rb +35 -0
data/lib/leal/customers/types/list_customers_request.rb +21 -0
data/lib/leal/customers/types/list_customers_response.rb +13 -0
data/lib/leal/customers/types/list_customers_response_pagination.rb +17 -0
data/lib/leal/customers/types/update_customers_request.rb +15 -0
data/lib/leal/customers/types/update_customers_request_customer.rb +23 -0
data/lib/leal/customers/types/update_customers_response.rb +35 -0
data/lib/leal/environment.rb +7 -0
data/lib/leal/errors/api_error.rb +8 -0
data/lib/leal/errors/client_error.rb +17 -0
data/lib/leal/errors/redirect_error.rb +8 -0
data/lib/leal/errors/response_error.rb +42 -0
data/lib/leal/errors/server_error.rb +11 -0
data/lib/leal/errors/timeout_error.rb +8 -0
data/lib/leal/internal/errors/constraint_error.rb +10 -0
data/lib/leal/internal/errors/type_error.rb +10 -0
data/lib/leal/internal/http/base_request.rb +51 -0
data/lib/leal/internal/http/raw_client.rb +265 -0
data/lib/leal/internal/iterators/cursor_item_iterator.rb +28 -0
data/lib/leal/internal/iterators/cursor_page_iterator.rb +63 -0
data/lib/leal/internal/iterators/item_iterator.rb +65 -0
data/lib/leal/internal/iterators/offset_item_iterator.rb +30 -0
data/lib/leal/internal/iterators/offset_page_iterator.rb +103 -0
data/lib/leal/internal/json/request.rb +41 -0
data/lib/leal/internal/json/serializable.rb +25 -0
data/lib/leal/internal/multipart/multipart_encoder.rb +141 -0
data/lib/leal/internal/multipart/multipart_form_data.rb +78 -0
data/lib/leal/internal/multipart/multipart_form_data_part.rb +51 -0
data/lib/leal/internal/multipart/multipart_request.rb +40 -0
data/lib/leal/internal/types/array.rb +47 -0
data/lib/leal/internal/types/boolean.rb +34 -0
data/lib/leal/internal/types/enum.rb +56 -0
data/lib/leal/internal/types/hash.rb +36 -0
data/lib/leal/internal/types/model/field.rb +38 -0
data/lib/leal/internal/types/model.rb +208 -0
data/lib/leal/internal/types/type.rb +35 -0
data/lib/leal/internal/types/union.rb +161 -0
data/lib/leal/internal/types/unknown.rb +15 -0
data/lib/leal/internal/types/utils.rb +116 -0
data/lib/leal/locations/client.rb +225 -0
data/lib/leal/locations/types/create_locations_request.rb +13 -0
data/lib/leal/locations/types/create_locations_request_location.rb +13 -0
data/lib/leal/locations/types/create_locations_response.rb +25 -0
data/lib/leal/locations/types/delete_locations_request.rb +13 -0
data/lib/leal/locations/types/get_locations_request.rb +13 -0
data/lib/leal/locations/types/get_locations_response.rb +25 -0
data/lib/leal/locations/types/list_locations_request.rb +11 -0
data/lib/leal/locations/types/list_locations_response_item.rb +25 -0
data/lib/leal/locations/types/update_locations_request.rb +15 -0
data/lib/leal/locations/types/update_locations_request_location.rb +13 -0
data/lib/leal/locations/types/update_locations_response.rb +25 -0
data/lib/leal/posters/client.rb +232 -0
data/lib/leal/posters/types/create_posters_request.rb +13 -0
data/lib/leal/posters/types/create_posters_request_poster.rb +23 -0
data/lib/leal/posters/types/create_posters_response.rb +37 -0
data/lib/leal/posters/types/delete_posters_request.rb +13 -0
data/lib/leal/posters/types/get_posters_request.rb +13 -0
data/lib/leal/posters/types/get_posters_response.rb +37 -0
data/lib/leal/posters/types/list_posters_request.rb +15 -0
data/lib/leal/posters/types/list_posters_response_item.rb +37 -0
data/lib/leal/posters/types/update_posters_request.rb +15 -0
data/lib/leal/posters/types/update_posters_request_poster.rb +21 -0
data/lib/leal/posters/types/update_posters_response.rb +37 -0
data/lib/leal/rewards/client.rb +233 -0
data/lib/leal/rewards/types/create_rewards_request.rb +13 -0
data/lib/leal/rewards/types/create_rewards_request_reward.rb +21 -0
data/lib/leal/rewards/types/create_rewards_response.rb +29 -0
data/lib/leal/rewards/types/delete_rewards_request.rb +13 -0
data/lib/leal/rewards/types/get_rewards_request.rb +13 -0
data/lib/leal/rewards/types/get_rewards_response.rb +29 -0
data/lib/leal/rewards/types/list_rewards_request.rb +15 -0
data/lib/leal/rewards/types/list_rewards_response_item.rb +29 -0
data/lib/leal/rewards/types/update_rewards_request.rb +15 -0
data/lib/leal/rewards/types/update_rewards_request_reward.rb +19 -0
data/lib/leal/rewards/types/update_rewards_response.rb +29 -0
data/lib/leal/status/client.rb +53 -0
data/lib/leal/status/types/check_status_response.rb +23 -0
data/lib/leal/status/types/check_status_response_rate_limit.rb +15 -0
data/lib/leal/stores/client.rb +130 -0
data/lib/leal/stores/types/get_stores_request.rb +11 -0
data/lib/leal/stores/types/get_stores_response.rb +31 -0
data/lib/leal/stores/types/list_stores_response_item.rb +31 -0
data/lib/leal/stores/types/update_stores_request.rb +13 -0
data/lib/leal/stores/types/update_stores_request_account.rb +13 -0
data/lib/leal/stores/types/update_stores_response.rb +31 -0
data/lib/leal/types/error.rb +13 -0
data/lib/leal/types/error_errors.rb +14 -0
data/lib/leal/version.rb +5 -0
data/lib/leal.rb +120 -0
data/reference.md +2414 -0
metadata +168 -0

data/reference.md ADDED Viewed

@@ -0,0 +1,2414 @@
+# Reference
+## Stores
+<details><summary><code>client.stores.<a href="/lib/leal/stores/client.rb">list</a>() -> Internal::Types::Array[Leal::Stores::Types::ListStoresResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns every store the authenticated user has access to, including summary counts for locations, cards, customers, and posters.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.stores.list
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**request_options:** `Leal::Stores::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.stores.<a href="/lib/leal/stores/client.rb">get</a>(id:) -> Leal::Stores::Types::GetStoresResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns detailed information for a single store, including summary counts for its associated resources.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.stores.get(id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**id:** `Integer` — Store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Stores::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.stores.<a href="/lib/leal/stores/client.rb">update</a>(id:, request) -> Leal::Stores::Types::UpdateStoresResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates the store's name or store_name. Use `store_name` for the public-facing name displayed to customers.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.stores.update(
+  id: 1,
+  account: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**id:** `Integer` — Store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**account:** `Leal::Stores::Types::UpdateStoresRequestAccount`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Stores::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Cards
+<details><summary><code>client.cards.<a href="/lib/leal/cards/client.rb">list</a>(account_id:) -> Internal::Types::Array[Leal::Cards::Types::ListCardsResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns loyalty card templates for the specified store. By default, only
+active (unarchived) cards are returned. Use the `scope` parameter to include
+archived cards.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.cards.list(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**scope:** `String` — Filter cards by archive status. Default: active only.
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Cards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.cards.<a href="/lib/leal/cards/client.rb">create</a>(account_id:, request) -> Leal::Cards::Types::CreateCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Creates a new loyalty stamp card template for the store. The card defines the
+visual design (colours, icon, strip) and program rules (stamps required,
+initial stamps).
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.cards.create(
+  account_id: 1,
+  card: {
+    name: "name"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**card:** `Leal::Cards::Types::CreateCardsRequestCard`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Cards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.cards.<a href="/lib/leal/cards/client.rb">get</a>(account_id:, id:) -> Leal::Cards::Types::GetCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns a single loyalty card template by ID, including reward and customer card counts.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.cards.get(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Card ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Cards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.cards.<a href="/lib/leal/cards/client.rb">update</a>(account_id:, id:, request) -> Leal::Cards::Types::UpdateCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates an existing loyalty card template. Only the provided attributes are changed.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.cards.update(
+  account_id: 1,
+  id: 1,
+  card: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Card ID
+</dd>
+</dl>
+<dl>
+<dd>
+**card:** `Leal::Cards::Types::UpdateCardsRequestCard`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Cards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Customers
+<details><summary><code>client.customers.<a href="/lib/leal/customers/client.rb">list</a>(account_id:) -> Leal::Customers::Types::ListCustomersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<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
+`source` AND `external_id` together to perform an exact lookup by an external reference -
+the response will contain at most one customer.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customers.list(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**search:** `String` — Search query to filter customers by name, email, phone, card code (barcode), or external reference ID
+</dd>
+</dl>
+<dl>
+<dd>
+**source:** `String` — External system slug (e.g. `square`, `shopify`). When combined with `external_id`, performs an exact lookup.
+</dd>
+</dl>
+<dl>
+<dd>
+**external_id:** `String` — External system's identifier for the customer. Must be combined with `source`.
+</dd>
+</dl>
+<dl>
+<dd>
+**page:** `Integer` — Page number (defaults to 1)
+</dd>
+</dl>
+<dl>
+<dd>
+**items:** `Integer` — Number of items per page
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Customers::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customers.<a href="/lib/leal/customers/client.rb">create</a>(account_id:, request) -> Leal::Customers::Types::CreateCustomersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Creates a new customer for the store. Requires `first_name` and at least one of `email` or `phone`.
+Optionally enroll the customer in a loyalty card by passing `card_id`, and trigger delivery of
+card links (email/SMS) by passing `send_card_links`. When a card with initial stamps is assigned,
+those stamps are automatically applied as a welcome bonus.
+Pass `metadata` to attach arbitrary key/value data, and `external_references` to link the
+customer to records in other systems (e.g. Square, Shopify). External references are upserted
+by `(source, external_id)` so this endpoint is safe to call with the same references twice.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customers.create(
+  account_id: 1,
+  customer: {
+    first_name: "first_name"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**card_id:** `Integer` — Loyalty card ID to auto-enroll the customer in
+</dd>
+</dl>
+<dl>
+<dd>
+**customer:** `Leal::Customers::Types::CreateCustomersRequestCustomer`
+</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>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Customers::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customers.<a href="/lib/leal/customers/client.rb">get</a>(account_id:, id:) -> Leal::Customers::Types::GetCustomersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns detailed information about a single customer, including all of their
+enrolled loyalty cards with stamp progress and wallet pass URLs (`apple_wallet_url`
+and `google_wallet_url`) for each card. Also includes `metadata` and
+`external_references` so you can sync state with external systems.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customers.get(
+  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` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Customers::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customers.<a href="/lib/leal/customers/client.rb">update</a>(account_id:, id:, request) -> Leal::Customers::Types::UpdateCustomersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates an existing customer's details. To add stamps or redeem rewards, use the
+customer cards endpoints instead.
+`metadata` is shallow-merged into the existing metadata. `external_references` are upserted
+by `(source, external_id)` - to remove a reference, omit it from subsequent calls and use
+a separate `DELETE` workflow (not yet exposed via API; manage in dashboard for now).
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customers.update(
+  account_id: 1,
+  id: 1,
+  customer: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**customer:** `Leal::Customers::Types::UpdateCustomersRequestCustomer`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Customers::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Customer Cards
+<details><summary><code>client.customer_cards.<a href="/lib/leal/customer_cards/client.rb">list</a>(account_id:, customer_id:) -> Internal::Types::Array[Leal::CustomerCards::Types::ListCustomerCardsResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customer_cards.list(
+  account_id: 1,
+  customer_id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**customer_id:** `Integer` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::CustomerCards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customer_cards.<a href="/lib/leal/customer_cards/client.rb">get</a>(account_id:, customer_id:, id:) -> Leal::CustomerCards::Types::GetCustomerCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customer_cards.get(
+  account_id: 1,
+  customer_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**customer_id:** `Integer` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Customer card ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::CustomerCards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customer_cards.<a href="/lib/leal/customer_cards/client.rb">redeem</a>(account_id:, customer_id:, id:, request) -> Leal::CustomerCards::Types::RedeemCustomerCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customer_cards.redeem(
+  account_id: 1,
+  customer_id: 1,
+  id: 1,
+  reward_id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**customer_id:** `Integer` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Customer card ID
+</dd>
+</dl>
+<dl>
+<dd>
+**reward_id:** `Integer` — Reward ID to redeem
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::CustomerCards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.customer_cards.<a href="/lib/leal/customer_cards/client.rb">stamp</a>(account_id:, customer_id:, id:, request) -> Leal::CustomerCards::Types::StampCustomerCardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<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.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.customer_cards.stamp(
+  account_id: 1,
+  customer_id: 1,
+  id: 1,
+  stamps: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**customer_id:** `Integer` — Customer ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Customer card ID
+</dd>
+</dl>
+<dl>
+<dd>
+**skip_notifications:** `Internal::Types::Boolean` — When true, stamp changes bypass notifications
+</dd>
+</dl>
+<dl>
+<dd>
+**stamps:** `Integer` — Number of stamps to add (e.g. 1, 3)
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::CustomerCards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Locations
+<details><summary><code>client.locations.<a href="/lib/leal/locations/client.rb">list</a>(account_id:) -> Internal::Types::Array[Leal::Locations::Types::ListLocationsResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns every physical location belonging to the specified store.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.locations.list(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Locations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.locations.<a href="/lib/leal/locations/client.rb">create</a>(account_id:, request) -> Leal::Locations::Types::CreateLocationsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Creates a new physical location for the store. The provided address is
+automatically geocoded to latitude and longitude coordinates in the background.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.locations.create(
+  account_id: 1,
+  location: {
+    address: "address",
+    name: "name"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**location:** `Leal::Locations::Types::CreateLocationsRequestLocation`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Locations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.locations.<a href="/lib/leal/locations/client.rb">get</a>(account_id:, id:) -> Leal::Locations::Types::GetLocationsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns a single location by ID.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.locations.get(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Location ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Locations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.locations.<a href="/lib/leal/locations/client.rb">delete</a>(account_id:, id:) -> </code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Permanently deletes a location. This action cannot be undone.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.locations.delete(
+  account_id: 1,
+  id: 1
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Location ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Locations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.locations.<a href="/lib/leal/locations/client.rb">update</a>(account_id:, id:, request) -> Leal::Locations::Types::UpdateLocationsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates an existing location. If the address is changed, it will be re-geocoded automatically.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.locations.update(
+  account_id: 1,
+  id: 1,
+  location: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Parent store ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Location ID
+</dd>
+</dl>
+<dl>
+<dd>
+**location:** `Leal::Locations::Types::UpdateLocationsRequestLocation`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Locations::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Posters
+<details><summary><code>client.posters.<a href="/lib/leal/posters/client.rb">list</a>(account_id:) -> Internal::Types::Array[Leal::Posters::Types::ListPostersResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns all posters for the store. Optionally filter by card or active status.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.posters.list(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**card_id:** `Integer` — Filter posters belonging to a specific card
+</dd>
+</dl>
+<dl>
+<dd>
+**active:** `String` — When present, return only active posters
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Posters::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.posters.<a href="/lib/leal/posters/client.rb">create</a>(account_id:, request) -> Leal::Posters::Types::CreatePostersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Creates a new printable QR code poster for customer signup. The poster will automatically
+generate a unique public signup URL and QR code. The `card_id` is required on create to
+associate the poster with a loyalty card.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.posters.create(
+  account_id: 1,
+  poster: {
+    card_id: 1
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**poster:** `Leal::Posters::Types::CreatePostersRequestPoster`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Posters::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.posters.<a href="/lib/leal/posters/client.rb">get</a>(account_id:, id:) -> Leal::Posters::Types::GetPostersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns a single poster by ID, including generated signup and display URLs.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.posters.get(
+  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` — Poster ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Posters::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.posters.<a href="/lib/leal/posters/client.rb">delete</a>(account_id:, id:) -> </code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Permanently deletes a poster. The public signup URL will stop working.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.posters.delete(
+  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` — Poster ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Posters::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.posters.<a href="/lib/leal/posters/client.rb">update</a>(account_id:, id:, request) -> Leal::Posters::Types::UpdatePostersResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates an existing poster. The `card_id` cannot be changed after creation.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.posters.update(
+  account_id: 1,
+  id: 1,
+  poster: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Poster ID
+</dd>
+</dl>
+<dl>
+<dd>
+**poster:** `Leal::Posters::Types::UpdatePostersRequestPoster`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Posters::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Rewards
+<details><summary><code>client.rewards.<a href="/lib/leal/rewards/client.rb">list</a>(account_id:) -> Internal::Types::Array[Leal::Rewards::Types::ListRewardsResponseItem]</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns all rewards for the store. Optionally filter by card or active status.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.rewards.list(account_id: 1)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**card_id:** `Integer` — Filter rewards belonging to a specific card
+</dd>
+</dl>
+<dl>
+<dd>
+**active:** `String` — When present, return only active rewards
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Rewards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.rewards.<a href="/lib/leal/rewards/client.rb">create</a>(account_id:, request) -> Leal::Rewards::Types::CreateRewardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Creates a new reward for a loyalty card. The card must belong to the same store.
+The `card_id` is required on create but cannot be changed afterwards.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.rewards.create(
+  account_id: 1,
+  reward: {
+    card_id: 1,
+    name: "name",
+    stamps_required: 1
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**reward:** `Leal::Rewards::Types::CreateRewardsRequestReward`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Rewards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.rewards.<a href="/lib/leal/rewards/client.rb">get</a>(account_id:, id:) -> Leal::Rewards::Types::GetRewardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns a single reward by ID.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.rewards.get(
+  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` — Reward ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Rewards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.rewards.<a href="/lib/leal/rewards/client.rb">delete</a>(account_id:, id:) -> </code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Permanently deletes a reward. This cannot be undone.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.rewards.delete(
+  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` — Reward ID
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Rewards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+<details><summary><code>client.rewards.<a href="/lib/leal/rewards/client.rb">update</a>(account_id:, id:, request) -> Leal::Rewards::Types::UpdateRewardsResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Updates an existing reward. The `card_id` cannot be changed after creation.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.rewards.update(
+  account_id: 1,
+  id: 1,
+  reward: {}
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**account_id:** `Integer` — Store (account) ID
+</dd>
+</dl>
+<dl>
+<dd>
+**id:** `Integer` — Reward ID
+</dd>
+</dl>
+<dl>
+<dd>
+**reward:** `Leal::Rewards::Types::UpdateRewardsRequestReward`
+</dd>
+</dl>
+<dl>
+<dd>
+**request_options:** `Leal::Rewards::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>
+## Status
+<details><summary><code>client.status.<a href="/lib/leal/status/client.rb">check</a>() -> Leal::Status::Types::CheckStatusResponse</code></summary>
+<dl>
+<dd>
+#### 📝 Description
+<dl>
+<dd>
+<dl>
+<dd>
+Returns the status of the API. No authentication required.
+Every response from this API, including this one, carries `RateLimit-Limit`,
+`RateLimit-Remaining`, `RateLimit-Reset` and `RateLimit-Policy`. Exceeding
+the limit returns 429 with `Retry-After` in seconds.
+</dd>
+</dl>
+</dd>
+</dl>
+#### 🔌 Usage
+<dl>
+<dd>
+<dl>
+<dd>
+```ruby
+client.status.check
+```
+</dd>
+</dl>
+</dd>
+</dl>
+#### ⚙️ Parameters
+<dl>
+<dd>
+<dl>
+<dd>
+**request_options:** `Leal::Status::RequestOptions`
+</dd>
+</dl>
+</dd>
+</dl>
+</dd>
+</dl>
+</details>