Sleek

https://docs.onsleek.ai
Admin
Sleek provides best-in-class technology for webpage classification, semantic understanding, and...
Tokens:51,773
Snippets:163
Trust Score:2.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Sleek Web Extension SDK with npm

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Command to install the Sleek Web Extension SDK package (`@sleek/web-ext-sdk`) using npm. The package will be downloaded from the private repository as specified in the .npmrc file.

```bash
npm install @sleek/web-ext-sdk
```

--------------------------------

### Install Sleek Web Extension SDK with pnpm

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Command to install the Sleek Web Extension SDK package (`@sleek/web-ext-sdk`) using pnpm. This command will fetch the package from the configured private repository.

```bash
pnpm add @sleek/web-ext-sdk
```

--------------------------------

### Retrieve SDK Instance and Use Features

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

After initializing the SDK, retrieve the SDK instance using `getSdk` to access its features. This example demonstrates starting the coupon auto-apply feature with a specific coupon code.

```javascript
import { getSdk } from "@sleek/sdk";

getSdk().startCouponAutoApply(["SAVE10"]);
```

--------------------------------

### Inject IIFE SDK into HTML Page

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

Inject the downloaded `f.js` and `sdk.iife.js` files into your HTML page's `<head>` section before any other scripts. Then, initialize the SDK using `sleek.initializeSdk` and start using its features.

```html
<script src="f.js"></script>
<script src="sdk.iife.js"></script>
<script>
  sleek.initializeSdk("YOUR_PUBLIC_API_KEY_HERE", {},
    [(event) => {
      console.log("SDK event:", event);
    }]
  );
  // Use SDK
  sleek.getSdk().startCouponAutoApply(["SAVE10"]);
</script>
```

--------------------------------

### Initialize Sleek Web Extension SDK

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Initializes the Sleek Web Extension SDK in your background script. It requires your client-side public API key and accepts an options object for customization. Ensure initialization is awaited before using SDK functions.

```javascript
import { initializeWebExtSdk } from "@sleek/web-ext-sdk";

// In your background script constructor or setup.
await initializeWebExtSdk(process.env.YOUR_SLEEK_CLIENT_API_KEY_HERE, {
  // Your options here.
});

// Now it's safe to use the SDK
getWebExtSdk().registerEventListener((event, tabDetails) => {
  // React to event here.
});
```

--------------------------------

### Before: Fill coupons on a tab using legacy SDK (TypeScript)

Source: https://docs.onsleek.ai/web-ext-sdk-reference/migration-to-web-ext-sdk

This example shows the usage of the legacy SDK's 'fillCouponsOnTab' method for applying coupons to a specific tab. It is provided for comparison with the new SDK's approach.

```typescript
import { getSdkInstance } from '@sleek/web-ext-coupon-sdk';

// Assuming tabId is defined
getSdkInstance().fillCouponsOnTab(tabId);
```

--------------------------------

### Product Schema Example (YAML)

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products

An example demonstrating the structure of a product object as defined by the schema. It includes all required fields and sample data types.

```yaml
data:
  - name: "<string>"
    price: 123
    currencyCode: "<string>"
    quantity: 123
    url: "<string>"
    imageUrls:
      - "<string>"
    description: "<string>"
    categoryId: "<string>"
    categoryBreadcrumb: "<string>"
    categoryVersion: "<string>"
    brandName: "<string>"
    gtin: "<string>"
    mpn: "<string>"
    sku: "<string>"
    asin: "<string>"
    publicId: "<string>"
    lastViewedAt: "<string>"
    totalViews: 123
    retailerDomain: "<string>"
    retailerHostname: "<string>"
nextCursor: "<string>"
```

--------------------------------

### Install Sleek SDK via Package Manager

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

Install the @sleek/sdk package into your project using either npm or pnpm. Ensure you have configured your .npmrc file with the correct registry and token beforehand.

```bash
# Using npm
npm install @sleek/sdk

# Using pnpm
pnpm add @sleek/sdk
```

--------------------------------

### Host Permissions for Manifest v3

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Defines the host permissions required for Sleek to run on specific URLs within a Manifest V3 browser extension. It enables Sleek to perform CAA on e-commerce pages.

```json
"host_permissions": [
  ... other hosts your extension operates on,
  "<all_urls>"
]
```

--------------------------------

### Extension Permissions for Manifest v3

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Lists the necessary permissions for Sleek to operate in a browser extension using Manifest V3. This includes storage, tabs, webRequest, and scripting. Host permissions are configured separately for manifest v3.

```json
"permissions": [
    ... your other permissions,
    "storage",
    "tabs",
    "webRequest",
    "scripting"
  ]
```

--------------------------------

### Prefix Deals Endpoints with /v1/deals/

Source: https://docs.onsleek.ai/api-reference/deal-endpoint-migration-20250402

Endpoints for cashback offers, coupons, promotions, and transactions are now grouped under the `/v1/deals/` namespace. For example, `/v1/cashback-offers/` is now `/v1/deals/cashback-offers/`.

```http
GET /v1/deals/cashback-offers/
GET /v1/deals/coupons/
GET /v1/deals/promotions/
GET /v1/deals/transactions/
```

--------------------------------

### Extension Permissions for Manifest v2

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Specifies the required permissions for Sleek to function within a browser extension using Manifest V2. These include storage, tabs, webRequest, scripting, and host permissions for all URLs.

```json
"permissions": [
    ... your other permissions,
    "storage",
    "tabs",
    "webRequest",
    "scripting",
    "<all_urls>" // In manifest v2, you must add host permissions in the `permissions` array.
  ]
```

--------------------------------

### Configure NPM Registry and Authentication

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

Configure your .npmrc file to point to Sleek's private package repository and authenticate using your SDK access token. This step is crucial for installing the @sleek/sdk package via NPM or pnpm.

```bash
@sleek:registry=https://npm.cloudsmith.io/sleek/sleek/
//npm.cloudsmith.io/sleek/sleek/:_authToken={YOUR_TOKEN_HERE}
```

--------------------------------

### API Response Example for Cashback Offers List

Source: https://docs.onsleek.ai/api-reference/cashback-offers/get-cashback-offers

This example shows the typical response when requesting a list of cashback offers. It includes a 'data' array containing cashback offer objects and a 'cursor' for pagination if more results are available.

```json
{
  "data": [
    {
      "id": "e8400e53-078f-4641-97e2-5c397401c0f0",
      "featured": true,
      "countries": [
        "CA",
        "US"
      ],
      "maximumFixedCommissionFee": 75,
      "description": "$75.00 cashback on all orders.",
      "category": "Electronics",
      "termsAndExclusions": "Excludes all Apple products",
      "cashbackPercentage": 0.14,
      "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
      "logo": "https://example.com/logo.png",
      "url": "https://www.bestbuy.com",
      "name": "BestBuy",
      "hostname": "www.bestbuy.com",
      "updatedAt": "2023-10-01T12:00:00.000Z"
    }
  ],
  "cursor": "<string>"
}
```

--------------------------------

### GET /websites/onsleek_ai/products

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products-1

Retrieves a list of products with their associated details, pricing, and view history. Supports pagination.

```APIDOC
## GET /websites/onsleek_ai/products

### Description
Retrieves a list of products, including their names, prices, images, categories, ratings, and historical data (price and views per day). Supports pagination via `nextPage`.

### Method
GET

### Endpoint
/websites/onsleek_ai/products

### Parameters

#### Query Parameters
- **nextPage** (string) - Optional - Token for retrieving the next page of results.

### Request Example
```json
{
  "example": "GET /websites/onsleek_ai/products?nextPage=someToken"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **lastViewedAt** (string) - The timestamp when the product was last viewed.
  - **url** (string) - The URL of the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The current price of the product.
  - **currencyCode** (string) - The currency code for the price (e.g., "USD").
  - **brandName** (string) - The brand name of the product.
  - **description** (string) - A description of the product.
  - **imageUrls** (array) - An array of URLs for product images.
  - **categoryId** (string) - The ID of the product's category.
  - **categoryVersion** (string) - The version of the category.
  - **categoryBreadcrumb** (string) - The breadcrumb trail for the product's category.
  - **asin** (string) - The Amazon Standard Identification Number (ASIN).
  - **sku** (string) - The Stock Keeping Unit (SKU).
  - **gtin** (string) - The Global Trade Item Number (GTIN).
  - **mpn** (string) - The Manufacturer Part Number (MPN).
  - **ratingValue** (number) - The average rating value of the product.
  - **ratingCount** (number) - The total number of ratings for the product.
  - **bestRating** (number) - The best possible rating value.
  - **worstRating** (number) - The worst possible rating value.
  - **history** (array) - An array of historical data for the product.
    - **yearMonthDay** (string) - The date in YYYYMMDD format.
    - **price** (number) - The price for a single unit of the product on that day.
    - **views** (number) - The total views for the product on that day.
- **nextPage** (string) - A token for retrieving the next page of results. Null if there are no more pages.

#### Response Example
```json
{
  "data": [
    {
      "lastViewedAt": "2023-10-27T10:00:00Z",
      "url": "https://example.com/product/123",
      "name": "Example Product",
      "price": 199.99,
      "currencyCode": "USD",
      "brandName": "ExampleBrand",
      "description": "A high-quality example product.",
      "imageUrls": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "categoryId": "cat-abc",
      "categoryVersion": "v1",
      "categoryBreadcrumb": "Electronics > Gadgets",
      "asin": "B0XXXXXXXXXX",
      "sku": "EX-PROD-001",
      "gtin": "1234567890123",
      "mpn": "EP-001",
      "ratingValue": 4.5,
      "ratingCount": 500,
      "bestRating": 5,
      "worstRating": 1,
      "history": [
        {
          "yearMonthDay": "20231026",
          "price": 199.99,
          "views": 1500
        },
        {
          "yearMonthDay": "20231027",
          "price": 195.50,
          "views": 1650
        }
      ]
    }
  ],
  "nextPage": "nextPageToken123"
}
```
```

--------------------------------

### Cashback Offer Data Structure Example

Source: https://docs.onsleek.ai/api-reference/cashback-offers/get-cashback-offers

This example demonstrates the JSON structure for a single cashback offer, including its ID, featured status, applicable countries, commission details, description, category, terms, cashback percentage, retailer information, and update timestamp.

```json
{
  "id": "e8400e53-078f-4641-97e2-5c397401c0f0",
  "featured": true,
  "countries": [
    "CA",
    "US"
  ],
  "maximumFixedCommissionFee": 75,
  "description": "$75.00 cashback on all orders.",
  "category": "Electronics",
  "termsAndExclusions": "Excludes all Apple products",
  "cashbackPercentage": 0.14,
  "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
  "logo": "https://example.com/logo.png",
  "url": "https://www.bestbuy.com",
  "name": "BestBuy",
  "hostname": "www.bestbuy.com",
  "updatedAt": "2023-10-10T12:00:00.000Z"
}
```

--------------------------------

### GET /v1/products

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products

Retrieves a list of products with optional filtering by domain, hostname, and pagination.

```APIDOC
## GET /v1/products

### Description
Retrieves a list of products from Onsleek AI. You can filter products by domain and hostname, and use cursor-based pagination to navigate through the results. A limit can also be specified for the number of products per page.

### Method
GET

### Endpoint
/v1/products

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - The cursor to fetch the next page of products.
- **domain** (string) - Optional - The domain of the products to fetch.
- **hostname** (string) - Optional - The hostname of the products to fetch.
- **limit** (string) - Optional - The number of products to fetch. Maximum 1000

#### Request Body
This endpoint does not accept a request body.

### Request Example
```json
{
  "example": "GET /v1/products?domain=example.com&limit=100"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **name** (string, nullable) - The name of the product.
  - **price** (number, nullable) - The price for a single unit of the product.
  - **currencyCode** (string, nullable) - The ISO 4217 currency code for the price.
  - **quantity** (number, nullable) - The quantity of the product.
  - **url** (string, nullable) - The URL of the product.
  - **imageUrls** (array of strings, nullable) - The URLs of the product images.
  - **description** (string, nullable) - A description of the product.
  - **categoryId** (string, nullable) - The category ID for this product.
  - **categoryBreadcrumb** (string, nullable) - The category breadcrumb for this product.
  - **categoryVersion** (string, nullable) - The version of the category for this product (e.g., `shopify-2024-10`).
  - **brandName** (string, nullable) - The brand name of the product.
  - **gtin** (string, nullable) - The Global Trade Item Number (GTIN) for the product.
  - **mpn** (string, nullable) - The Manufacturer Part Number (MPN) for the product.
  - **sku** (string, nullable) - The Stock Keeping Unit (SKU) identifier for the product.
  - **asin** (string, nullable) - The Amazon Standard Identification Number (ASIN) for the product.
  - **publicId** (string) - The public ID of the product.
  - **lastViewedAt** (string) - The date and time the product was last viewed (ISO 8601 format).

#### Response Example
```json
{
  "data": [
    {
      "name": "Example Product",
      "price": 19.99,
      "currencyCode": "USD",
      "quantity": 50,
      "url": "https://example.com/product/123",
      "imageUrls": ["https://example.com/image1.jpg"],
      "description": "This is an example product description.",
      "categoryId": "cat-abc",
      "categoryBreadcrumb": "Electronics > Gadgets",
      "categoryVersion": "shopify-2024-10",
      "brandName": "Example Brand",
      "gtin": "1234567890123",
      "mpn": "EXMPL-001",
      "sku": "SKU-XYZ",
      "asin": "B012345678",
      "publicId": "prod-789",
      "lastViewedAt": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Products

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products

Retrieves a list of products with detailed information including views, pricing, and retailer specifics. Supports pagination via a cursor.

```APIDOC
## GET /websites/onsleek_ai/products

### Description
Retrieves a list of products with detailed information including views, pricing, and retailer specifics. Supports pagination via a cursor.

### Method
GET

### Endpoint
/websites/onsleek_ai/products

### Parameters
#### Query Parameters
- **nextCursor** (string) - Optional - The cursor for the next page of results.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - **currencyCode** (string) - The currency code for the price.
  - **quantity** (number) - The available quantity of the product.
  - **url** (string) - The URL of the product.
  - **imageUrls** (array) - An array of URLs for product images.
  - **description** (string) - The description of the product.
  - **categoryId** (string) - The ID of the product's category.
  - **categoryBreadcrumb** (string) - The breadcrumb trail for the product's category.
  - **categoryVersion** (string) - The version of the product's category.
  - **brandName** (string) - The brand name of the product.
  - **gtin** (string) - The Global Trade Item Number (GTIN) of the product.
  - **mpn** (string) - The Manufacturer Part Number (MPN) of the product.
  - **sku** (string) - The Stock Keeping Unit (SKU) of the product.
  - **asin** (string) - The Amazon Standard Identification Number (ASIN) of the product.
  - **publicId** (string) - The public ID of the product.
  - **lastViewedAt** (string) - The timestamp when the product was last viewed.
  - **totalViews** (number) - The total number of times the product has been viewed all-time.
  - **retailerDomain** (string) - The domain of the retailer.
  - **retailerHostname** (string) - The hostname of the retailer.
- **nextCursor** (string) - The cursor for the next page of results (nullable).

#### Response Example
```json
{
  "example": {
    "data": [
      {
        "name": "<string>",
        "price": 123,
        "currencyCode": "<string>",
        "quantity": 123,
        "url": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "description": "<string>",
        "categoryId": "<string>",
        "categoryBreadcrumb": "<string>",
        "categoryVersion": "<string>",
        "brandName": "<string>",
        "gtin": "<string>",
        "mpn": "<string>",
        "sku": "<string>",
        "asin": "<string>",
        "publicId": "<string>",
        "lastViewedAt": "<string>",
        "totalViews": 123,
        "retailerDomain": "<string>",
        "retailerHostname": "<string>"
      }
    ],
    "nextCursor": "<string>"
  }
}
```
```

--------------------------------

### Promotions API

Source: https://docs.onsleek.ai/api-reference/deal-endpoint-migration-20250402

Endpoints for retrieving and activating promotions. Activation endpoints have been updated to use path parameters and a new namespace.

```APIDOC
## GET /v1/deals/promotions/{id}/activate

### Description
Activates a promotion and returns a 302 redirect to the affiliate URL.

### Method
GET

### Endpoint
`/v1/deals/promotions/{id}/activate`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the promotion to activate.
#### Query Parameters
- **orgId** (string) - Required - The organization ID.

### Response
#### Success Response (302)
Redirects to the affiliate URL.

### Response Example
(Redirect to affiliate URL)

## POST /v1/deals/promotions/{id}/activate

### Description
Activates a promotion and returns a JSON object containing the affiliate URL.

### Method
POST

### Endpoint
`/v1/deals/promotions/{id}/activate`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the promotion to activate.
#### Query Parameters
- **orgId** (string) - Required - The organization ID.

### Request Body
(No request body required)

### Response
#### Success Response (200)
- **url** (string) - The affiliate URL.

### Response Example
{
  "url": "https://example.com/affiliate-link"
}

## GET /v1/deals/promotions/

### Description
Retrieves a list of all promotions.

### Method
GET

### Endpoint
`/v1/deals/promotions/`

### Parameters
(No parameters)

### Response
#### Success Response (200)
- **promotions** (array) - A list of promotion objects.

### Response Example
{
  "promotions": [
    {
      "id": "promo123",
      "name": "Holiday Special",
      "discount": "20%"
    }
  ]
}

## GET /v1/deals/promotions/{id}

### Description
Retrieves a specific promotion by its ID.

### Method
GET

### Endpoint
`/v1/deals/promotions/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the promotion to retrieve.

### Response
#### Success Response (200)
- **promotion** (object) - The promotion object.

### Response Example
{
  "promotion": {
    "id": "promo123",
    "name": "Holiday Special",
    "discount": "20%"
  }
}
```

--------------------------------

### Cashback Offers API

Source: https://docs.onsleek.ai/api-reference/deal-endpoint-migration-20250402

Details on migrating Cashback Offer endpoints, including activation and retrieval.

```APIDOC
## Cashback Offers API

### Description
This section details the migration of Cashback Offer endpoints, including changes to activation methods and retrieval endpoints.

### Method
GET, POST

### Endpoint
`/v1/deals/cashback-offers/`
`/v1/deals/cashback-offers/{id}`
`/v1/deals/cashback-offers/{id}/activate`

### Parameters

#### Path Parameters
- **id** (string) - Required - The unique identifier for the cashback offer.

#### Query Parameters
- **orgId** (string) - Required - The organization identifier.

#### Request Body
N/A for GET requests. For POST activation, the request body is empty or can contain additional metadata if supported by future versions.

### Request Example

**Activate Cashback Offer (GET - Redirect)**
```
GET https://api.onsleek.ai/v1/deals/cashback-offers/{id}/activate?orgId=YOUR_ORG_ID
```

**Activate Cashback Offer (POST - JSON Response)**
```
POST https://api.onsleek.ai/v1/deals/cashback-offers/{id}/activate?orgId=YOUR_ORG_ID
```

**Get All Cashback Offers**
```
GET https://api.onsleek.ai/v1/deals/cashback-offers/?orgId=YOUR_ORG_ID
```

**Get Cashback Offer by ID**
```
GET https://api.onsleek.ai/v1/deals/cashback-offers/{id}?orgId=YOUR_ORG_ID
```

### Response

#### Success Response (200)

**For GET requests:** Returns a list of cashback offers or a single cashback offer object.

**For GET activation:** A `302` redirect to the affiliate URL.

**For POST activation:**
```json
{
  "url": "https://affiliate.example.com"
}
```

#### Response Example

**POST Activation Response Example:**
```json
{
  "url": "https://affiliate.example.com/tracking?clickid=123abc"
}
```
```

--------------------------------

### Get All Products

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products

Retrieve all products in the Sleek product feed. The response is paginated, and the nextCursor can be used to fetch the next page.

```APIDOC
## GET /websites/onsleek_ai/products

### Description
Retrieve all products in the Sleek product feed. The response is paginated, and the nextCursor can be used to fetch the next page.

### Method
GET

### Endpoint
/websites/onsleek_ai/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of products to return per page.
- **nextCursor** (string) - Optional - The cursor for fetching the next page of results.

### Response
#### Success Response (200)
- **products** (array) - A list of products.
  - **id** (string) - The unique identifier of the product.
  - **name** (string) - The name of the product.
  - **description** (string) - A description of the product.
  - **price** (number) - The price of the product.
  - **imageUrl** (string) - The URL of the product image.
- **nextCursor** (string) - The cursor to use for fetching the next page of results, or null if there are no more pages.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_123",
      "name": "Example Product",
      "description": "This is a sample product.",
      "price": 19.99,
      "imageUrl": "https://example.com/image.jpg"
    }
  ],
  "nextCursor": "some_cursor_string"
}
```
```

--------------------------------

### General API Changes

Source: https://docs.onsleek.ai/api-reference/deal-endpoint-migration-20250402

Summary of the main changes required for migrating to the new Deals API.

```APIDOC
## General API Changes

### Description
This section details the overarching changes for migrating to the new Deals API, including base URL updates and endpoint restructuring.

### Method
N/A (Applies to all requests)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

**Key Changes:**

*   **Base URL Change:** Update all requests from `https://api.onsleek.io/` to `https://api.onsleek.ai/`.
*   **Endpoint Prefix:** All deal-related endpoints now reside under `/v1/deals/` (e.g., `/v1/cashback-offers/` becomes `/v1/deals/cashback-offers/`).
*   **Activation ID:** The `activationId` (formerly a query parameter) is now a path parameter: `/v1/deals/{endpoint}/{id}/activate`.
*   **POST Activation Response:** The response for POST activation is now a JSON object `{ "url": "https://affiliate.example.com" }`, instead of a plain string.
```

--------------------------------

### GET /v2/products

Source: https://docs.onsleek.ai/api-reference/product-feed/get-all-products-1

Retrieves a paginated list of products. You can use the nextPage query parameter to fetch subsequent pages of results.

```APIDOC
## GET /v2/products

### Description
Retrieves a paginated list of products. This endpoint allows you to fetch product data, including details like name, price, and images. Use the `nextPage` parameter to navigate through the product catalog.

### Method
GET

### Endpoint
/v2/products

### Parameters
#### Path Parameters
None

#### Query Parameters
- **nextPage** (string) - Optional - The next page of products. Must be 6 characters long.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **lastViewedAt** (string) - The last viewed at timestamp.
  - **url** (string) - The URL of the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The most recent price for a single unit of the product.
  - **currencyCode** (string) - The ISO 4217 currency code for the price.
  - **brandName** (string) - The brand name of the product.
  - **description** (string) - A description of the product.
  - **imageUrls** (array of strings) - The URLs of the product images.
  - **categoryId** (string) - The category ID for this product.
  - **categoryVersion** (string) - The version of the category for this product.
  - **categoryBreadcrumb** (string) - The category breadcrumb for this product.
  - **asin** (string) - The Amazon Standard Identification Number for the product.
  - **sku** (string) - The Stock Keeping Unit identifier for the product.
  - **gtin** (string) - The Global Trade Item Number for the product.
  - **mpn** (string) - The Manufacturer Part Number for the product.
  - **ratingValue** (number) - The average rating value for the product.
  - **ratingCount** (number) - The total number of ratings for the product.
  - **bestRating** (number) - The best rating value for the product.
  - **worstRating** (number) - The worst rating value for the product.
  - **history** (array of objects) - Historical data for the product.

#### Response Example
```json
{
  "data": [
    {
      "lastViewedAt": "2023-10-27T10:00:00Z",
      "url": "https://example.com/product/123",
      "name": "Example Product",
      "price": 19.99,
      "currencyCode": "USD",
      "brandName": "ExampleBrand",
      "description": "This is a sample product description.",
      "imageUrls": ["https://example.com/image1.jpg"],
      "categoryId": "cat123",
      "categoryVersion": "v1",
      "categoryBreadcrumb": "Electronics > Gadgets",
      "asin": "B0XXXXXXXXX",
      "sku": "SKU123",
      "gtin": "0123456789012",
      "mpn": "MPN123",
      "ratingValue": 4.5,
      "ratingCount": 100,
      "bestRating": 5,
      "worstRating": 1,
      "history": []
    }
  ]
}
```
```

--------------------------------

### Coupons API

Source: https://docs.onsleek.ai/api-reference/deal-endpoint-migration-20250402

Endpoints for retrieving and activating coupons. Activation endpoints have been updated to use path parameters and a new namespace.

```APIDOC
## GET /v1/deals/coupons/{id}/activate

### Description
Activates a coupon and returns a 302 redirect to the affiliate URL.

### Method
GET

### Endpoint
`/v1/deals/coupons/{id}/activate`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the coupon to activate.
#### Query Parameters
- **orgId** (string) - Required - The organization ID.

### Response
#### Success Response (302)
Redirects to the affiliate URL.

### Response Example
(Redirect to affiliate URL)

## POST /v1/deals/coupons/{id}/activate

### Description
Activates a coupon and returns a JSON object containing the affiliate URL.

### Method
POST

### Endpoint
`/v1/deals/coupons/{id}/activate`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the coupon to activate.
#### Query Parameters
- **orgId** (string) - Required - The organization ID.

### Request Body
(No request body required)

### Response
#### Success Response (200)
- **url** (string) - The affiliate URL.

### Response Example
{
  "url": "https://example.com/affiliate-link"
}

## GET /v1/deals/coupons/

### Description
Retrieves a list of all coupons.

### Method
GET

### Endpoint
`/v1/deals/coupons/`

### Parameters
(No parameters)

### Response
#### Success Response (200)
- **coupons** (array) - A list of coupon objects.

### Response Example
{
  "coupons": [
    {
      "id": "coupon123",
      "name": "Summer Sale",
      "discount": "10%"
    }
  ]
}

## GET /v1/deals/coupons/{id}

### Description
Retrieves a specific coupon by its ID.

### Method
GET

### Endpoint
`/v1/deals/coupons/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the coupon to retrieve.

### Response
#### Success Response (200)
- **coupon** (object) - The coupon object.

### Response Example
{
  "coupon": {
    "id": "coupon123",
    "name": "Summer Sale",
    "discount": "10%"
  }
}
```

--------------------------------

### Get All Known Installed Extensions (TypeScript)

Source: https://docs.onsleek.ai/web-ext-sdk-reference/installed-extensions

This TypeScript code snippet demonstrates how to use the `getAllKnownInstalledExtensions()` method from the Sleek Web Extension SDK to retrieve a list of known extensions that are both installed and enabled in the user's browser. The function returns an array of objects, each containing the 'name' and 'id' of a detected extension. Ensure this code is executed within a tab context where content scripts are permitted.

```typescript
import { getWebExtSdk } from "@sleek/web-ext-sdk";

const knownInstalledExtensions = await getWebExtSdk().getAllKnownInstalledExtensions();

console.log(knownInstalledExtensions);
```

--------------------------------

### Initialize Sleek SDK with JavaScript

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

Initialize the Sleek SDK using the `initializeSdk` function from the `@sleek/sdk` package. Provide your public API key, optional configuration, and an array of event listener functions.

```javascript
import { initializeSdk } from "@sleek/sdk";

initializeSdk("YOUR_PUBLIC_API_KEY_HERE", {
  // Optional configuration options
}, [(event) => {console.log("Received event", event);}]);
```

--------------------------------

### OpenAPI Spec: Get Coupon by ID (YAML)

Source: https://docs.onsleek.ai/api-reference/coupons/get-coupon-by-id

This OpenAPI specification defines the GET /v1/deals/coupons/{id} endpoint for retrieving coupon details. It includes the request method, URL, authentication requirements (API key via bearer token), path parameters (coupon ID), and a detailed schema for the successful JSON response, including fields like coupon code, dates, retailer information, and URLs. The spec also provides an example response.

```yaml
https://api.onsleek.ai/openapi.json get /v1/deals/coupons/{id}
paths:
  path: /v1/deals/coupons/{id}
  method: get
  servers:
    - url: https://api.onsleek.ai
  request:
    security:
      - title: api key
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
              description: API key for accessing the Sleek API.
          cookie: {}
    parameters:
      path:
        id:
          schema:
            - type: string
              required: true
              description: The ID of the coupon to fetch.
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              id:
                allOf:
                  - type: string
                    description: >-
                      The unique identifier for the coupon. Format: `UUID RFC
                      4122`
                    example: ea0efd78-2c3c-4efd-9e92-1ab676ee304b
              code:
                allOf:
                  - type: string
                    description: The coupon code value.
                    example: SAVE20
              startDate:
                allOf:
                  - type: string
                    description: >-
                      The date and time when the coupon becomes active. Format:
                      `ISO 8601`
                    example: '2024-01-01T00:00:00.000Z'
              endDate:
                allOf:
                  - type: string
                    description: >-
                      The date and time when the coupon expires. Format: `ISO
                      8601`
                    example: '2024-12-31T23:59:59.999Z'
              description:
                allOf:
                  - type: string
                    description: The description of the coupon.
                    example: Use SAVE20 coupon code to get 20% off.
              retailerId:
                allOf:
                  - type: string
                    description: >-
                      The ID of the retailer associated with the coupon offer.
                      Format: `UUID RFC 4122`
                    example: 4f9df53d-16dc-4630-8603-8d14ec40fcfe
              url:
                allOf:
                  - type: string
                    description: >-
                      The URL of the retailer's website where the coupon can be
                      used.
                    example: https://www.bestbuy.com
              name:
                allOf:
                  - type: string
                    description: The name of the retailer associated with the coupon.
                    example: BestBuy
              hostname:
                allOf:
                  - type: string
                    description: The hostname of the retailer's website.
                    example: www.bestbuy.com
              logo:
                allOf:
                  - type: string
                    description: The URL of the retailer's logo associated with the coupon.
                    example: https://www.bestbuy.com/logo.png
              updatedAt:
                allOf:
                  - type: string
                    description: >-
                      The date and time when the coupon was last updated.
                      Format: `ISO 8601`
                    example: '2024-01-01T12:00:00.000Z'
            requiredProperties:
              - id
              - code
              - startDate
              - endDate
              - description
              - retailerId
              - url
              - name
              - hostname
              - updatedAt
        examples:
          example:
            value:
              id: ea0efd78-2c3c-4efd-9e92-1ab676ee304b
              code: SAVE20
              startDate: '2024-01-01T00:00:00.000Z'
              endDate: '2024-12-31T23:59:59.999Z'
              description: Use SAVE20 coupon code to get 20% off.
              retailerId: 4f9df53d-16dc-4630-8603-8d14ec40fcfe
              url: https://www.bestbuy.com
              name: BestBuy
              hostname: www.bestbuy.com
              logo: https://www.bestbuy.com/logo.png
              updatedAt: '2024-01-01T12:00:00.000Z'
        description: Coupon by id.
  deprecated: false
  type: path
components:
  schemas: {}
```

--------------------------------

### Listen for SDK Events

Source: https://docs.onsleek.ai/js-sdk-reference/introduction

Pass an array containing listener functions as the third argument to `initializeSdk` to receive and handle SDK events. Each listener will be called with an `SdkEvent` object.

```javascript
initializeSdk("YOUR_PUBLIC_API_KEY_HERE", {},
  [
    (event) => {
      console.log("SDK Event:", event);
    }
  ]
);
```

--------------------------------

### Use onTab context for SDK actions (TypeScript)

Source: https://docs.onsleek.ai/web-ext-sdk-reference/migration-to-web-ext-sdk

The new SDK requires using the '.onTab(tabId)' context for tab-specific actions. This example shows how to initiate coupon auto-application on a specific tab, replacing the older 'fillCouponsOnTab' method.

```typescript
import { getWebExtSdk } from '@sleek/web-ext-sdk';

// Assuming tabId is defined
getWebExtSdk().onTab(tabId).startCouponAutoApply(codes);
```

--------------------------------

### Start Coupon Auto-Apply with Sleek SDK

Source: https://docs.onsleek.ai/js-sdk-reference/coupon-auto-apply

Initiates the coupon auto-apply process using the Sleek SDK. It requires initializing the SDK with an API key and a callback function to handle various coupon session events. The `startCouponAutoApply` method accepts an array of coupon codes to be tested.

```html
<script src="f.js"></script>
<script src="sdk.iife.js"></script>
<script>
  sleek.initializeSdk("YOUR_PUBLIC_API_KEY_HERE", {},
    [(event) => {
      // `event` is typed, so is the data of the event `event.data` based on the type of the event.
      switch (event.type) {
        case SdkEventType.COUPON_SESSION_STARTED:
          console.log("Coupon auto-apply started");
          break;
        case SdkEventType.COUPON_SESSION_RESUMED:
          console.log("Coupon auto-apply resumed");
          break;
        case SdkEventType.COUPON_SESSION_UPDATED:
          console.log("Coupon auto-apply updated");
          break;
        case SdkEventType.COUPON_SESSION_COMPLETED:
          console.log("Coupon auto-apply completed");
          break;
        case SdkEventType.USER_GENERATED_CODE:
          console.log("User entered code:", event.data.code);
          break;
      }
    }]
  );

  sleek.getSdk().startCouponAutoApply(["SAVE10"]);
</script>
```

```typescript
import { initializeSdk, getSdk } from "@sleek/sdk";

initializeSdk("YOUR_PUBLIC_API_KEY_HERE", {},
  [(event) => {
    switch (event.type) {
      case SdkEventType.COUPON_SESSION_STARTED:
        console.log("Coupon auto-apply started");
        break;
      case SdkEventType.COUPON_SESSION_RESUMED:
        console.log("Coupon auto-apply resumed");
        break;
      case SdkEventType.COUPON_SESSION_UPDATED:
        console.log("Coupon auto-apply updated");
        break;
      case SdkEventType.COUPON_SESSION_COMPLETED:
        console.log("Coupon auto-apply completed");
        break;
      case SdkEventType.USER_GENERATED_CODE:
        console.log("User entered code:", event.data.code);
        break;
    }
  }]
);

getSdk().startCouponAutoApply(["SAVE10"]);
```

--------------------------------

### Configure Site Exclusion with Sleek SDK

Source: https://docs.onsleek.ai/web-ext-sdk-reference/introduction

Customizes the Sleek SDK by providing a denylistMatches array in the initialization options. This allows you to specify additional sites where Sleek's content scripts should not run, merging with the built-in filter list.

```javascript
import { initializeWebExtSdk } from "@sleek/web-ext-sdk";

// In your background script constructor or setup.
await initializeWebExtSdk(process.env.YOUR_SLEEK_CLIENT_API_KEY_HERE, {
  denylistMatches: [
    "*://*.example.com/*",
    "*://*.internal.org/*"
  ],
});
```

--------------------------------

### Update package dependencies using pnpm

Source: https://docs.onsleek.ai/web-ext-sdk-reference/migration-to-web-ext-sdk

Remove the legacy coupon SDK and add the new web extension SDK using the pnpm package manager. This command updates your project's dependencies to use the new SDK.

```bash
pnpm remove @sleek/web-ext-coupon-sdk
pnpm add @sleek/web-ext-sdk
```

--------------------------------

### Initialization and Core SDK

Source: https://docs.onsleek.ai/web-ext-sdk-reference/type-doc

Functions for initializing the Web Extension SDK and accessing its core functionalities.

```APIDOC
## initializeWebExtSdk

### Description
Initializes the Web Extension SDK with an API key and optional configuration.

### Method
`initializeWebExtSdk(apiKey: string, options?: Partial<WebExtSdkOptions>, listeners?: WebExtSdkEventListener[]): Promise<WebExtSdk>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Example usage:
initializeWebExtSdk('YOUR_API_KEY', {
  skipManifestValidation: true,
  featureControls: {
    emitAffiliateActivationEvents: true
  }
}).then(sdk => {
  console.log('WebExtSdk initialized:', sdk);
});
```

### Response
#### Success Response (200)
- **WebExtSdk** (object) - The initialized Web Extension SDK instance.

#### Response Example
```json
{
  "sdkInstance": "<sdk_object>"
}
```

---

## getWebExtSdk

### Description
Retrieves the already initialized Web Extension SDK instance.

### Method
`getWebExtSdk(): WebExtSdk`

### Parameters
None

### Request Example
```javascript
const sdk = getWebExtSdk();
console.log('Retrieved WebExtSdk:', sdk);
```

### Response
#### Success Response (200)
- **WebExtSdk** (object) - The currently initialized Web Extension SDK instance.

#### Response Example
```json
{
  "sdkInstance": "<sdk_object>"
}
```
```
Tokens:
Raw