@greensecurity/javascript-sdk 0.35.1 → 0.35.3

package/FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
 import { vendorsCreateVendorRegistration } from "@greensecurity/javascript-sdk/funcs/vendorsCreateVendorRegistration.js";
-import { SDKValidationError } from "@greensecurity/javascript-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `GreenSecurityCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -36,28 +35,12 @@ async function run() {
     vendorGroupId: 123,
     managingCompanyId: 123,
   });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("vendorsCreateVendorRegistration failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/README.md

@@ -208,7 +208,6 @@ async function run() {
     managingCompanyId: 123,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -249,7 +248,6 @@ async function run() {
     managingCompanyId: 123,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -306,6 +304,8 @@ run();
 * [deleteVendorCredentialFile](docs/sdks/vendors/README.md#deletevendorcredentialfile) - Delete vendor credential file
 * [getVendorLegalName](docs/sdks/vendors/README.md#getvendorlegalname) - Get Vendor legal name
 * [declineVendorCredential](docs/sdks/vendors/README.md#declinevendorcredential) - Decline vendor credential
+* [checkDownloadCode](docs/sdks/vendors/README.md#checkdownloadcode) - Check download code for vendor credential
+* [sendDownloadCode](docs/sdks/vendors/README.md#senddownloadcode) - Send download code for vendor credential
 * [listVendorCredentialFiles](docs/sdks/vendors/README.md#listvendorcredentialfiles) - List Vendor Credential files
 * [addVendorCredentialFile](docs/sdks/vendors/README.md#addvendorcredentialfile) - Add vendor credential file
 * [submitVendorCredential](docs/sdks/vendors/README.md#submitvendorcredential) - Submit vendor credential
@@ -383,6 +383,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`vendorsAddVendorCredentialFile`](docs/sdks/vendors/README.md#addvendorcredentialfile) - Add vendor credential file
 - [`vendorsAddVendorManagedByCompany`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
 - [`vendorScansVendorScanOut`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
+- [`vendorsCheckDownloadCode`](docs/sdks/vendors/README.md#checkdownloadcode) - Check download code for vendor credential
 - [`vendorsCreateNewVendorCredentialVersion`](docs/sdks/vendors/README.md#createnewvendorcredentialversion) - Create new vendor credential version
 - [`vendorsCreateOrUpdateBcr`](docs/sdks/vendors/README.md#createorupdatebcr) - Create or update BackgroundCheckResults
 - [`vendorsCreateVendorCompany`](docs/sdks/vendors/README.md#createvendorcompany) - Create vendor company
@@ -410,6 +411,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`vendorsListVendorScrubPackages`](docs/sdks/vendors/README.md#listvendorscrubpackages) - List vendor scrub packages
 - [`vendorsListVendorScrubPurchases`](docs/sdks/vendors/README.md#listvendorscrubpurchases) - List vendor scrub purchases
 - [`vendorsPurchaseScrubCredits`](docs/sdks/vendors/README.md#purchasescrubcredits) - Purchase scrub credits
+- [`vendorsSendDownloadCode`](docs/sdks/vendors/README.md#senddownloadcode) - Send download code for vendor credential
 - [`vendorsSubmitVendorCredential`](docs/sdks/vendors/README.md#submitvendorcredential) - Submit vendor credential
 - [`vendorsUpdateVendorCredentialFile`](docs/sdks/vendors/README.md#updatevendorcredentialfile) - Update vendor credential file
 - [`vendorsUpdateVendorDetails`](docs/sdks/vendors/README.md#updatevendordetails) - Update vendor details
@@ -464,6 +466,7 @@ To learn about this feature and how to get started, check
 - [`useVendorsAddVendorCredentialFileMutation`](docs/sdks/vendors/README.md#addvendorcredentialfile) - Add vendor credential file
 - [`useVendorsAddVendorManagedByCompanyMutation`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
 - [`useVendorScansVendorScanOutMutation`](docs/sdks/vendorscans/README.md#vendorscanout) - Vendor scan out
+- [`useVendorsCheckDownloadCode`](docs/sdks/vendors/README.md#checkdownloadcode) - Check download code for vendor credential
 - [`useVendorsCreateNewVendorCredentialVersionMutation`](docs/sdks/vendors/README.md#createnewvendorcredentialversion) - Create new vendor credential version
 - [`useVendorsCreateOrUpdateBcrMutation`](docs/sdks/vendors/README.md#createorupdatebcr) - Create or update BackgroundCheckResults
 - [`useVendorsCreateVendorCompanyMutation`](docs/sdks/vendors/README.md#createvendorcompany) - Create vendor company
@@ -491,6 +494,7 @@ To learn about this feature and how to get started, check
 - [`useVendorsListVendorScrubPackages`](docs/sdks/vendors/README.md#listvendorscrubpackages) - List vendor scrub packages
 - [`useVendorsListVendorScrubPurchases`](docs/sdks/vendors/README.md#listvendorscrubpurchases) - List vendor scrub purchases
 - [`useVendorsPurchaseScrubCreditsMutation`](docs/sdks/vendors/README.md#purchasescrubcredits) - Purchase scrub credits
+- [`useVendorsSendDownloadCodeMutation`](docs/sdks/vendors/README.md#senddownloadcode) - Send download code for vendor credential
 - [`useVendorsSubmitVendorCredentialMutation`](docs/sdks/vendors/README.md#submitvendorcredential) - Submit vendor credential
 - [`useVendorsUpdateVendorCredentialFileMutation`](docs/sdks/vendors/README.md#updatevendorcredentialfile) - Update vendor credential file
 - [`useVendorsUpdateVendorDetailsMutation`](docs/sdks/vendors/README.md#updatevendordetails) - Update vendor details
@@ -535,7 +539,6 @@ async function run() {
   });
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -577,7 +580,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -612,7 +614,6 @@ async function run() {
     managingCompanyId: 123,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -624,29 +625,28 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `createVendorRegistration` method may throw the following errors:
+This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
 
-| Error Type              | Status Code        | Content Type     |
-| ----------------------- | ------------------ | ---------------- |
-| errors.ApiErrorResponse | 400, 401, 403, 409 | application/json |
-| errors.ApiErrorResponse | 500                | application/json |
-| errors.APIError         | 4XX, 5XX           | \*/\*            |
-
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.name`        | `string`   | Error class name eg `APIError`                                                          |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP status code eg `404`                                                               |
+| `error.contentType` | `string`   | HTTP content type eg `application/json`                                                 |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response. Access to headers and more.                                          |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { GreenSecurity } from "@greensecurity/javascript-sdk";
-import {
-  ApiErrorResponse,
-  SDKValidationError,
-} from "@greensecurity/javascript-sdk/models/errors";
+import * as errors from "@greensecurity/javascript-sdk/models/errors";
 
 const greenSecurity = new GreenSecurity();
 
 async function run() {
-  let result;
   try {
-    result = await greenSecurity.vendors.createVendorRegistration({
+    const result = await greenSecurity.vendors.createVendorRegistration({
       email: "user@example.com",
       password: "Abcdef123!",
       timezone: "America/Chicago",
@@ -655,32 +655,22 @@ async function run() {
       managingCompanyId: 123,
     });
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof ApiErrorResponse): {
-        // Handle err.data$: ApiErrorResponseData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ApiErrorResponse): {
-        // Handle err.data$: ApiErrorResponseData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
-      }
+  } catch (error) {
+    // Depending on the method different errors may be thrown
+    if (error instanceof errors.ApiErrorResponse) {
+      console.log(error.message);
+      console.log(error.data$.error); // string
+      console.log(error.data$.success); // boolean
+      console.log(error.data$.code); // number
+    }
+
+    // Fallback error class, if no other more specific error class is matched
+    if (error instanceof errors.APIError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.rawResponse.headers);
     }
   }
 }
@@ -689,17 +679,16 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
-
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
-
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+### Error Classes
+* [`ApiErrorResponse`](docs/models/errors/apierrorresponse.md): Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).  Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
+* `APIError`: The fallback error class, if no other more specific error class is matched.
+* `SDKValidationError`: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+* Network errors:
+    * `ConnectionError`: HTTP client was unable to make a request to a server.
+    * `RequestTimeoutError`: HTTP request timed out due to an AbortSignal signal.
+    * `RequestAbortedError`: HTTP request was aborted by the client.
+    * `InvalidRequestError`: Any input used to create a request is invalid.
+    * `UnexpectedClientError`: Unrecognised or unexpected error.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -734,7 +723,6 @@ async function run() {
     managingCompanyId: 123,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -762,7 +750,6 @@ async function run() {
     managingCompanyId: 123,
   });
 
-  // Handle the result
   console.log(result);
 }