@proveanything/smartlinks 1.13.6 → 1.13.9

package/openapi.yaml

@@ -2198,39 +2198,6 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/BroadcastSendTestRequest"
-  /admin/collection/{collectionId}/comm.send:
-    post:
-      tags:
-        - comms
-      summary: Send a single transactional message to one contact using a template.
-      operationId: comms_sendTransactional
-      security:
-        - bearerAuth: []
-      parameters:
-        - name: collectionId
-          in: path
-          required: true
-          schema:
-            type: string
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/TransactionalSendResult"
-        400:
-          description: Bad request
-        401:
-          description: Unauthorized
-        404:
-          description: Not found
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/TransactionalSendRequest"
   /admin/collection/{collectionId}/comm.settings:
     get:
       tags:
@@ -7856,6 +7823,39 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/TranslationUpdateRequest"
+  /admin/collection/{encodedCollectionId}/comm/send:
+    post:
+      tags:
+        - comms
+      summary: Send a single transactional message to one contact using a template.
+      operationId: comms_sendTransactional
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: encodedCollectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionalSendResult"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TransactionalSendRequest"
   /authKit/{authKitId}/config:
     get:
       tags:
@@ -8329,7 +8329,7 @@ paths:
     post:
       tags:
         - authKit
-      summary: Verify phone verification code (public).
+      summary: Upsert contact identity after lightweight verification (public).
       operationId: authKit_requestPasswordReset
       security: []
       parameters:
@@ -8391,6 +8391,64 @@ paths:
             schema:
               type: object
               additionalProperties: true
+  /authkit/{clientId}/auth/sms/send:
+    post:
+      tags:
+        - authKit
+      summary: Send an SMS click-to-verify link (public).
+      operationId: authKit_sendSmsVerify
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SendSmsVerifyResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SendSmsVerifyRequest"
+  /authkit/{clientId}/auth/sms/verify:
+    post:
+      tags:
+        - authKit
+      summary: Verify an SMS click-to-verify token via API (public).
+      operationId: authKit_verifySms
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/VerifySmsResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /authkit/{clientId}/auth/verify-email:
     post:
       tags:
@@ -8443,6 +8501,122 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /authkit/{clientId}/auth/whatsapp/send:
+    post:
+      tags:
+        - authKit
+      summary: Send a WhatsApp verification deep-link (public).
+      operationId: authKit_sendWhatsApp
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SendWhatsAppResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SendWhatsAppRequest"
+  /authkit/{clientId}/auth/whatsapp/status:
+    get:
+      tags:
+        - authKit
+      summary: Poll WhatsApp verification status for a token (public).
+      operationId: authKit_getWhatsAppStatus
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/WhatsAppStatusResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /authkit/{clientId}/auth/whatsapp/verify:
+    post:
+      tags:
+        - authKit
+      summary: Manually verify WhatsApp token if inbound webhook path is unavailable (public).
+      operationId: authKit_verifyWhatsApp
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/VerifyWhatsAppResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /authkit/{clientId}/contact/upsert:
+    post:
+      tags:
+        - authKit
+      summary: Upsert contact identity after lightweight verification (public).
+      operationId: authKit_upsertContact
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/UpsertContactResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpsertContactRequest"
   /platform/location:
     post:
       tags:
@@ -12328,7 +12502,7 @@ paths:
     get:
       tags:
         - records
-      summary: List records with optional query parameters GET /records
+      summary: "List records with optional query parameters GET /records Public/owner callers only receive records with `status: \"active\"`."
       operationId: records_list
       security: []
       parameters:
@@ -12347,6 +12521,11 @@ paths:
           required: true
           schema:
             type: string
+        - name: status
+          in: query
+          required: false
+          schema:
+            type: string
         - name: recordType
           in: query
           required: false
@@ -16266,6 +16445,8 @@ components:
     RecordListQueryParams:
       type: object
       properties:
+        status:
+          type: string
         recordType:
           type: string
         ref:
@@ -17683,6 +17864,139 @@ components:
       required:
         - success
         - message
+    SendWhatsAppRequest:
+      type: object
+      properties:
+        phoneNumber:
+          type: string
+        redirectUrl:
+          type: string
+      required:
+        - phoneNumber
+        - redirectUrl
+    SendWhatsAppResponse:
+      type: object
+      properties:
+        waLink:
+          type: string
+        code:
+          type: string
+        token:
+          type: string
+        expiresAt:
+          type: string
+      required:
+        - waLink
+        - code
+        - token
+        - expiresAt
+    VerifyWhatsAppResponse:
+      type: object
+      properties:
+        success:
+          type: boolean
+        verified:
+          type: boolean
+        redirectUrl:
+          type: string
+      required:
+        - success
+        - verified
+    WhatsAppStatusResponse:
+      type: object
+      properties:
+        ok:
+          type: boolean
+        status:
+          $ref: "#/components/schemas/VerifyStatus"
+        verified:
+          type: boolean
+        redirectUrl:
+          type: string
+        phoneNumber:
+          type: string
+        updatedAt: {}
+      required:
+        - ok
+        - status
+        - verified
+    SendSmsVerifyRequest:
+      type: object
+      properties:
+        phoneNumber:
+          type: string
+        redirectUrl:
+          type: string
+        ctaText:
+          type: string
+      required:
+        - phoneNumber
+        - redirectUrl
+    SendSmsVerifyResponse:
+      type: object
+      properties:
+        success:
+          type: boolean
+        expiresAt:
+          type: string
+      required:
+        - success
+        - expiresAt
+    VerifySmsResponse:
+      type: object
+      properties:
+        verified:
+          type: boolean
+        redirectUrl:
+          type: string
+        phoneNumber:
+          type: string
+      required:
+        - verified
+    UpsertContactRequest:
+      type: object
+      properties:
+        collectionId:
+          type: string
+        phone:
+          type: string
+        email:
+          type: string
+        name:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        displayName:
+          type: string
+        source:
+          type: string
+        customFields:
+          type: object
+          additionalProperties: true
+        externalIds:
+          type: object
+          additionalProperties: true
+    UpsertContactResponse:
+      type: object
+      properties:
+        ok:
+          type: boolean
+        collectionId:
+          type: string
+        contactId:
+          type: string
+        userId:
+          type: string
+        created:
+          type: boolean
+      required:
+        - ok
+        - collectionId
+        - contactId
+        - userId
+        - created
     AuthKitBrandingConfig:
       type: object
       properties:
@@ -18865,6 +19179,7 @@ components:
           enum:
             - email
             - sms
+            - whatsapp
             - push
             - wallet
             - preferred
@@ -18906,6 +19221,7 @@ components:
           enum:
             - email
             - sms
+            - whatsapp
             - push
             - wallet
         messageId:
@@ -20805,6 +21121,10 @@ components:
             $ref: "#/components/schemas/InteractionDisplay"
         interactionType:
           type: string
+        effects:
+          type: array
+          items:
+            $ref: "#/components/schemas/InteractionEffect"
         createdAt:
           type: string
       required:
@@ -20880,6 +21200,183 @@ components:
             - FORBIDDEN
       required:
         - error
+    InteractionEffect:
+      type: object
+      properties:
+        type:
+          $ref: "#/components/schemas/EffectType"
+        config:
+          $ref: "#/components/schemas/EffectConfig"
+      required:
+        - type
+    LoyaltyEffectConfig:
+      type: object
+      properties: {}
+    TransactionalEffectConfig:
+      type: object
+      properties:
+        templateId:
+          type: string
+        channel:
+          type: string
+          enum:
+            - email
+            - sms
+            - push
+            - whatsapp
+            - wallet
+            - preferred
+        props:
+          type: object
+          additionalProperties: true
+        include:
+          type: object
+          additionalProperties: true
+        productId:
+          type: string
+        proofId:
+          type: string
+        user:
+          type: boolean
+        appCase:
+          type: string
+        appThread:
+          type: string
+        appRecord:
+          type: string
+        appId:
+          type: string
+      required:
+        - templateId
+    WebhookEffectConfig:
+      type: object
+      properties:
+        url:
+          type: string
+        method:
+          type: string
+          enum:
+            - GET
+            - POST
+            - PUT
+            - PATCH
+            - DELETE
+        headers:
+          type: object
+          additionalProperties:
+            type: string
+        body:
+          type: object
+          additionalProperties: true
+        timeout:
+          type: number
+      required:
+        - url
+    TagEffectConfig:
+      type: object
+      properties:
+        tags:
+          type: array
+          items:
+            type: string
+        action:
+          type: string
+          enum:
+            - add
+            - remove
+      required:
+        - tags
+    AppRecordEffectConfig:
+      type: object
+      properties:
+        appId:
+          type: string
+        recordType:
+          type: string
+        singletonPer:
+          type: string
+        data:
+          type: object
+          additionalProperties: true
+        anchors:
+          type: object
+          additionalProperties: true
+        productId:
+          type: string
+        proofId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+    SegmentEffectConfig:
+      type: object
+      properties:
+        segmentId:
+          type: string
+        action:
+          type: string
+          enum:
+            - add
+            - remove
+      required:
+        - segmentId
+    InteractionEventContext:
+      type: object
+      properties:
+        eventId:
+          type: string
+        collectionId:
+          type: string
+        appId:
+          type: string
+        interactionId:
+          type: string
+        contactId:
+          type: string
+        userId:
+          type: string
+        productId:
+          type: string
+        proofId:
+          type: string
+        variantId:
+          type: string
+        batchId:
+          type: string
+        outcome:
+          type: string
+        eventType:
+          type: string
+        source:
+          type: string
+        timestamp:
+          type: string
+        metadata:
+          type: object
+          additionalProperties: true
+        broadcastId:
+          type: string
+        journeyId:
+          type: string
+      required:
+        - eventId
+        - collectionId
+        - appId
+        - interactionId
+        - contactId
+        - userId
+        - productId
+        - proofId
+        - variantId
+        - batchId
+        - outcome
+        - eventType
+        - source
+        - timestamp
+        - metadata
+        - broadcastId
+        - journeyId
     Job:
       type: object
       properties:

package/package.json

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