@proveanything/smartlinks 1.15.24 → 1.16.0

package/openapi.yaml

@@ -41,6 +41,7 @@ tags:
   - name: journeys
   - name: journeysAnalytics
   - name: location
+  - name: lots
   - name: loyalty
   - name: nfc
   - name: order
@@ -4825,6 +4826,208 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /admin/collection/{collectionId}/lots/by-number/{lotNumber}:
+    get:
+      tags:
+        - lots
+      summary: Look up a lot by its number (case-insensitive) — used by scan/resolver flows.
+      operationId: lots_getByNumber
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotNumber
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots/{lotId}:
+    get:
+      tags:
+        - lots
+      summary: Get the full lot record.
+      operationId: lots_get
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+    put:
+      tags:
+        - lots
+      summary: Update a lot.
+      operationId: lots_update
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/LotUpdateInput"
+  /admin/collection/{collectionId}/lots/{lotId}/products{opts}:
+    get:
+      tags:
+        - lots
+      summary: Paginated member product summaries.
+      operationId: lots_listProducts
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: opts
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotProductsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots/{lotId}/resolve:
+    post:
+      tags:
+        - lots
+      summary: Re-resolve members from the current selector; returns the lot + a member diff.
+      operationId: lots_resolve
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ResolveLotResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /admin/collection/{collectionId}/lots{params}:
+    get:
+      tags:
+        - lots
+      summary: "List lots (summary rows; `payload`/`productIds` omitted)."
+      operationId: lots_list
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: params
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /admin/collection/{collectionId}/loyaltyScheme:
     get:
       tags:
@@ -11549,6 +11752,135 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /public/collection/{collectionId}/lots/by-number/{lotNumber}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicGetByNumber
+      operationId: lots_publicGetByNumber
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotNumber
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots/{lotId}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicGet
+      operationId: lots_publicGet
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Lot"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots/{lotId}/products{opts}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicListProducts
+      operationId: lots_publicListProducts
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: lotId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: opts
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotProductsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /public/collection/{collectionId}/lots{params}:
+    get:
+      tags:
+        - lots
+      summary: lots.publicList
+      operationId: lots_publicList
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: params
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ListLotsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /public/collection/{collectionId}/loyaltyScheme:
     get:
       tags:
@@ -23355,6 +23687,174 @@ components:
       required:
         - items
         - count
+    LotPayload:
+      type: object
+      properties:
+        manufacturedAt:
+          type: string
+        expiresAt:
+          type: string
+        location:
+          type: string
+        custom:
+          type: object
+          additionalProperties: true
+    Lot:
+      type: object
+      properties:
+        id:
+          type: string
+        collectionId:
+          type: string
+        lotNumber:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        selector:
+          $ref: "#/components/schemas/LotSelector"
+        payload:
+          $ref: "#/components/schemas/LotPayload"
+        destination:
+          type: object
+          additionalProperties: true
+        productCount:
+          type: number
+        productIds:
+          type: array
+          items:
+            type: string
+        resolvedAt:
+          type: string
+        createdBy:
+          type: string
+        updatedBy:
+          type: string
+        createdAt:
+          type: string
+        updatedAt:
+          type: string
+      required:
+        - id
+        - collectionId
+        - lotNumber
+        - status
+        - selector
+        - productCount
+        - createdAt
+        - updatedAt
+    LotCreateInput:
+      type: object
+      properties:
+        lotNumber:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        selector:
+          $ref: "#/components/schemas/LotSelector"
+        payload:
+          $ref: "#/components/schemas/LotPayload"
+        destination:
+          type: object
+          additionalProperties: true
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        id:
+          type: string
+      required:
+        - lotNumber
+    ListLotsParams:
+      type: object
+      properties:
+        status:
+          $ref: "#/components/schemas/LotStatus"
+        search:
+          type: string
+        productId:
+          type: string
+    ListLotsResponse:
+      type: object
+      properties:
+        lots:
+          type: array
+          items:
+            $ref: "#/components/schemas/Lot"
+      required:
+        - lots
+    LotMemberDiff:
+      type: object
+      properties:
+        added:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+      required:
+        - added
+    ResolveLotResponse:
+      type: object
+      properties:
+        lot:
+          type: object
+          additionalProperties: true
+      required:
+        - lot
+    LotProductSummary:
+      type: object
+      properties:
+        id:
+          type: object
+          additionalProperties: true
+      required:
+        - id
+    ListLotProductsResponse:
+      type: object
+      properties:
+        products:
+          type: array
+          items:
+            $ref: "#/components/schemas/LotProductSummary"
+        total:
+          type: number
+        page:
+          type: number
+        limit:
+          type: number
+      required:
+        - products
+        - total
+        - page
+        - limit
+    LotResolutionResult:
+      type: object
+      properties:
+        match:
+          type: string
+          enum:
+            - batch
+            - lot
+            - product
+            - none
+        productId:
+          type: string
+        batchId:
+          type: string
+        lotId:
+          type: string
+        ai10:
+          type: string
+        destination: {}
+      required:
+        - match
+        - productId
+        - batchId
+        - lotId
+        - ai10
     LoyaltyScheme:
       type: object
       properties:
@@ -25050,6 +25550,12 @@ components:
           type: string
         userId:
           type: string
+        batchId:
+          type: string
+        variantId:
+          type: string
+        lotId:
+          type: string
         claimable:
           type: boolean
         virtual:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.15.24",
+  "version": "1.16.0",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",