@zyphr-dev/node-sdk 0.1.22 → 0.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyphr-dev/node-sdk",
-  "version": "0.1.22",
+  "version": "0.1.23",
   "description": "Official Zyphr SDK for Node.js, React, and React Native",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,6 +28,9 @@
     "build": "tsup",
     "lint": "tsc --noEmit",
     "test": "echo 'No tests yet for generated SDK'",
+    "examples:typecheck": "tsc --noEmit -p examples/tsconfig.json",
+    "readme:check": "node ../scripts/verify-readme-methods.mjs",
+    "verify": "yarn lint && yarn examples:typecheck && yarn readme:check",
     "clean": "rm -rf dist"
   },
   "devDependencies": {

package/src/errors.ts

@@ -82,6 +82,26 @@ export class ZyphrNotFoundError extends ZyphrError {
   }
 }
 
+/**
+ * Thrown when a Zyphr webhook signature fails verification.
+ *
+ * Use the verification helper shown in `examples/14-webhook-handler.ts`
+ * (or write your own) to detect tampered or replayed webhook deliveries.
+ */
+export class ZyphrWebhookVerificationError extends ZyphrError {
+  constructor(message: string) {
+    super({ message, status: 401, code: 'webhook_verification_failed' });
+    this.name = 'ZyphrWebhookVerificationError';
+  }
+}
+
+/**
+ * Alias for {@link ZyphrWebhookVerificationError}. Provided for symmetry with
+ * `Zyphr*Error` naming and shorter import statements in webhook handlers.
+ */
+export const WebhookVerificationError = ZyphrWebhookVerificationError;
+export type WebhookVerificationError = ZyphrWebhookVerificationError;
+
 /**
  * Parse an API error response and throw the appropriate ZyphrError subclass.
  */

package/src/src/models/CreateTemplateRequest.ts

@@ -49,12 +49,6 @@ export interface CreateTemplateRequest {
      * @memberof CreateTemplateRequest
      */
     text?: string;
-    /**
-     * Default variable values
-     * @type {{ [key: string]: any; }}
-     * @memberof CreateTemplateRequest
-     */
-    variables?: { [key: string]: any; };
 }
 
 /**
@@ -80,7 +74,6 @@ export function CreateTemplateRequestFromJSONTyped(json: any, ignoreDiscriminato
         'subject': json['subject'] == null ? undefined : json['subject'],
         'html': json['html'] == null ? undefined : json['html'],
         'text': json['text'] == null ? undefined : json['text'],
-        'variables': json['variables'] == null ? undefined : json['variables'],
     };
 }
 
@@ -100,7 +93,6 @@ export function CreateTemplateRequestToJSONTyped(value?: CreateTemplateRequest |
         'subject': value['subject'],
         'html': value['html'],
         'text': value['text'],
-        'variables': value['variables'],
     };
 }
 

package/src/src/models/Template.ts

@@ -56,11 +56,13 @@ export interface Template {
      */
     text?: string | null;
     /**
+     * Variable names auto-detected from `{{var}}` placeholders in subject,
+     * html, and text. Server-derived; ignored if supplied on create/update.
      * 
-     * @type {object}
+     * @type {Array<string>}
      * @memberof Template
      */
-    variables?: object | null;
+    readonly variables?: Array<string> | null;
     /**
      * 
      * @type {number}
@@ -115,7 +117,7 @@ export function TemplateToJSON(json: any): Template {
     return TemplateToJSONTyped(json, false);
 }
 
-export function TemplateToJSONTyped(value?: Template | null, ignoreDiscriminator: boolean = false): any {
+export function TemplateToJSONTyped(value?: Omit<Template, 'variables'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -128,7 +130,6 @@ export function TemplateToJSONTyped(value?: Template | null, ignoreDiscriminator
         'subject': value['subject'],
         'html': value['html'],
         'text': value['text'],
-        'variables': value['variables'],
         'version': value['version'],
         'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
         'updated_at': value['updatedAt'] == null ? undefined : ((value['updatedAt']).toISOString()),

package/src/src/models/UpdateTemplateRequest.ts

@@ -49,12 +49,6 @@ export interface UpdateTemplateRequest {
      * @memberof UpdateTemplateRequest
      */
     text?: string;
-    /**
-     * 
-     * @type {{ [key: string]: any; }}
-     * @memberof UpdateTemplateRequest
-     */
-    variables?: { [key: string]: any; };
 }
 
 /**
@@ -79,7 +73,6 @@ export function UpdateTemplateRequestFromJSONTyped(json: any, ignoreDiscriminato
         'subject': json['subject'] == null ? undefined : json['subject'],
         'html': json['html'] == null ? undefined : json['html'],
         'text': json['text'] == null ? undefined : json['text'],
-        'variables': json['variables'] == null ? undefined : json['variables'],
     };
 }
 
@@ -99,7 +92,6 @@ export function UpdateTemplateRequestToJSONTyped(value?: UpdateTemplateRequest |
         'subject': value['subject'],
         'html': value['html'],
         'text': value['text'],
-        'variables': value['variables'],
     };
 }