@zyphr-dev/node-sdk 0.1.67 → 0.1.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zyphr-dev/node-sdk",
3
- "version": "0.1.67",
3
+ "version": "0.1.68",
4
4
  "description": "Official Zyphr SDK for Node.js, React, and React Native",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -73,7 +73,7 @@ export interface AuthEmailVerificationApiInterface {
73
73
  confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
74
74
 
75
75
  /**
76
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
76
+ * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
77
77
  * @summary Resend email verification
78
78
  * @param {ResendEmailVerificationRequest} [resendEmailVerificationRequest]
79
79
  * @param {*} [options] Override http request option.
@@ -83,7 +83,7 @@ export interface AuthEmailVerificationApiInterface {
83
83
  resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>>;
84
84
 
85
85
  /**
86
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
86
+ * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
87
87
  * Resend email verification
88
88
  */
89
89
  resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult>;
@@ -172,7 +172,7 @@ export class AuthEmailVerificationApi extends runtime.BaseAPI implements AuthEma
172
172
  }
173
173
 
174
174
  /**
175
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
175
+ * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
176
176
  * Resend email verification
177
177
  */
178
178
  async resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>> {
@@ -224,7 +224,7 @@ export class AuthEmailVerificationApi extends runtime.BaseAPI implements AuthEma
224
224
  }
225
225
 
226
226
  /**
227
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
227
+ * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
228
228
  * Resend email verification
229
229
  */
230
230
  async resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult> {
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface ResendEmailVerificationRequest {
22
22
  /**
23
- * URL to redirect to after verification
23
+ * URL to redirect to after verification. Same rules as `POST /auth/verify-email/send`.
24
24
  * @type {string}
25
25
  * @memberof ResendEmailVerificationRequest
26
26
  */
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface SendEmailVerificationRequest {
22
22
  /**
23
- * URL to redirect to after verification (snake_case `redirect_url` — a camelCase `redirectUrl` is ignored and the hosted verification page is used instead). Must match one of the application's configured redirect URIs.
23
+ * URL to redirect to after verification. Must be snake_case `redirect_url`: a camelCase `redirectUrl` is rejected with 400, since Zyphr hosts no fallback page. Must match one of the application's configured redirect URIs.
24
24
  * @type {string}
25
25
  * @memberof SendEmailVerificationRequest
26
26
  */