@truvity/sdk 0.28.1 → 0.28.3

package/README.md

@@ -1,92 +1,26 @@
-# sdk-typescript-internal
+# Truvity TypeScript SDK
 
-<!-- TOC tocDepth:1..6  -->
+## Overview
 
--   [sdk-typescript-internal](#sdk-typescript-internal)
-    -   [Release Management](#release-management)
-        -   [Work in Progress](#work-in-progress)
-        -   [Stable Releases](#stable-releases)
-    -   [Updating the `package.json` packages](#updating-the-packagejson-packages)
-    -   [User Defined Types usage](#user-defined-types-usage)
+The Truvity TypeScript SDK is designed to work with SSI through the Truvity API with minimal complexity.
 
-<!-- /TOC -->
+## Getting started
 
-## Release Management
+### Prerequisites
 
-Any manual changes to the sdk-typescript-internal are to be made trough `patches`. The release tag for the sdk-typescript-internal will be:
+- Node.js version 16.16 or later. Download it from the official [Node.js website](https://nodejs.org/).
+- Valid Truvity API credentials
 
-`v<major openapi>.<minor openapi>.<patch sdk>`
+### Installation
 
-Here’s an example in chronological order of how it will work:
-
-1. New OAPI spec release:
-    - truvity/api — 1.0.0
-    - truvity/sdk-typescript-internal — 1.0.0
-2. We created a patch for SDK (eg. fixed security vulnerability in one of the dependency):
-    - truvity/api — 1.0.0
-    - truvity/sdk-typescript-internal — 1.0.1
-3. We created a patch for OAPI spec (eg. fixed typo in the description):
-    - truvity/api — 1.0.1
-    - truvity/sdk-typescript-internal — 1.0.2
-4. We added a new feature to the OAPI spec (eg. new set of API calls):
-    - truvity/api — 1.1.0
-    - truvity/sdk-typescript-internal — 1.1.0
-5. We added a new feature to the SDK (eg. a set of helpers to work with JSON-LD)
-    - truvity/api — 1.1.0
-    - truvity/sdk-typescript-internal — 1.1.1
-6. We made a breaking change in the OAPI spec (eg. removed a set of API calls):
-    - truvity/api — 2.0.0
-    - truvity/sdk-typescript-internal — 2.0.0
-7. We made a breaking change in the SDK:
-    - truvity/api — 2.0.0
-    - truvity/sdk-typescript-internal — 2.0.1 — we should avoid this, but if it happens it’s still will be a patch.
-
-### Work in Progress
-
-To use changes in other repositories, you can use the autogenerated message available in your PR ([example](https://github.com/truvity/sdk-typescript-internal/pull/62#issuecomment-2206722741)) or in the `cd/publish` job ([example](https://github.com/truvity/sdk-typescript-internal/actions/runs/9790645034/job/27032815426#step:7:5683))
-
-### Stable Releases
-
-After you merge your PR branch onto master, you will need to generate a new release tag. To do so, you'll need to follow the next steps:
-
-1. go to `master` branch and make sure you have the latest local version:
-
-```bash
-git checkout master
-git pull
-```
-
-2. check `openapi` version in `sdk.yaml` either via command
+Use the `npm` command to install the Truvity SDK:
 
 ```bash
-cat sdk.yaml | yq -r .info.version
+npm install @truvity/sdk
 ```
 
-or by checking directly the version mentioned in the `sdk.yaml`
-
-```yaml
----
-openapi: 3.0.3
-info:
-    title: truvity
-    description: Truvity Platform API.
-    version: 0.27.16-devel+7ecda6c08f04
-    ...
-```
-
-3. Use the major and minor version from there in your new tag, along with the calculated patch version from git. For example:
-
-```bash
-git tag v0.27.19
-git push --tags
-```
-
-**_NOTE_:** When issuing a pre-release, you need to format the tag as per [these instructions](https://github.com/truvity/engineering/blob/master/teams/devops/rollout-process/README.md#for-sdk). In this case, the tag should be: `v<major openapi>.<minor openapi>.<patch sdk>-rc.x`
-
-## Updating the `package.json` packages
-
-Whenever you update the list of packages used in the `package.json`, you need to update also the [api-bundle.ts](https://github.com/truvity/api/blob/771bc724750214ec311c4057ae69c07f5b546561/api-bundle.ts#L32) TypeScript configuration from `api` repo, in order to avoid Fern overriding the these changes during the next SDK generation.
+Package link on [npm](https://www.npmjs.com/package/@truvity/sdk).
 
-## User Defined Types usage
+## Documentation
 
-For information on User Defined Types ( UDT ) usage, please see this [documentation](src/documents/README.md).
+Read full Truvity SDK and API documentation at [https://docs.truvity.cloud/sdk](https://docs.truvity.cloud/sdk).

package/api/resources/apiKeys/client/Client.d.ts

@@ -45,7 +45,7 @@ export declare class ApiKeys {
      */
     apiKeyCreate(request: Truvity.ApiKeyCreateRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ResourceApiKeyFull>;
     /**
-     * Search for apikeys with extended filters capabilities.
+     * Search for API Keys with extended filters capabilities.
      *
      * @param {Truvity.ApiKeySearchRequest} request
      * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
@@ -62,7 +62,7 @@ export declare class ApiKeys {
      */
     apiKeySearch(request?: Truvity.ApiKeySearchRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ListApiKey>;
     /**
-     * Get the latest version of ApiKey.
+     * Get the latest version of API Key.
      *
      * @param {string} id - The ID of the resource.
      * @param {Truvity.ApiKeyLatestRequest} request
@@ -80,7 +80,7 @@ export declare class ApiKeys {
      */
     apiKeyLatest(id: string, request?: Truvity.ApiKeyLatestRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ResourceApiKey>;
     /**
-     * Delete ApiKey's resource.
+     * Delete API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -103,7 +103,7 @@ export declare class ApiKeys {
      */
     apiKeyDelete(id: string, request: Truvity.ApiKeyDeleteRequest, requestOptions?: ApiKeys.RequestOptions): Promise<void>;
     /**
-     * Update ApiKey's resource.
+     * Update API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -128,7 +128,7 @@ export declare class ApiKeys {
      */
     apiKeyUpdate(id: string, request: Truvity.ApiKeyUpdateRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ResourceApiKey>;
     /**
-     * Restore ApiKey's resource.
+     * Restore API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -150,7 +150,7 @@ export declare class ApiKeys {
      */
     apiKeyRestore(id: string, request: Truvity.ApiKeyRestoreRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ResourceApiKey>;
     /**
-     * History of the ApiKey's resources.
+     * History of the API Key's resources.
      *
      * @param {string} id - The ID of the resource.
      * @param {Truvity.ApiKeyHistoryRequest} request
@@ -168,7 +168,7 @@ export declare class ApiKeys {
      */
     apiKeyHistory(id: string, request?: Truvity.ApiKeyHistoryRequest, requestOptions?: ApiKeys.RequestOptions): Promise<Truvity.ListApiKey>;
     /**
-     * Read the specific version of the ApiKey's resource.
+     * Read the specific version of the API Key's resource.
      *
      * @param {string} id - The ID of the resource.
      * @param {number} revision - The revision of the resource.

package/api/resources/apiKeys/client/Client.js

@@ -77,7 +77,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, 'api-keys'),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 body: serializers.ApiKeyInput.jsonOrThrow(_body, { unrecognizedObjectKeys: 'strip', omitUndefined: true }),
@@ -160,7 +160,7 @@ class ApiKeys {
         });
     }
     /**
-     * Search for apikeys with extended filters capabilities.
+     * Search for API Keys with extended filters capabilities.
      *
      * @param {Truvity.ApiKeySearchRequest} request
      * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
@@ -181,7 +181,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, 'api-keys/search'),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 body: serializers.ApiKeySearchRequest.jsonOrThrow(request, {
@@ -267,7 +267,7 @@ class ApiKeys {
         });
     }
     /**
-     * Get the latest version of ApiKey.
+     * Get the latest version of API Key.
      *
      * @param {string} id - The ID of the resource.
      * @param {Truvity.ApiKeyLatestRequest} request
@@ -290,7 +290,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -372,7 +372,7 @@ class ApiKeys {
         });
     }
     /**
-     * Delete ApiKey's resource.
+     * Delete API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -400,7 +400,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}`),
                 method: 'DELETE',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -491,7 +491,7 @@ class ApiKeys {
         });
     }
     /**
-     * Update ApiKey's resource.
+     * Update API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -521,7 +521,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}`),
                 method: 'PATCH',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 body: serializers.ApiKeyInput.jsonOrThrow(_body, { unrecognizedObjectKeys: 'strip', omitUndefined: true }),
@@ -625,7 +625,7 @@ class ApiKeys {
         });
     }
     /**
-     * Restore ApiKey's resource.
+     * Restore API Key's resource.
      *
      * @param {string} id - The primary and unique identifier of the resource (inside tenant)
      *                      according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
@@ -652,7 +652,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}/restore`),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'Idempotency-Key': idempotencyKey != null ? idempotencyKey : undefined, 'If-Match': ifMatch }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -741,7 +741,7 @@ class ApiKeys {
         });
     }
     /**
-     * History of the ApiKey's resources.
+     * History of the API Key's resources.
      *
      * @param {string} id - The ID of the resource.
      * @param {Truvity.ApiKeyHistoryRequest} request
@@ -764,7 +764,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}/revisions`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -846,7 +846,7 @@ class ApiKeys {
         });
     }
     /**
-     * Read the specific version of the ApiKey's resource.
+     * Read the specific version of the API Key's resource.
      *
      * @param {string} id - The ID of the resource.
      * @param {number} revision - The revision of the resource.
@@ -870,7 +870,7 @@ class ApiKeys {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TruvityEnvironment.Default, `api-keys/${encodeURIComponent(id)}/revisions/${encodeURIComponent(revision)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': '0.0.0', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': '@truvity/sdk', 'X-Fern-SDK-Version': 'v0.28.3', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version, 'If-None-Match': ifNoneMatch != null ? ifNoneMatch : undefined }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 requestType: 'json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,