@proveanything/smartlinks 1.9.21 → 1.9.23

package/openapi.yaml

@@ -12287,6 +12287,94 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/CreateCaseInput"
+  /{zone}/collection/{collectionId}/app/{appId}/recordse)}/bulk-delete:
+    post:
+      tags:
+        - records
+      summary: Soft-delete records in bulk.
+      operationId: records_bulkDelete
+      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/BulkDeleteResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: string
+              enum:
+                - facets
+  /{zone}/collection/{collectionId}/app/{appId}/recordse)}/bulk-upsert:
+    post:
+      tags:
+        - records
+      summary: Upsert up to 500 records in a single transaction.
+      operationId: records_bulkUpsert
+      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/BulkUpsertResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: "#/components/schemas/BulkUpsertItem"
   /{zone}/collection/{collectionId}/app/{appId}/recordse)}/summary:
     post:
       tags:
@@ -12329,6 +12417,48 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/CaseSummaryRequest"
+  /{zone}/collection/{collectionId}/app/{appId}/recordse)}/upsert:
+    post:
+      tags:
+        - records
+      summary: "Get aggregate statistics for records POST /records/aggregate / export async function aggregate( collectionId: string, appId: string, request: AggregateRequest, admin: boolean = false ): Promise<AggregateResponse> { const path = `${basePath(collectionId, appId, admin)}/aggregate` return post<AggregateResponse>(path, request) } /** Restore a soft-deleted record."
+      operationId: records_upsert
+      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/UpsertRecordResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpsertRecordInput"
   /{zone}/collection/{collectionId}/app/{appId}/recordse)}/{caseId}/history:
     post:
       tags:
@@ -12465,6 +12595,47 @@ paths:
             schema:
               type: object
               additionalProperties: true
+  /{zone}/collection/{collectionId}/app/{appId}/recordse)}/{recordId}/restore:
+    post:
+      tags:
+        - records
+      summary: "Soft delete a record DELETE /records/:recordId / export async function remove( collectionId: string, appId: string, recordId: string, admin: boolean = false ): Promise<{ success: boolean }> { const path = `${basePath(collectionId, appId, admin)}/${encodeURIComponent(recordId)}` return del<{ success: boolean }>(path) } /** Get aggregate statistics for records POST /records/aggregate / export async function aggregate( collectionId: string, appId: string, request: AggregateRequest, admin: boolean = false ): Promise<AggregateResponse> { const path = `${basePath(collectionId, appId, admin)}/aggregate` return post<AggregateResponse>(path, request) } /** Restore a soft-deleted record."
+      operationId: records_restore
+      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
+        - name: recordId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AppRecord"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/aggregate:
     post:
       tags:
@@ -12507,6 +12678,48 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/AggregateRequest"
+  /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/match:
+    post:
+      tags:
+        - records
+      summary: Match records against a runtime target scope.
+      operationId: records_match
+      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/MatchResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/MatchRecordsInput"
   /{zone}/collection/{collectionId}/app/{appId}/recordsn)}/{caseId}:
     get:
       tags:
@@ -15471,6 +15684,167 @@ components:
           type: string
         contactId:
           type: string
+    ScopeFacetClause:
+      type: object
+      properties:
+        key:
+          type: string
+        valueKeys:
+          type: array
+          items:
+            type: string
+      required:
+        - key
+        - valueKeys
+    RecordScope:
+      type: object
+      properties:
+        productId:
+          type: string
+        variantId:
+          type: string
+        proofId:
+          type: string
+        batchId:
+          type: string
+        facets:
+          type: array
+          items:
+            $ref: "#/components/schemas/ScopeFacetClause"
+    RecordTarget:
+      type: object
+      properties:
+        productId:
+          type: string
+        variantId:
+          type: string
+        proofId:
+          type: string
+        batchId:
+          type: string
+        facets:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+    BulkUpsertItem:
+      type: object
+      properties:
+        ref:
+          type: string
+        recordType:
+          type: string
+        customId:
+          type: string
+        sourceSystem:
+          type: string
+        startsAt:
+          type: string
+        expiresAt:
+          type: string
+        status:
+          type: string
+        scope:
+          $ref: "#/components/schemas/RecordScope"
+        data:
+          type: object
+          additionalProperties: true
+        metadata:
+          type: object
+          additionalProperties: true
+      required:
+        - ref
+    BulkUpsertResult:
+      type: object
+      properties:
+        saved:
+          type: number
+        failed:
+          type: number
+        results:
+          type: object
+          additionalProperties: true
+      required:
+        - saved
+        - failed
+        - results
+    BulkDeleteResult:
+      type: object
+      properties:
+        deleted:
+          type: number
+      required:
+        - deleted
+    MatchResult:
+      type: object
+      properties:
+        records:
+          type: array
+          items:
+            $ref: "#/components/schemas/AppRecord"
+        best:
+          type: object
+          additionalProperties:
+            $ref: "#/components/schemas/AppRecord"
+      required:
+        - records
+    UpsertRecordInput:
+      type: object
+      properties:
+        ref:
+          type: string
+        recordType:
+          type: string
+        customId:
+          type: string
+        sourceSystem:
+          type: string
+        startsAt:
+          type: string
+        expiresAt:
+          type: string
+        status:
+          type: string
+        scope:
+          $ref: "#/components/schemas/RecordScope"
+        data:
+          type: object
+          additionalProperties: true
+        metadata:
+          type: object
+          additionalProperties: true
+      required:
+        - ref
+    UpsertRecordResponse:
+      type: object
+      properties:
+        created:
+          type: boolean
+      required:
+        - created
+    MatchRecordsInput:
+      type: object
+      properties:
+        target:
+          $ref: "#/components/schemas/RecordTarget"
+        strategy:
+          type: string
+          enum:
+            - all
+            - best
+        recordType:
+          type: string
+        limit:
+          type: number
+        includeScheduled:
+          type: boolean
+        includeExpired:
+          type: boolean
+        at:
+          type: string
+      required:
+        - target
     AppRecord:
       type: object
       properties:
@@ -15488,6 +15862,10 @@ components:
           type: string
         ref:
           type: string
+        customId:
+          type: string
+        sourceSystem:
+          type: string
         status:
           type: string
         productId:
@@ -15514,6 +15892,10 @@ components:
           type: string
         deletedAt:
           type: string
+        scope:
+          $ref: "#/components/schemas/RecordScope"
+        specificity:
+          type: number
         data:
           type: object
           additionalProperties: true
@@ -15523,6 +15905,9 @@ components:
         admin:
           type: object
           additionalProperties: true
+        metadata:
+          type: object
+          additionalProperties: true
       required:
         - id
         - orgId
@@ -15531,6 +15916,8 @@ components:
         - visibility
         - recordType
         - ref
+        - customId
+        - sourceSystem
         - status
         - productId
         - proofId
@@ -15544,9 +15931,12 @@ components:
         - startsAt
         - expiresAt
         - deletedAt
+        - scope
+        - specificity
         - data
         - owner
         - admin
+        - metadata
     CreateRecordInput:
       type: object
       properties:
@@ -15576,6 +15966,12 @@ components:
           type: string
         expiresAt:
           type: string
+        scope:
+          $ref: "#/components/schemas/RecordScope"
+        customId:
+          type: string
+        sourceSystem:
+          type: string
         data:
           type: object
           additionalProperties: true
@@ -15585,6 +15981,9 @@ components:
         admin:
           type: object
           additionalProperties: true
+        metadata:
+          type: object
+          additionalProperties: true
       required:
         - recordType
     UpdateRecordInput:
@@ -15611,6 +16010,15 @@ components:
           type: string
         expiresAt:
           type: string
+        scope:
+          $ref: "#/components/schemas/RecordScope"
+        customId:
+          type: string
+        sourceSystem:
+          type: string
+        metadata:
+          type: object
+          additionalProperties: true
     RecordListQueryParams:
       type: object
       properties:
@@ -15618,8 +16026,24 @@ components:
           type: string
         ref:
           type: string
+        refPrefix:
+          type: string
+        customId:
+          type: string
+        sourceSystem:
+          type: string
+        status:
+          type: string
         proofId:
           type: string
+        productId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        q:
+          type: string
         authorId:
           type: string
         parentType:
@@ -15630,6 +16054,12 @@ components:
           type: string
         expiresAt:
           type: string
+        includeScheduled:
+          type: boolean
+        includeExpired:
+          type: boolean
+        at:
+          type: string
         contactId:
           type: string
     RelatedResponse:

package/package.json

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