@vepler/sdk 3.3.0 → 6.0.0

package/src/sdk/models/errors/querylandconstraintdesignations.ts

@@ -12,7 +12,7 @@ import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryLandConstraintDesignationsLandConstraintResponse503Type = {
   ApiError: "api_error",
@@ -21,40 +21,40 @@ export const QueryLandConstraintDesignationsLandConstraintResponse503Type = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryLandConstraintDesignationsLandConstraintResponse503Type =
   OpenEnum<typeof QueryLandConstraintDesignationsLandConstraintResponse503Type>;
 
 export type QueryLandConstraintDesignationsLandConstraintResponse503Error = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryLandConstraintDesignationsLandConstraintResponse503Type;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryLandConstraintDesignationsLandConstraintResponse503ResponseBodyData =
   {
@@ -62,7 +62,7 @@ export type QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody
   };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody
   extends SDKBaseError
@@ -90,7 +90,7 @@ export class QueryLandConstraintDesignationsLandConstraintResponse503ResponseBod
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryLandConstraintDesignationsLandConstraintResponseType = {
   ApiError: "api_error",
@@ -99,40 +99,40 @@ export const QueryLandConstraintDesignationsLandConstraintResponseType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryLandConstraintDesignationsLandConstraintResponseType =
   OpenEnum<typeof QueryLandConstraintDesignationsLandConstraintResponseType>;
 
 export type QueryLandConstraintDesignationsLandConstraintResponseError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryLandConstraintDesignationsLandConstraintResponseType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryLandConstraintDesignationsLandConstraintResponseResponseBodyData =
   {
@@ -140,7 +140,7 @@ export type QueryLandConstraintDesignationsLandConstraintResponseResponseBodyDat
   };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryLandConstraintDesignationsLandConstraintResponseResponseBody
   extends SDKBaseError
@@ -166,7 +166,7 @@ export class QueryLandConstraintDesignationsLandConstraintResponseResponseBody
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryLandConstraintDesignationsLandConstraintType = {
   ApiError: "api_error",
@@ -175,7 +175,7 @@ export const QueryLandConstraintDesignationsLandConstraintType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryLandConstraintDesignationsLandConstraintType = OpenEnum<
   typeof QueryLandConstraintDesignationsLandConstraintType
@@ -183,40 +183,40 @@ export type QueryLandConstraintDesignationsLandConstraintType = OpenEnum<
 
 export type QueryLandConstraintDesignationsLandConstraintError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryLandConstraintDesignationsLandConstraintType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryLandConstraintDesignationsLandConstraintResponseBodyData = {
   error: QueryLandConstraintDesignationsLandConstraintError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryLandConstraintDesignationsLandConstraintResponseBody
   extends SDKBaseError
@@ -241,7 +241,7 @@ export class QueryLandConstraintDesignationsLandConstraintResponseBody
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryLandConstraintDesignationsType = {
   ApiError: "api_error",
@@ -250,7 +250,7 @@ export const QueryLandConstraintDesignationsType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryLandConstraintDesignationsType = OpenEnum<
   typeof QueryLandConstraintDesignationsType
@@ -258,40 +258,40 @@ export type QueryLandConstraintDesignationsType = OpenEnum<
 
 export type QueryLandConstraintDesignationsError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryLandConstraintDesignationsType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryLandConstraintDesignationsResponseBodyData = {
   error: QueryLandConstraintDesignationsError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryLandConstraintDesignationsResponseBody extends SDKBaseError {
   error: QueryLandConstraintDesignationsError;

package/src/sdk/models/errors/querylistings.ts

@@ -12,7 +12,7 @@ import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsListingsType = {
   ApiError: "api_error",
@@ -21,7 +21,7 @@ export const QueryListingsListingsType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsListingsType = OpenEnum<
   typeof QueryListingsListingsType
@@ -29,40 +29,40 @@ export type QueryListingsListingsType = OpenEnum<
 
 export type QueryListingsListingsError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsListingsType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsListingsResponseBodyData = {
   error: QueryListingsListingsError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsListingsResponseBody extends SDKBaseError {
   error: QueryListingsListingsError;
@@ -85,7 +85,7 @@ export class QueryListingsListingsResponseBody extends SDKBaseError {
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsType = {
   ApiError: "api_error",
@@ -94,46 +94,46 @@ export const QueryListingsType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsType = OpenEnum<typeof QueryListingsType>;
 
 export type QueryListingsError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsResponseBodyData = {
   error: QueryListingsError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsResponseBody extends SDKBaseError {
   error: QueryListingsError;

package/src/sdk/models/errors/querylistingsadvanced.ts

@@ -12,7 +12,7 @@ import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsAdvancedListingsType = {
   ApiError: "api_error",
@@ -21,7 +21,7 @@ export const QueryListingsAdvancedListingsType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsAdvancedListingsType = OpenEnum<
   typeof QueryListingsAdvancedListingsType
@@ -29,40 +29,40 @@ export type QueryListingsAdvancedListingsType = OpenEnum<
 
 export type QueryListingsAdvancedListingsError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsAdvancedListingsType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsAdvancedListingsResponseBodyData = {
   error: QueryListingsAdvancedListingsError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsAdvancedListingsResponseBody extends SDKBaseError {
   error: QueryListingsAdvancedListingsError;
@@ -85,7 +85,7 @@ export class QueryListingsAdvancedListingsResponseBody extends SDKBaseError {
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsAdvancedType = {
   ApiError: "api_error",
@@ -94,7 +94,7 @@ export const QueryListingsAdvancedType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsAdvancedType = OpenEnum<
   typeof QueryListingsAdvancedType
@@ -102,40 +102,40 @@ export type QueryListingsAdvancedType = OpenEnum<
 
 export type QueryListingsAdvancedError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsAdvancedType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsAdvancedResponseBodyData = {
   error: QueryListingsAdvancedError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsAdvancedResponseBody extends SDKBaseError {
   error: QueryListingsAdvancedError;

package/src/sdk/models/errors/querylistingsbysource.ts

@@ -12,7 +12,7 @@ import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsBySourceListingsType = {
   ApiError: "api_error",
@@ -21,7 +21,7 @@ export const QueryListingsBySourceListingsType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsBySourceListingsType = OpenEnum<
   typeof QueryListingsBySourceListingsType
@@ -29,40 +29,40 @@ export type QueryListingsBySourceListingsType = OpenEnum<
 
 export type QueryListingsBySourceListingsError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsBySourceListingsType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsBySourceListingsResponseBodyData = {
   error: QueryListingsBySourceListingsError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsBySourceListingsResponseBody extends SDKBaseError {
   error: QueryListingsBySourceListingsError;
@@ -85,7 +85,7 @@ export class QueryListingsBySourceListingsResponseBody extends SDKBaseError {
 }
 
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export const QueryListingsBySourceType = {
   ApiError: "api_error",
@@ -94,7 +94,7 @@ export const QueryListingsBySourceType = {
   RateLimitError: "rate_limit_error",
 } as const;
 /**
- * Error type category
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
 export type QueryListingsBySourceType = OpenEnum<
   typeof QueryListingsBySourceType
@@ -102,40 +102,40 @@ export type QueryListingsBySourceType = OpenEnum<
 
 export type QueryListingsBySourceError = {
   /**
-   * Machine-readable error code
+   * Stable code identifying the specific failure, safe to branch on.
    */
   code?: string | undefined;
   /**
-   * URL to relevant documentation
+   * Link to the documentation for this error.
    */
   docUrl?: string | undefined;
   /**
-   * Human-readable error message
+   * Human-readable explanation of what went wrong.
    */
   message: string;
   /**
-   * Parameter that caused the error
+   * Name of the request parameter at fault, where the failure can be traced to one.
    */
   param?: string | undefined;
   /**
-   * Suggested corrections (e.g. postcode typo suggestions)
+   * Alternative values worth retrying when the supplied one could not be matched.
    */
   suggestions?: Array<string> | undefined;
   /**
-   * Error type category
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
    */
   type: QueryListingsBySourceType;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export type QueryListingsBySourceResponseBodyData = {
   error: QueryListingsBySourceError;
 };
 
 /**
- * Error response
+ * Returned in place of the normal payload whenever a request fails.
  */
 export class QueryListingsBySourceResponseBody extends SDKBaseError {
   error: QueryListingsBySourceError;