@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/dist/index.d.cts CHANGED
@@ -15128,7 +15128,7 @@ declare function ReplayWebhookEventsRequestToJSONTyped(value?: ReplayWebhookEven
15128
15128
  */
15129
15129
  interface ResendEmailVerificationRequest {
15130
15130
  /**
15131
- * URL to redirect to after verification
15131
+ * URL to redirect to after verification. Same rules as `POST /auth/verify-email/send`.
15132
15132
  * @type {string}
15133
15133
  * @memberof ResendEmailVerificationRequest
15134
15134
  */
@@ -16521,7 +16521,7 @@ declare function SendEmailResponseToJSONTyped(value?: SendEmailResponse | null,
16521
16521
  */
16522
16522
  interface SendEmailVerificationRequest {
16523
16523
  /**
16524
- * 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.
16524
+ * 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.
16525
16525
  * @type {string}
16526
16526
  * @memberof SendEmailVerificationRequest
16527
16527
  */
@@ -25924,7 +25924,7 @@ interface AuthEmailVerificationApiInterface {
25924
25924
  */
25925
25925
  confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
25926
25926
  /**
25927
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25927
+ * 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.
25928
25928
  * @summary Resend email verification
25929
25929
  * @param {ResendEmailVerificationRequest} [resendEmailVerificationRequest]
25930
25930
  * @param {*} [options] Override http request option.
@@ -25933,7 +25933,7 @@ interface AuthEmailVerificationApiInterface {
25933
25933
  */
25934
25934
  resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SuccessResult>>;
25935
25935
  /**
25936
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25936
+ * 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.
25937
25937
  * Resend email verification
25938
25938
  */
25939
25939
  resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SuccessResult>;
@@ -25967,12 +25967,12 @@ declare class AuthEmailVerificationApi extends BaseAPI implements AuthEmailVerif
25967
25967
  */
25968
25968
  confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
25969
25969
  /**
25970
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25970
+ * 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.
25971
25971
  * Resend email verification
25972
25972
  */
25973
25973
  resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SuccessResult>>;
25974
25974
  /**
25975
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25975
+ * 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.
25976
25976
  * Resend email verification
25977
25977
  */
25978
25978
  resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SuccessResult>;
package/dist/index.d.ts CHANGED
@@ -15128,7 +15128,7 @@ declare function ReplayWebhookEventsRequestToJSONTyped(value?: ReplayWebhookEven
15128
15128
  */
15129
15129
  interface ResendEmailVerificationRequest {
15130
15130
  /**
15131
- * URL to redirect to after verification
15131
+ * URL to redirect to after verification. Same rules as `POST /auth/verify-email/send`.
15132
15132
  * @type {string}
15133
15133
  * @memberof ResendEmailVerificationRequest
15134
15134
  */
@@ -16521,7 +16521,7 @@ declare function SendEmailResponseToJSONTyped(value?: SendEmailResponse | null,
16521
16521
  */
16522
16522
  interface SendEmailVerificationRequest {
16523
16523
  /**
16524
- * 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.
16524
+ * 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.
16525
16525
  * @type {string}
16526
16526
  * @memberof SendEmailVerificationRequest
16527
16527
  */
@@ -25924,7 +25924,7 @@ interface AuthEmailVerificationApiInterface {
25924
25924
  */
25925
25925
  confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
25926
25926
  /**
25927
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25927
+ * 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.
25928
25928
  * @summary Resend email verification
25929
25929
  * @param {ResendEmailVerificationRequest} [resendEmailVerificationRequest]
25930
25930
  * @param {*} [options] Override http request option.
@@ -25933,7 +25933,7 @@ interface AuthEmailVerificationApiInterface {
25933
25933
  */
25934
25934
  resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SuccessResult>>;
25935
25935
  /**
25936
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25936
+ * 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.
25937
25937
  * Resend email verification
25938
25938
  */
25939
25939
  resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SuccessResult>;
@@ -25967,12 +25967,12 @@ declare class AuthEmailVerificationApi extends BaseAPI implements AuthEmailVerif
25967
25967
  */
25968
25968
  confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
25969
25969
  /**
25970
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25970
+ * 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.
25971
25971
  * Resend email verification
25972
25972
  */
25973
25973
  resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SuccessResult>>;
25974
25974
  /**
25975
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
25975
+ * 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.
25976
25976
  * Resend email verification
25977
25977
  */
25978
25978
  resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SuccessResult>;
package/dist/index.js CHANGED
@@ -17949,7 +17949,7 @@ var AuthEmailVerificationApi = class extends BaseAPI {
17949
17949
  return await response.value();
17950
17950
  }
17951
17951
  /**
17952
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
17952
+ * 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.
17953
17953
  * Resend email verification
17954
17954
  */
17955
17955
  async resendEmailVerificationRaw(requestParameters, initOverrides) {
@@ -17989,7 +17989,7 @@ var AuthEmailVerificationApi = class extends BaseAPI {
17989
17989
  return new JSONApiResponse(response, (jsonValue) => SuccessResultFromJSON(jsonValue));
17990
17990
  }
17991
17991
  /**
17992
- * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
17992
+ * 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.
17993
17993
  * Resend email verification
17994
17994
  */
17995
17995
  async resendEmailVerification(resendEmailVerificationRequest, initOverrides) {