@truvity/sdk 0.0.1

package/api/types/ProblemNotFoundBlob.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Impossible to find requested resource.
+ * Additional information:
+ * type: /not-found/blob
+ * status: 404
+ * title: Not Found
+ * .
+ */
+export interface ProblemNotFoundBlob {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    kind: Truvity.ResourceKind;
+    id: Truvity.BlobId;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemNotFoundBlob.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemNotFoundResource.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Impossible to find requested resource.
+ * Additional information:
+ * type: /not-found/resource
+ * status: 404
+ * title: Not Found
+ * .
+ */
+export interface ProblemNotFoundResource {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    kind: Truvity.ResourceKind;
+    id: Truvity.ResourceId;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemNotFoundResource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemNotFoundRevision.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Impossible to find requested revision of resource.
+ * Additional information:
+ * type: /not-found/resource/revision
+ * status: 404
+ * title: Not Found
+ * .
+ */
+export interface ProblemNotFoundRevision {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    requested: Truvity.RequestedRevision;
+    latest: Truvity.Resource;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemNotFoundRevision.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemNullUnicode.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Your request contains [Unicode Character 'NULL' (U+0000)](https://www.fileformat.info/info/unicode/char/0000/index.htm).
+ * Additional information:
+ * type: /bad-request/has-null-unicode-character
+ * status: 400
+ * title: Bad Request
+ * .
+ */
+export interface ProblemNullUnicode {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    location: Truvity.HttpRequestPart;
+    /** Position of [Unicode Character 'NULL' (U+0000)](https://www.fileformat.info/info/unicode/char/0000/index.htm) inside data. */
+    position: number;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemNullUnicode.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemResourceConflict.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Impossible to modify resource due to race condition.
+ * Additional information:
+ * type: resource/conflict
+ * status: 412
+ * title: Precondition Failed
+ * .
+ */
+export interface ProblemResourceConflict {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    type: Truvity.UriReference;
+    requested: Truvity.RequestedETag;
+    latest: Truvity.Resource;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemResourceConflict.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemResourceMethodNotAllowed.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Impossible to apply this HTTP method due to resource state.
+ * Additional information:
+ * type: /method-not-allowed/resource
+ * status: 405
+ * title: Method Not Allowed
+ * .
+ */
+export interface ProblemResourceMethodNotAllowed {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    type: Truvity.UriReference;
+    method: Truvity.HttpMethod;
+    path: Truvity.UriReference;
+    latest: Truvity.Resource;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemResourceMethodNotAllowed.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemUnauthorized.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Unauthorized.
+ * Additional information:
+ * type: /unauthorized
+ * status: 401
+ * title: Unauthorized
+ * .
+ */
+export interface ProblemUnauthorized {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    type: Truvity.UriReference;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemUnauthorized.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemUnsupportedMediaType.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Unsupported Media Type.
+ * Additional information:
+ * type: /unsupported-media-type
+ * status: 415
+ * title: Unsupported Media Type
+ * .
+ */
+export interface ProblemUnsupportedMediaType {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    type: Truvity.UriReference;
+    contentType: Truvity.ContentType;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemUnsupportedMediaType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProblemValidation.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * A defined validation problem according to [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457.html).
+ * Additional information:
+ * type: /bad-request/validation
+ * status: 400
+ * title: Bad Request
+ * .
+ */
+export interface ProblemValidation {
+    /** The HTTP system code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** A short, human-readable summary of the problem type. */
+    title: string;
+    request: Truvity.HttpRequestPart;
+    schema: Truvity.UriReference;
+    errors: Truvity.ValidationError[];
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    instance?: string;
+}

package/api/types/ProblemValidation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/RequestedETag.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Requested revision of resource.
+ */
+export interface RequestedETag {
+    kind: Truvity.ResourceKind;
+    id: Truvity.ResourceId;
+    ifMatch: Truvity.ETag;
+}

package/api/types/RequestedETag.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/RequestedRevision.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Requested revision of resource.
+ */
+export interface RequestedRevision {
+    kind: Truvity.ResourceKind;
+    id: Truvity.ResourceId;
+    revision: Truvity.Revision;
+}

package/api/types/RequestedRevision.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Resource.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Some additional comments on the fields
+ * kind:
+ * resource kind.
+ * createdAt:
+ * the time of the creation of the object (the first revision)
+ * updatedAt:
+ * the time of the creation of the _latest revision_ of the object
+ * deletedAt:
+ * the time of the deletion of the object - [soft deletion](https://en.wiktionary.org/wiki/soft_deletion)
+ * labels:
+ * used-defined key-value labels, similar to Kubernetes Labels.
+ * annotations:
+ * used-defined key-value annotations, similar to Kubernetes Annotations.
+ * etag:
+ * [Zalando RESTful Guidelines / Appendix C: Best practices / ETags in result entities](https://opensource.zalando.com/restful-api-guidelines/#ETag-in-result-entities)
+ * Other properties defined inside specific resource.
+ */
+export interface Resource {
+    kind: Truvity.ResourceKind;
+    id: Truvity.ResourceId;
+    revision: Truvity.Revision;
+    createdAt: Truvity.Timestamp;
+    modifiedAt: Truvity.Timestamp;
+    labels: Truvity.Labels;
+    annotations: Truvity.Annotations;
+    etag: Truvity.ETag;
+    deletedAt?: Truvity.Timestamp;
+}

package/api/types/Resource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ResourceId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The primary and unique identifier of the resource (inside tenant)
+ * according to [RFC 4122](https://www.rfc-editor.org/info/rfc4122).
+ */
+export declare type ResourceId = string;

package/api/types/ResourceId.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ResourceKind.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * The REST resource kind, associated with HTTP Path prefix and Content-Type of API.
+ */
+export interface ResourceKind {
+    name: Truvity.ResourceName;
+    version: Truvity.ResourceVersion;
+}

package/api/types/ResourceKind.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ResourceName.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The name of REST resource. Identify the HTTP path prefix for REST resource.
+ */
+export declare type ResourceName = string;

package/api/types/ResourceName.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ResourceVersion.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The version of REST resource. Identify the Content-Type of API.
+ * Take a look to Zalando RESTful guidelines rule [114 MUST use media type versioning](https://opensource.zalando.com/restful-api-guidelines/#114).
+ */
+export declare type ResourceVersion = number;

package/api/types/ResourceVersion.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Revision.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Similar to kubernetes `resourceVersion` and `generation` field to identify the object version.
+ */
+export declare type Revision = number;

package/api/types/Revision.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SortOrder.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Enum of all possible sort order values.
+ */
+export declare type SortOrder = "ASC" | "DESC";
+export declare const SortOrder: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

package/api/types/SortOrder.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = void 0;
+exports.SortOrder = {
+    Asc: "ASC",
+    Desc: "DESC",
+};

package/api/types/Species.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Zoological Taxonomy - like "dog", "cat", etc.
+ * Take a look [Species](https://en.wikipedia.org/wiki/Species).
+ */
+export declare type Species = "CAT" | "DOG" | "PARROT";
+export declare const Species: {
+    readonly Cat: "CAT";
+    readonly Dog: "DOG";
+    readonly Parrot: "PARROT";
+};

package/api/types/Species.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Species = void 0;
+exports.Species = {
+    Cat: "CAT",
+    Dog: "DOG",
+    Parrot: "PARROT",
+};

package/api/types/Timestamp.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Timestamp string according to [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).
+ */
+export declare type Timestamp = Date;

package/api/types/Timestamp.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UploadResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Schema for blob's upload response.
+ */
+export interface UploadResponse {
+    blobId: Truvity.BlobId;
+    deadline: Truvity.Timestamp;
+    uploadUri: Truvity.Uri;
+    checksum?: Truvity.Checksum;
+}

package/api/types/UploadResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Uri.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Just regular URI according to [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986).
+ * Examples:
+ * url: - https://example.com/ - https://example.com/some/path
+ * urn: - urn:uuid:dd1edaad-a160-44d8-931f-1afc27d31b18 - urn:uuid:dd1edaad-a160-44d8-931f-1afc27d31b18/some/path
+ * did: - did:uuid:dd1edaad-a160-44d8-931f-1afc27d31b18 - did:uuid:dd1edaad-a160-44d8-931f-1afc27d31b18/some/path
+ * .
+ */
+export declare type Uri = string;

package/api/types/Uri.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UriReference.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Uri Reference according [RFC3986 - 4.1. URI Reference](https://datatracker.ietf.org/doc/html/rfc3986#section-4.1).
+ */
+export declare type UriReference = string;

package/api/types/UriReference.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ValidationError.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "..";
+/**
+ * Validation Error against JSON-Schema.
+ */
+export interface ValidationError {
+    /** A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. */
+    location: string;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    message: string;
+    errors?: Truvity.ValidationError[];
+}

package/api/types/ValidationError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });