npm - @unified-api/typescript-sdk - Versions diffs - 2.9.8 → 2.9.10 - Mend

@unified-api/typescript-sdk 2.9.8 → 2.9.10

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.

Files changed (226) hide show

package/README.md CHANGED Viewed

@@ -228,19 +228,7 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
-All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
-If a HTTP request fails, an operation my also throw an error from the `sdk/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                     |
-In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `createAccountingAccount` method may throw the following errors:
+If the request fails due to, for example 4XX or 5XX status codes, it will throw a `SDKError`.
 | Error Type      | Status Code | Content Type |
 | --------------- | ----------- | ------------ |
@@ -267,14 +255,24 @@ async function run() {
     console.log(result);
   } catch (err) {
     switch (true) {
-      case (err instanceof SDKValidationError): {
-        // Validation errors can be pretty-printed
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
+      // 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;
+        }
+        sdkerror.js;
+      // Server returned an error status code or an unknown content type
+      case (err instanceof SDKError): {
+        console.error(err.statusCode);
+        console.error(err.rawResponse.body);
         return;
       }
       default: {
+        // Other errors such as network errors, see HTTPClientErrors for more details
         throw err;
       }
     }
@@ -285,7 +283,17 @@ 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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+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 `sdk/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                     |
 <!-- End Error Handling [errors] -->
 <!-- Start Requirements [requirements] -->
@@ -580,32 +588,26 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`commerceCreateCommerceInventory`](docs/sdks/commerce/README.md#createcommerceinventory) - Create an inventory
 - [`commerceCreateCommerceItem`](docs/sdks/commerce/README.md#createcommerceitem) - Create an item
 - [`commerceCreateCommerceLocation`](docs/sdks/commerce/README.md#createcommercelocation) - Create a location
-- [`commerceCreateCommerceMetadata`](docs/sdks/commerce/README.md#createcommercemetadata) - Create a metadata
 - [`commerceGetCommerceCollection`](docs/sdks/commerce/README.md#getcommercecollection) - Retrieve a collection
 - [`commerceGetCommerceInventory`](docs/sdks/commerce/README.md#getcommerceinventory) - Retrieve an inventory
 - [`commerceGetCommerceItem`](docs/sdks/commerce/README.md#getcommerceitem) - Retrieve an item
 - [`commerceGetCommerceLocation`](docs/sdks/commerce/README.md#getcommercelocation) - Retrieve a location
-- [`commerceGetCommerceMetadata`](docs/sdks/commerce/README.md#getcommercemetadata) - Retrieve a metadata
 - [`commerceListCommerceCollections`](docs/sdks/commerce/README.md#listcommercecollections) - List all collections
 - [`commerceListCommerceInventories`](docs/sdks/commerce/README.md#listcommerceinventories) - List all inventories
 - [`commerceListCommerceItems`](docs/sdks/commerce/README.md#listcommerceitems) - List all items
 - [`commerceListCommerceLocations`](docs/sdks/commerce/README.md#listcommercelocations) - List all locations
-- [`commerceListCommerceMetadatas`](docs/sdks/commerce/README.md#listcommercemetadatas) - List all metadatas
 - [`commercePatchCommerceCollection`](docs/sdks/commerce/README.md#patchcommercecollection) - Update a collection
 - [`commercePatchCommerceInventory`](docs/sdks/commerce/README.md#patchcommerceinventory) - Update an inventory
 - [`commercePatchCommerceItem`](docs/sdks/commerce/README.md#patchcommerceitem) - Update an item
 - [`commercePatchCommerceLocation`](docs/sdks/commerce/README.md#patchcommercelocation) - Update a location
-- [`commercePatchCommerceMetadata`](docs/sdks/commerce/README.md#patchcommercemetadata) - Update a metadata
 - [`commerceRemoveCommerceCollection`](docs/sdks/commerce/README.md#removecommercecollection) - Remove a collection
 - [`commerceRemoveCommerceInventory`](docs/sdks/commerce/README.md#removecommerceinventory) - Remove an inventory
 - [`commerceRemoveCommerceItem`](docs/sdks/commerce/README.md#removecommerceitem) - Remove an item
 - [`commerceRemoveCommerceLocation`](docs/sdks/commerce/README.md#removecommercelocation) - Remove a location
-- [`commerceRemoveCommerceMetadata`](docs/sdks/commerce/README.md#removecommercemetadata) - Remove a metadata
 - [`commerceUpdateCommerceCollection`](docs/sdks/commerce/README.md#updatecommercecollection) - Update a collection
 - [`commerceUpdateCommerceInventory`](docs/sdks/commerce/README.md#updatecommerceinventory) - Update an inventory
 - [`commerceUpdateCommerceItem`](docs/sdks/commerce/README.md#updatecommerceitem) - Update an item
 - [`commerceUpdateCommerceLocation`](docs/sdks/commerce/README.md#updatecommercelocation) - Update a location
-- [`commerceUpdateCommerceMetadata`](docs/sdks/commerce/README.md#updatecommercemetadata) - Update a metadata
 - [`commitCreateRepoCommit`](docs/sdks/commit/README.md#createrepocommit) - Create a commit
 - [`commitGetRepoCommit`](docs/sdks/commit/README.md#getrepocommit) - Retrieve a commit
 - [`commitListRepoCommits`](docs/sdks/commit/README.md#listrepocommits) - List all commits
@@ -918,12 +920,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`messagingPatchMessagingMessage`](docs/sdks/messaging/README.md#patchmessagingmessage) - Update a message
 - [`messagingRemoveMessagingMessage`](docs/sdks/messaging/README.md#removemessagingmessage) - Remove a message
 - [`messagingUpdateMessagingMessage`](docs/sdks/messaging/README.md#updatemessagingmessage) - Update a message
-- [`metadataCreateCommerceMetadata`](docs/sdks/metadata/README.md#createcommercemetadata) - Create a metadata
-- [`metadataGetCommerceMetadata`](docs/sdks/metadata/README.md#getcommercemetadata) - Retrieve a metadata
-- [`metadataListCommerceMetadatas`](docs/sdks/metadata/README.md#listcommercemetadatas) - List all metadatas
-- [`metadataPatchCommerceMetadata`](docs/sdks/metadata/README.md#patchcommercemetadata) - Update a metadata
-- [`metadataRemoveCommerceMetadata`](docs/sdks/metadata/README.md#removecommercemetadata) - Remove a metadata
-- [`metadataUpdateCommerceMetadata`](docs/sdks/metadata/README.md#updatecommercemetadata) - Update a metadata
+- [`metadataCreateMetadataMetadata`](docs/sdks/metadata/README.md#createmetadatametadata) - Create a metadata
+- [`metadataGetMetadataMetadata`](docs/sdks/metadata/README.md#getmetadatametadata) - Retrieve a metadata
+- [`metadataListMetadataMetadatas`](docs/sdks/metadata/README.md#listmetadatametadatas) - List all metadatas
+- [`metadataPatchMetadataMetadata`](docs/sdks/metadata/README.md#patchmetadatametadata) - Update a metadata
+- [`metadataRemoveMetadataMetadata`](docs/sdks/metadata/README.md#removemetadatametadata) - Remove a metadata
+- [`metadataUpdateMetadataMetadata`](docs/sdks/metadata/README.md#updatemetadatametadata) - Update a metadata
 - [`modelListGenaiModels`](docs/sdks/model/README.md#listgenaimodels) - List all models
 - [`noteCreateTicketingNote`](docs/sdks/note/README.md#createticketingnote) - Create a note
 - [`noteGetTicketingNote`](docs/sdks/note/README.md#getticketingnote) - Retrieve a note