@proveanything/smartlinks 1.10.0 → 1.10.2

package/openapi.yaml

@@ -12404,6 +12404,90 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/MatchRecordsInput"
+  /{zone}/collection/{collectionId}/app/{appId}/records/preview-rule:
+    post:
+      tags:
+        - records
+      summary: Preview which products in the collection match a given facetRule.
+      operationId: records_previewRule
+      security: []
+      parameters:
+        - name: zone
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: appId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PreviewRuleResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PreviewRuleParams"
+  /{zone}/collection/{collectionId}/app/{appId}/records/resolve-all:
+    post:
+      tags:
+        - records
+      summary: Resolve every applicable record for a product context in one call.
+      operationId: records_resolveAll
+      security: []
+      parameters:
+        - name: zone
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: appId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ResolveAllResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ResolveAllParams"
   /{zone}/collection/{collectionId}/app/{appId}/records/upsert:
     post:
       tags:
@@ -15514,33 +15598,27 @@ components:
           type: string
         contactId:
           type: string
-    ScopeFacetClause:
+    FacetRuleClause:
       type: object
       properties:
-        key:
+        facetKey:
           type: string
-        valueKeys:
+        anyOf:
           type: array
           items:
             type: string
       required:
-        - key
-        - valueKeys
-    RecordScope:
+        - facetKey
+        - anyOf
+    FacetRule:
       type: object
       properties:
-        productId:
-          type: string
-        variantId:
-          type: string
-        proofId:
-          type: string
-        batchId:
-          type: string
-        facets:
+        all:
           type: array
           items:
-            $ref: "#/components/schemas/ScopeFacetClause"
+            $ref: "#/components/schemas/FacetRuleClause"
+      required:
+        - all
     RecordTarget:
       type: object
       properties:
@@ -15565,6 +15643,14 @@ components:
           type: string
         recordType:
           type: string
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        proofId:
+          type: string
         customId:
           type: string
         sourceSystem:
@@ -15575,14 +15661,14 @@ components:
           type: string
         status:
           type: string
-        scope:
-          $ref: "#/components/schemas/RecordScope"
         data:
           type: object
           additionalProperties: true
         metadata:
           type: object
           additionalProperties: true
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
       required:
         - ref
     BulkUpsertResult:
@@ -15606,26 +15692,35 @@ components:
           type: number
       required:
         - deleted
-    MatchedRecord:
+    MatchEntry:
       type: object
       properties:
         matchedAt:
-          $ref: "#/components/schemas/MatchedAtLevel"
+          $ref: "#/components/schemas/MatchedAt"
+        matchedRule:
+          $ref: "#/components/schemas/FacetRule"
+        matchedClauseCount:
+          type: number
       required:
         - matchedAt
     MatchResult:
       type: object
       properties:
-        records:
+        data:
           type: array
           items:
-            $ref: "#/components/schemas/MatchedRecord"
-        best:
-          type: object
-          additionalProperties:
-            $ref: "#/components/schemas/MatchedRecord"
+            $ref: "#/components/schemas/MatchEntry"
+        total:
+          type: number
+        strategy:
+          type: string
+          enum:
+            - all
+            - best
       required:
-        - records
+        - data
+        - total
+        - strategy
     UpsertRecordInput:
       type: object
       properties:
@@ -15633,6 +15728,14 @@ components:
           type: string
         recordType:
           type: string
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        proofId:
+          type: string
         customId:
           type: string
         sourceSystem:
@@ -15643,14 +15746,14 @@ components:
           type: string
         status:
           type: string
-        scope:
-          $ref: "#/components/schemas/RecordScope"
         data:
           type: object
           additionalProperties: true
         metadata:
           type: object
           additionalProperties: true
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
       required:
         - ref
     UpsertRecordResponse:
@@ -15699,14 +15802,24 @@ components:
           type: string
         ref:
           type: string
+        scopeType:
+          type: string
+        scopeId:
+          type: string
         customId:
           type: string
+        customIdNormalized:
+          type: string
         sourceSystem:
           type: string
         status:
           type: string
         productId:
           type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
         proofId:
           type: string
         contactId:
@@ -15729,10 +15842,12 @@ components:
           type: string
         deletedAt:
           type: string
-        scope:
-          $ref: "#/components/schemas/RecordScope"
         specificity:
           type: number
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
+        singletonKey:
+          type: string
         data:
           type: object
           additionalProperties: true
@@ -15753,10 +15868,15 @@ components:
         - visibility
         - recordType
         - ref
+        - scopeType
+        - scopeId
         - customId
+        - customIdNormalized
         - sourceSystem
         - status
         - productId
+        - variantId
+        - batchId
         - proofId
         - contactId
         - authorId
@@ -15768,8 +15888,9 @@ components:
         - startsAt
         - expiresAt
         - deletedAt
-        - scope
         - specificity
+        - facetRule
+        - singletonKey
         - data
         - owner
         - admin
@@ -15787,6 +15908,10 @@ components:
           type: string
         productId:
           type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
         proofId:
           type: string
         contactId:
@@ -15803,12 +15928,16 @@ components:
           type: string
         expiresAt:
           type: string
-        scope:
-          $ref: "#/components/schemas/RecordScope"
+        scopeType:
+          type: string
+        scopeId:
+          type: string
         customId:
           type: string
         sourceSystem:
           type: string
+        singletonPer:
+          type: string
         data:
           type: object
           additionalProperties: true
@@ -15821,8 +15950,8 @@ components:
         metadata:
           type: object
           additionalProperties: true
-      required:
-        - recordType
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
     UpdateRecordInput:
       type: object
       properties:
@@ -15843,12 +15972,22 @@ components:
           type: string
         recordType:
           type: string
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        proofId:
+          type: string
         startsAt:
           type: string
         expiresAt:
           type: string
-        scope:
-          $ref: "#/components/schemas/RecordScope"
+        scopeType:
+          type: string
+        scopeId:
+          type: string
         customId:
           type: string
         sourceSystem:
@@ -15856,6 +15995,8 @@ components:
         metadata:
           type: object
           additionalProperties: true
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
     RecordListQueryParams:
       type: object
       properties:
@@ -15897,6 +16038,130 @@ components:
           type: string
         includeDeleted:
           type: boolean
+    ResolveAllParams:
+      type: object
+      properties:
+        context:
+          type: object
+          additionalProperties: true
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        proofId:
+          type: string
+        facets:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: object
+              additionalProperties: true
+        recordType:
+          type: string
+        tiers:
+          type: array
+          items:
+            type: string
+            enum:
+              - proof
+              - batch
+              - variant
+              - product
+              - rule
+              - facet
+              - collection
+        limit:
+          type: number
+        at:
+          type: string
+        includeScheduled:
+          type: boolean
+        includeExpired:
+          type: boolean
+      required:
+        - context
+    ResolveAllResult:
+      type: object
+      properties:
+        records:
+          type: array
+          items:
+            $ref: "#/components/schemas/ResolveAllEntry"
+        total:
+          type: number
+        context:
+          $ref: "#/components/schemas/ResolveAllContext"
+        truncated:
+          type: boolean
+      required:
+        - records
+        - total
+        - context
+        - truncated
+    ResolveAllEntry:
+      type: object
+      properties:
+        record:
+          $ref: "#/components/schemas/AppRecord"
+        matchedAt:
+          $ref: "#/components/schemas/MatchedAt"
+        specificity:
+          type: number
+        matchedRule:
+          $ref: "#/components/schemas/FacetRule"
+        matchedClauseCount:
+          type: number
+      required:
+        - record
+        - matchedAt
+        - specificity
+    ResolveAllContext:
+      type: object
+      properties:
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        proofId:
+          type: string
+        facets:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+    PreviewRuleParams:
+      type: object
+      properties:
+        facetRule:
+          $ref: "#/components/schemas/FacetRule"
+        recordType:
+          type: string
+        limit:
+          type: number
+      required:
+        - facetRule
+    PreviewRuleResult:
+      type: object
+      properties:
+        matchingProducts:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        total:
+          type: number
+        rule:
+          $ref: "#/components/schemas/FacetRule"
+      required:
+        - matchingProducts
+        - total
+        - rule
     RelatedResponse:
       type: object
       properties:

package/package.json

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