@zyphr-dev/node-sdk 0.1.25 → 0.1.26
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/README.md +6 -0
- package/dist/index.cjs +147 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +150 -1
- package/dist/index.d.ts +150 -1
- package/dist/index.js +130 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +3 -0
- package/src/errors.ts +31 -0
- package/src/src/apis/AuthEmailTemplatesApi.ts +3 -0
- package/src/src/apis/EmailsApi.ts +3 -0
- package/src/src/apis/InboxApi.ts +3 -0
- package/src/src/apis/PushApi.ts +3 -0
- package/src/src/apis/SMSApi.ts +3 -0
- package/src/src/apis/TemplatesApi.ts +3 -0
- package/src/src/models/PayloadTooLargeError.ts +89 -0
- package/src/src/models/PayloadTooLargeErrorError.ts +101 -0
- package/src/src/models/PayloadTooLargeErrorErrorDetails.ts +73 -0
- package/src/src/models/index.ts +3 -0
package/README.md
CHANGED
|
@@ -498,6 +498,7 @@ import {
|
|
|
498
498
|
ZyphrAuthenticationError,
|
|
499
499
|
ZyphrRateLimitError,
|
|
500
500
|
ZyphrNotFoundError,
|
|
501
|
+
ZyphrPayloadTooLargeError,
|
|
501
502
|
} from '@zyphr-dev/node-sdk';
|
|
502
503
|
|
|
503
504
|
try {
|
|
@@ -509,6 +510,9 @@ try {
|
|
|
509
510
|
console.log('Invalid input:', error.details); // 400/422
|
|
510
511
|
} else if (error instanceof ZyphrAuthenticationError) {
|
|
511
512
|
console.log('Check your API key'); // 401/403
|
|
513
|
+
} else if (error instanceof ZyphrPayloadTooLargeError) {
|
|
514
|
+
// 413 — see https://zyphr.dev/resources/api-limits
|
|
515
|
+
console.log(`Body too large: sent ${error.receivedBytes}, max ${error.limitBytes}`);
|
|
512
516
|
} else if (error instanceof ZyphrRateLimitError) {
|
|
513
517
|
console.log('Retry after:', error.retryAfter); // 429
|
|
514
518
|
} else if (error instanceof ZyphrError) {
|
|
@@ -528,6 +532,8 @@ All error classes extend `ZyphrError`, which extends `Error`:
|
|
|
528
532
|
| `requestId` | `string \| undefined` | Request ID for support tickets |
|
|
529
533
|
| `details` | `Record<string, unknown> \| undefined` | Validation errors and context |
|
|
530
534
|
| `retryAfter` | `number \| undefined` | Seconds to wait (`ZyphrRateLimitError` only) |
|
|
535
|
+
| `limitBytes` | `number \| undefined` | Server-enforced body cap (`ZyphrPayloadTooLargeError` only) |
|
|
536
|
+
| `receivedBytes` | `number \| undefined` | Size of the rejected body (`ZyphrPayloadTooLargeError` only) |
|
|
531
537
|
|
|
532
538
|
## Bundle
|
|
533
539
|
|
package/dist/index.cjs
CHANGED
|
@@ -710,6 +710,19 @@ __export(index_exports, {
|
|
|
710
710
|
PasswordRequirementsResponseToJSONTyped: () => PasswordRequirementsResponseToJSONTyped,
|
|
711
711
|
PasswordRequirementsToJSON: () => PasswordRequirementsToJSON,
|
|
712
712
|
PasswordRequirementsToJSONTyped: () => PasswordRequirementsToJSONTyped,
|
|
713
|
+
PayloadTooLargeErrorErrorCodeEnum: () => PayloadTooLargeErrorErrorCodeEnum,
|
|
714
|
+
PayloadTooLargeErrorErrorDetailsFromJSON: () => PayloadTooLargeErrorErrorDetailsFromJSON,
|
|
715
|
+
PayloadTooLargeErrorErrorDetailsFromJSONTyped: () => PayloadTooLargeErrorErrorDetailsFromJSONTyped,
|
|
716
|
+
PayloadTooLargeErrorErrorDetailsToJSON: () => PayloadTooLargeErrorErrorDetailsToJSON,
|
|
717
|
+
PayloadTooLargeErrorErrorDetailsToJSONTyped: () => PayloadTooLargeErrorErrorDetailsToJSONTyped,
|
|
718
|
+
PayloadTooLargeErrorErrorFromJSON: () => PayloadTooLargeErrorErrorFromJSON,
|
|
719
|
+
PayloadTooLargeErrorErrorFromJSONTyped: () => PayloadTooLargeErrorErrorFromJSONTyped,
|
|
720
|
+
PayloadTooLargeErrorErrorToJSON: () => PayloadTooLargeErrorErrorToJSON,
|
|
721
|
+
PayloadTooLargeErrorErrorToJSONTyped: () => PayloadTooLargeErrorErrorToJSONTyped,
|
|
722
|
+
PayloadTooLargeErrorFromJSON: () => PayloadTooLargeErrorFromJSON,
|
|
723
|
+
PayloadTooLargeErrorFromJSONTyped: () => PayloadTooLargeErrorFromJSONTyped,
|
|
724
|
+
PayloadTooLargeErrorToJSON: () => PayloadTooLargeErrorToJSON,
|
|
725
|
+
PayloadTooLargeErrorToJSONTyped: () => PayloadTooLargeErrorToJSONTyped,
|
|
713
726
|
PhoneAuthAvailabilityResponseDataFromJSON: () => PhoneAuthAvailabilityResponseDataFromJSON,
|
|
714
727
|
PhoneAuthAvailabilityResponseDataFromJSONTyped: () => PhoneAuthAvailabilityResponseDataFromJSONTyped,
|
|
715
728
|
PhoneAuthAvailabilityResponseDataToJSON: () => PhoneAuthAvailabilityResponseDataToJSON,
|
|
@@ -1644,6 +1657,7 @@ __export(index_exports, {
|
|
|
1644
1657
|
ZyphrAuthenticationError: () => ZyphrAuthenticationError,
|
|
1645
1658
|
ZyphrError: () => ZyphrError,
|
|
1646
1659
|
ZyphrNotFoundError: () => ZyphrNotFoundError,
|
|
1660
|
+
ZyphrPayloadTooLargeError: () => ZyphrPayloadTooLargeError,
|
|
1647
1661
|
ZyphrRateLimitError: () => ZyphrRateLimitError,
|
|
1648
1662
|
ZyphrValidationError: () => ZyphrValidationError,
|
|
1649
1663
|
ZyphrWebhookVerificationError: () => ZyphrWebhookVerificationError,
|
|
@@ -1808,6 +1822,9 @@ __export(index_exports, {
|
|
|
1808
1822
|
instanceOfPasswordRequirements: () => instanceOfPasswordRequirements,
|
|
1809
1823
|
instanceOfPasswordRequirementsResponse: () => instanceOfPasswordRequirementsResponse,
|
|
1810
1824
|
instanceOfPasswordRequirementsResponseData: () => instanceOfPasswordRequirementsResponseData,
|
|
1825
|
+
instanceOfPayloadTooLargeError: () => instanceOfPayloadTooLargeError,
|
|
1826
|
+
instanceOfPayloadTooLargeErrorError: () => instanceOfPayloadTooLargeErrorError,
|
|
1827
|
+
instanceOfPayloadTooLargeErrorErrorDetails: () => instanceOfPayloadTooLargeErrorErrorDetails,
|
|
1811
1828
|
instanceOfPhoneAuthAvailabilityResponse: () => instanceOfPhoneAuthAvailabilityResponse,
|
|
1812
1829
|
instanceOfPhoneAuthAvailabilityResponseData: () => instanceOfPhoneAuthAvailabilityResponseData,
|
|
1813
1830
|
instanceOfPhoneLoginVerifyRequest: () => instanceOfPhoneLoginVerifyRequest,
|
|
@@ -8030,6 +8047,101 @@ function PasswordRequirementsResponseToJSONTyped(value, ignoreDiscriminator = fa
|
|
|
8030
8047
|
};
|
|
8031
8048
|
}
|
|
8032
8049
|
|
|
8050
|
+
// src/src/models/PayloadTooLargeErrorErrorDetails.ts
|
|
8051
|
+
function instanceOfPayloadTooLargeErrorErrorDetails(value) {
|
|
8052
|
+
return true;
|
|
8053
|
+
}
|
|
8054
|
+
function PayloadTooLargeErrorErrorDetailsFromJSON(json) {
|
|
8055
|
+
return PayloadTooLargeErrorErrorDetailsFromJSONTyped(json, false);
|
|
8056
|
+
}
|
|
8057
|
+
function PayloadTooLargeErrorErrorDetailsFromJSONTyped(json, ignoreDiscriminator) {
|
|
8058
|
+
if (json == null) {
|
|
8059
|
+
return json;
|
|
8060
|
+
}
|
|
8061
|
+
return {
|
|
8062
|
+
"limitBytes": json["limit_bytes"] == null ? void 0 : json["limit_bytes"],
|
|
8063
|
+
"receivedBytes": json["received_bytes"] == null ? void 0 : json["received_bytes"]
|
|
8064
|
+
};
|
|
8065
|
+
}
|
|
8066
|
+
function PayloadTooLargeErrorErrorDetailsToJSON(json) {
|
|
8067
|
+
return PayloadTooLargeErrorErrorDetailsToJSONTyped(json, false);
|
|
8068
|
+
}
|
|
8069
|
+
function PayloadTooLargeErrorErrorDetailsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
8070
|
+
if (value == null) {
|
|
8071
|
+
return value;
|
|
8072
|
+
}
|
|
8073
|
+
return {
|
|
8074
|
+
"limit_bytes": value["limitBytes"],
|
|
8075
|
+
"received_bytes": value["receivedBytes"]
|
|
8076
|
+
};
|
|
8077
|
+
}
|
|
8078
|
+
|
|
8079
|
+
// src/src/models/PayloadTooLargeErrorError.ts
|
|
8080
|
+
var PayloadTooLargeErrorErrorCodeEnum = {
|
|
8081
|
+
PAYLOAD_TOO_LARGE: "payload_too_large"
|
|
8082
|
+
};
|
|
8083
|
+
function instanceOfPayloadTooLargeErrorError(value) {
|
|
8084
|
+
if (!("code" in value) || value["code"] === void 0) return false;
|
|
8085
|
+
if (!("message" in value) || value["message"] === void 0) return false;
|
|
8086
|
+
return true;
|
|
8087
|
+
}
|
|
8088
|
+
function PayloadTooLargeErrorErrorFromJSON(json) {
|
|
8089
|
+
return PayloadTooLargeErrorErrorFromJSONTyped(json, false);
|
|
8090
|
+
}
|
|
8091
|
+
function PayloadTooLargeErrorErrorFromJSONTyped(json, ignoreDiscriminator) {
|
|
8092
|
+
if (json == null) {
|
|
8093
|
+
return json;
|
|
8094
|
+
}
|
|
8095
|
+
return {
|
|
8096
|
+
"code": json["code"],
|
|
8097
|
+
"message": json["message"],
|
|
8098
|
+
"details": json["details"] == null ? void 0 : PayloadTooLargeErrorErrorDetailsFromJSON(json["details"])
|
|
8099
|
+
};
|
|
8100
|
+
}
|
|
8101
|
+
function PayloadTooLargeErrorErrorToJSON(json) {
|
|
8102
|
+
return PayloadTooLargeErrorErrorToJSONTyped(json, false);
|
|
8103
|
+
}
|
|
8104
|
+
function PayloadTooLargeErrorErrorToJSONTyped(value, ignoreDiscriminator = false) {
|
|
8105
|
+
if (value == null) {
|
|
8106
|
+
return value;
|
|
8107
|
+
}
|
|
8108
|
+
return {
|
|
8109
|
+
"code": value["code"],
|
|
8110
|
+
"message": value["message"],
|
|
8111
|
+
"details": PayloadTooLargeErrorErrorDetailsToJSON(value["details"])
|
|
8112
|
+
};
|
|
8113
|
+
}
|
|
8114
|
+
|
|
8115
|
+
// src/src/models/PayloadTooLargeError.ts
|
|
8116
|
+
function instanceOfPayloadTooLargeError(value) {
|
|
8117
|
+
if (!("error" in value) || value["error"] === void 0) return false;
|
|
8118
|
+
return true;
|
|
8119
|
+
}
|
|
8120
|
+
function PayloadTooLargeErrorFromJSON(json) {
|
|
8121
|
+
return PayloadTooLargeErrorFromJSONTyped(json, false);
|
|
8122
|
+
}
|
|
8123
|
+
function PayloadTooLargeErrorFromJSONTyped(json, ignoreDiscriminator) {
|
|
8124
|
+
if (json == null) {
|
|
8125
|
+
return json;
|
|
8126
|
+
}
|
|
8127
|
+
return {
|
|
8128
|
+
"error": PayloadTooLargeErrorErrorFromJSON(json["error"]),
|
|
8129
|
+
"meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
|
|
8130
|
+
};
|
|
8131
|
+
}
|
|
8132
|
+
function PayloadTooLargeErrorToJSON(json) {
|
|
8133
|
+
return PayloadTooLargeErrorToJSONTyped(json, false);
|
|
8134
|
+
}
|
|
8135
|
+
function PayloadTooLargeErrorToJSONTyped(value, ignoreDiscriminator = false) {
|
|
8136
|
+
if (value == null) {
|
|
8137
|
+
return value;
|
|
8138
|
+
}
|
|
8139
|
+
return {
|
|
8140
|
+
"error": PayloadTooLargeErrorErrorToJSON(value["error"]),
|
|
8141
|
+
"meta": RequestMetaToJSON(value["meta"])
|
|
8142
|
+
};
|
|
8143
|
+
}
|
|
8144
|
+
|
|
8033
8145
|
// src/src/models/PhoneAuthAvailabilityResponseData.ts
|
|
8034
8146
|
function instanceOfPhoneAuthAvailabilityResponseData(value) {
|
|
8035
8147
|
return true;
|
|
@@ -22148,6 +22260,22 @@ var ZyphrNotFoundError = class extends ZyphrError {
|
|
|
22148
22260
|
this.name = "ZyphrNotFoundError";
|
|
22149
22261
|
}
|
|
22150
22262
|
};
|
|
22263
|
+
var ZyphrPayloadTooLargeError = class extends ZyphrError {
|
|
22264
|
+
constructor(message, details, requestId) {
|
|
22265
|
+
super({ message, status: 413, code: "payload_too_large", details, requestId });
|
|
22266
|
+
this.name = "ZyphrPayloadTooLargeError";
|
|
22267
|
+
}
|
|
22268
|
+
/** Maximum allowed request body size in bytes (server-enforced). */
|
|
22269
|
+
get limitBytes() {
|
|
22270
|
+
const value = this.details?.limit_bytes;
|
|
22271
|
+
return typeof value === "number" ? value : void 0;
|
|
22272
|
+
}
|
|
22273
|
+
/** Size of the rejected request body in bytes, as measured by the server. */
|
|
22274
|
+
get receivedBytes() {
|
|
22275
|
+
const value = this.details?.received_bytes;
|
|
22276
|
+
return typeof value === "number" ? value : void 0;
|
|
22277
|
+
}
|
|
22278
|
+
};
|
|
22151
22279
|
var ZyphrWebhookVerificationError = class extends ZyphrError {
|
|
22152
22280
|
constructor(message) {
|
|
22153
22281
|
super({ message, status: 401, code: "webhook_verification_failed" });
|
|
@@ -22176,6 +22304,8 @@ async function parseErrorResponse(response) {
|
|
|
22176
22304
|
return new ZyphrAuthenticationError(message);
|
|
22177
22305
|
case 404:
|
|
22178
22306
|
return new ZyphrNotFoundError(message);
|
|
22307
|
+
case 413:
|
|
22308
|
+
return new ZyphrPayloadTooLargeError(message, details, requestId);
|
|
22179
22309
|
case 429: {
|
|
22180
22310
|
const retryAfterHeader = response.headers.get("Retry-After");
|
|
22181
22311
|
const retryAfter = retryAfterHeader ? parseInt(retryAfterHeader, 10) : void 0;
|
|
@@ -22975,6 +23105,19 @@ var SDK_VERSION = "0.1.0";
|
|
|
22975
23105
|
PasswordRequirementsResponseToJSONTyped,
|
|
22976
23106
|
PasswordRequirementsToJSON,
|
|
22977
23107
|
PasswordRequirementsToJSONTyped,
|
|
23108
|
+
PayloadTooLargeErrorErrorCodeEnum,
|
|
23109
|
+
PayloadTooLargeErrorErrorDetailsFromJSON,
|
|
23110
|
+
PayloadTooLargeErrorErrorDetailsFromJSONTyped,
|
|
23111
|
+
PayloadTooLargeErrorErrorDetailsToJSON,
|
|
23112
|
+
PayloadTooLargeErrorErrorDetailsToJSONTyped,
|
|
23113
|
+
PayloadTooLargeErrorErrorFromJSON,
|
|
23114
|
+
PayloadTooLargeErrorErrorFromJSONTyped,
|
|
23115
|
+
PayloadTooLargeErrorErrorToJSON,
|
|
23116
|
+
PayloadTooLargeErrorErrorToJSONTyped,
|
|
23117
|
+
PayloadTooLargeErrorFromJSON,
|
|
23118
|
+
PayloadTooLargeErrorFromJSONTyped,
|
|
23119
|
+
PayloadTooLargeErrorToJSON,
|
|
23120
|
+
PayloadTooLargeErrorToJSONTyped,
|
|
22978
23121
|
PhoneAuthAvailabilityResponseDataFromJSON,
|
|
22979
23122
|
PhoneAuthAvailabilityResponseDataFromJSONTyped,
|
|
22980
23123
|
PhoneAuthAvailabilityResponseDataToJSON,
|
|
@@ -23909,6 +24052,7 @@ var SDK_VERSION = "0.1.0";
|
|
|
23909
24052
|
ZyphrAuthenticationError,
|
|
23910
24053
|
ZyphrError,
|
|
23911
24054
|
ZyphrNotFoundError,
|
|
24055
|
+
ZyphrPayloadTooLargeError,
|
|
23912
24056
|
ZyphrRateLimitError,
|
|
23913
24057
|
ZyphrValidationError,
|
|
23914
24058
|
ZyphrWebhookVerificationError,
|
|
@@ -24073,6 +24217,9 @@ var SDK_VERSION = "0.1.0";
|
|
|
24073
24217
|
instanceOfPasswordRequirements,
|
|
24074
24218
|
instanceOfPasswordRequirementsResponse,
|
|
24075
24219
|
instanceOfPasswordRequirementsResponseData,
|
|
24220
|
+
instanceOfPayloadTooLargeError,
|
|
24221
|
+
instanceOfPayloadTooLargeErrorError,
|
|
24222
|
+
instanceOfPayloadTooLargeErrorErrorDetails,
|
|
24076
24223
|
instanceOfPhoneAuthAvailabilityResponse,
|
|
24077
24224
|
instanceOfPhoneAuthAvailabilityResponseData,
|
|
24078
24225
|
instanceOfPhoneLoginVerifyRequest,
|