@truvity/sdk 0.0.2 → 0.0.7

package/Client.d.ts

@@ -3,11 +3,11 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { Owners } from "./api/resources/owners/client/Client";
-import { Pets } from "./api/resources/pets/client/Client";
+import { Credentials } from "./api/resources/credentials/client/Client";
 export declare namespace TruvityClient {
     interface Options {
         environment?: core.Supplier<environments.TruvityEnvironment | string>;
+        apiKey: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -17,9 +17,7 @@ export declare namespace TruvityClient {
 }
 export declare class TruvityClient {
     protected readonly _options: TruvityClient.Options;
-    constructor(_options?: TruvityClient.Options);
-    protected _owners: Owners | undefined;
-    get owners(): Owners;
-    protected _pets: Pets | undefined;
-    get pets(): Pets;
+    constructor(_options: TruvityClient.Options);
+    protected _credentials: Credentials | undefined;
+    get credentials(): Credentials;
 }

package/Client.js

@@ -4,19 +4,14 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TruvityClient = void 0;
-const Client_1 = require("./api/resources/owners/client/Client");
-const Client_2 = require("./api/resources/pets/client/Client");
+const Client_1 = require("./api/resources/credentials/client/Client");
 class TruvityClient {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
-    get owners() {
+    get credentials() {
         var _a;
-        return ((_a = this._owners) !== null && _a !== void 0 ? _a : (this._owners = new Client_1.Owners(this._options)));
-    }
-    get pets() {
-        var _a;
-        return ((_a = this._pets) !== null && _a !== void 0 ? _a : (this._pets = new Client_2.Pets(this._options)));
+        return ((_a = this._credentials) !== null && _a !== void 0 ? _a : (this._credentials = new Client_1.Credentials(this._options)));
     }
 }
 exports.TruvityClient = TruvityClient;

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

@@ -0,0 +1,151 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/// <reference types="node" />
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Truvity from "../../..";
+import * as stream from "stream";
+export declare namespace Credentials {
+    interface Options {
+        environment?: core.Supplier<environments.TruvityEnvironment | string>;
+        apiKey: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+/**
+ * The API to manage Truvity API's walelts.
+ */
+export declare class Credentials {
+    protected readonly _options: Credentials.Options;
+    constructor(_options: Credentials.Options);
+    /**
+     * Create credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialCreate({
+     *         blobId: "blob_id",
+     *         body: {}
+     *     })
+     */
+    credentialCreate(request: Truvity.CredentialCreateRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialResource>;
+    /**
+     * Take a look at [GET with body payload](https://opensource.zalando.com/restful-api-guidelines/#get-with-body)
+     *
+     * - no resources created: Returns all credentials matching the query passed as request input payload.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialSearch()
+     */
+    credentialSearch(request?: Truvity.CredentialSearch, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialList>;
+    /**
+     * Upload of credential's blob.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialUpload()
+     */
+    credentialUpload(request?: Truvity.CredentialUploadRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.UploadResponse>;
+    /**
+     * Read the latest revision of the credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialLatest("id")
+     */
+    credentialLatest(id: Truvity.ResourceId, request?: Truvity.CredentialLatestRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialResource>;
+    /**
+     * Update credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialUpdate("id", {
+     *         ifMatch: "If-Match",
+     *         body: {}
+     *     })
+     */
+    credentialUpdate(id: Truvity.ResourceId, request: Truvity.CredentialUpdateRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialResource>;
+    /**
+     * Delete credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialDelete("id", {
+     *         ifMatch: "If-Match"
+     *     })
+     */
+    credentialDelete(id: Truvity.ResourceId, request: Truvity.CredentialDeleteRequest, requestOptions?: Credentials.RequestOptions): Promise<void>;
+    /**
+     * Restore credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialRestore("id", {
+     *         ifMatch: "If-Match"
+     *     })
+     */
+    credentialRestore(id: Truvity.ResourceId, request: Truvity.CredentialRestoreRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialResource>;
+    /**
+     * History of the credentials' resources.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialHistory("id")
+     */
+    credentialHistory(id: Truvity.ResourceId, request?: Truvity.CredentialHistoryRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialList>;
+    /**
+     * Read the specific version of the credential's resource.
+     * @throws {@link Truvity.BadRequestError}
+     * @throws {@link Truvity.UnauthorizedError}
+     * @throws {@link Truvity.ForbiddenError}
+     * @throws {@link Truvity.NotFoundError}
+     * @throws {@link Truvity.InternalServerError}
+     *
+     * @example
+     *     await truvity.credentials.credentialRevision("id", 1)
+     */
+    credentialRevision(id: Truvity.ResourceId, revision: Truvity.Revision, request?: Truvity.CredentialRevisionRequest, requestOptions?: Credentials.RequestOptions): Promise<Truvity.CredentialResource>;
+    /**
+     * Download of credential's blob.
+     */
+    credentialDownload(id: Truvity.ResourceId, revision: Truvity.Revision, request?: Truvity.CredentialDownloadRequest, requestOptions?: Credentials.RequestOptions): Promise<stream.Readable>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-KEY": string;
+    }>;
+}