@truvity/sdk 0.27.9-rc.1 → 0.27.16

package/dist/api/resources/apiKeys/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/dist/api/resources/apiKeys/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/api/resources/apiKeys/client/requests/ApiKeyCreateRequest.d.ts

@@ -0,0 +1,69 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "../../../../index";
+/**
+ * @example
+ *     {
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         body: {}
+ *     }
+ */
+export interface ApiKeyCreateRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **Idempotency-Key** is a free identifier created by the client to
+     * identify a request. It is used by the service to identify repeated request
+     * to ensure idempotent behavior by sending the same (or a similar) response
+     * without executing the request a second time.
+     *
+     * Clients should be careful as any subsequent requests with the same key may
+     * return the same response without further check. Thus, it is recommended to
+     * use a UUID version 4 (random) or any other random string with enough
+     * entropy to avoid collisions.
+     *
+     * Keys expire after 24 hours. Clients are responsible to stay within this
+     * limit, if they require idempotent behavior.
+     *
+     * See [API Guideline Rule #181][api-230] for further details.
+     *
+     * [api-230]: <https://opensource.zalando.com/restful-api-guidelines/#230>.
+     */
+    idempotencyKey?: string;
+    body: Truvity.ApiKeyInput;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyCreateRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeyDeleteRequest.d.ts

@@ -0,0 +1,97 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         ifMatch: "If-Match"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ */
+export interface ApiKeyDeleteRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **Idempotency-Key** is a free identifier created by the client to
+     * identify a request. It is used by the service to identify repeated request
+     * to ensure idempotent behavior by sending the same (or a similar) response
+     * without executing the request a second time.
+     *
+     * Clients should be careful as any subsequent requests with the same key may
+     * return the same response without further check. Thus, it is recommended to
+     * use a UUID version 4 (random) or any other random string with enough
+     * entropy to avoid collisions.
+     *
+     * Keys expire after 24 hours. Clients are responsible to stay within this
+     * limit, if they require idempotent behavior.
+     *
+     * See [API Guideline Rule #181][api-230] for further details.
+     *
+     * [api-230]: <https://opensource.zalando.com/restful-api-guidelines/#230>.
+     */
+    idempotencyKey?: string;
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-Match** header field is used to declare a list of identifiers that
+     * are required to match the current resource version identifier in at least
+     * one position as a pre-condition for executing the request on the server
+     * side. This behavior is used to validate and reject optimistic updates, by
+     * checking if the resource version a consumer has based his changes on is
+     * outdated on arrival of the change request to prevent lost updates.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.1][rfc-9110-13.1.1] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.1]: https://tools.ietf.org/html/rfc9110#section-13.1.1
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifMatch: string;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyDeleteRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeyHistoryRequest.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ */
+export interface ApiKeyHistoryRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-None-Match header** field is used to declare a list of identifiers
+     * that are required to fail matching all the current resource version
+     * identifiers as a pre-condition for executing the request on the server
+     * side. This is especially used in conjunction with an **\*** (asterix) that
+     * is matching all possible resource identifiers to ensure the initial
+     * creation of a resource. Other use cases are possible but rare.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.2][rfc-9110-13.1.2] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.2]: https://tools.ietf.org/html/rfc9110#section-13.1.2
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifNoneMatch?: string;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyHistoryRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeyLatestRequest.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ */
+export interface ApiKeyLatestRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-None-Match header** field is used to declare a list of identifiers
+     * that are required to fail matching all the current resource version
+     * identifiers as a pre-condition for executing the request on the server
+     * side. This is especially used in conjunction with an **\*** (asterix) that
+     * is matching all possible resource identifiers to ensure the initial
+     * creation of a resource. Other use cases are possible but rare.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.2][rfc-9110-13.1.2] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.2]: https://tools.ietf.org/html/rfc9110#section-13.1.2
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifNoneMatch?: string;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyLatestRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeyRestoreRequest.d.ts

@@ -0,0 +1,97 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         ifMatch: "If-Match"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string"
+ *     }
+ */
+export interface ApiKeyRestoreRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **Idempotency-Key** is a free identifier created by the client to
+     * identify a request. It is used by the service to identify repeated request
+     * to ensure idempotent behavior by sending the same (or a similar) response
+     * without executing the request a second time.
+     *
+     * Clients should be careful as any subsequent requests with the same key may
+     * return the same response without further check. Thus, it is recommended to
+     * use a UUID version 4 (random) or any other random string with enough
+     * entropy to avoid collisions.
+     *
+     * Keys expire after 24 hours. Clients are responsible to stay within this
+     * limit, if they require idempotent behavior.
+     *
+     * See [API Guideline Rule #181][api-230] for further details.
+     *
+     * [api-230]: <https://opensource.zalando.com/restful-api-guidelines/#230>.
+     */
+    idempotencyKey?: string;
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-Match** header field is used to declare a list of identifiers that
+     * are required to match the current resource version identifier in at least
+     * one position as a pre-condition for executing the request on the server
+     * side. This behavior is used to validate and reject optimistic updates, by
+     * checking if the resource version a consumer has based his changes on is
+     * outdated on arrival of the change request to prevent lost updates.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.1][rfc-9110-13.1.1] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.1]: https://tools.ietf.org/html/rfc9110#section-13.1.1
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifMatch: string;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyRestoreRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeyRevisionRequest.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ *
+ * @example
+ *     {
+ *         ifNoneMatch: "string"
+ *     }
+ */
+export interface ApiKeyRevisionRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-None-Match header** field is used to declare a list of identifiers
+     * that are required to fail matching all the current resource version
+     * identifiers as a pre-condition for executing the request on the server
+     * side. This is especially used in conjunction with an **\*** (asterix) that
+     * is matching all possible resource identifiers to ensure the initial
+     * creation of a resource. Other use cases are possible but rare.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.2][rfc-9110-13.1.2] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.2]: https://tools.ietf.org/html/rfc9110#section-13.1.2
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifNoneMatch?: string;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyRevisionRequest.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/dist/api/resources/apiKeys/client/requests/ApiKeySearch.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "../../../../index";
+/**
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ */
+export interface ApiKeySearch {
+    /** Filter for the api-keys' resources. */
+    filter?: Truvity.ApiKeyFilter[];
+    /** Sort of the api-keys' resources. */
+    sort?: Truvity.ApiKeySort[];
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeySearch.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/dist/api/resources/apiKeys/client/requests/ApiKeyUpdateRequest.d.ts

@@ -0,0 +1,115 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Truvity from "../../../../index";
+/**
+ * @example
+ *     {
+ *         ifMatch: "If-Match",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ *
+ * @example
+ *     {
+ *         idempotencyKey: "string",
+ *         ifMatch: "string",
+ *         body: {}
+ *     }
+ */
+export interface ApiKeyUpdateRequest {
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **Idempotency-Key** is a free identifier created by the client to
+     * identify a request. It is used by the service to identify repeated request
+     * to ensure idempotent behavior by sending the same (or a similar) response
+     * without executing the request a second time.
+     *
+     * Clients should be careful as any subsequent requests with the same key may
+     * return the same response without further check. Thus, it is recommended to
+     * use a UUID version 4 (random) or any other random string with enough
+     * entropy to avoid collisions.
+     *
+     * Keys expire after 24 hours. Clients are responsible to stay within this
+     * limit, if they require idempotent behavior.
+     *
+     * See [API Guideline Rule #181][api-230] for further details.
+     *
+     * [api-230]: <https://opensource.zalando.com/restful-api-guidelines/#230>.
+     */
+    idempotencyKey?: string;
+    /**
+     * From [Zalando RESTful API Guidelines - models/headers-1.0.0.yaml](https://opensource.zalando.com/restful-api-guidelines/models/headers-1.0.0.yaml).
+     * The **If-Match** header field is used to declare a list of identifiers that
+     * are required to match the current resource version identifier in at least
+     * one position as a pre-condition for executing the request on the server
+     * side. This behavior is used to validate and reject optimistic updates, by
+     * checking if the resource version a consumer has based his changes on is
+     * outdated on arrival of the change request to prevent lost updates.
+     *
+     * If the pre-condition fails the server will respond with status code **412**
+     * (Precondition Failed). See [RFC 9110 Section 13.1.1][rfc-9110-13.1.1] as
+     * well as [API Guideline Rule #182][api-182] for further details.
+     *
+     * [rfc-9110-13.1.1]: https://tools.ietf.org/html/rfc9110#section-13.1.1
+     *
+     * [api-182]: <https://opensource.zalando.com/restful-api-guidelines/#182>.
+     */
+    ifMatch: string;
+    body: Truvity.ApiKeyInput;
+}

package/dist/api/resources/apiKeys/client/requests/ApiKeyUpdateRequest.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/dist/api/resources/apiKeys/client/requests/index.d.ts

@@ -0,0 +1,8 @@
+export { type ApiKeyCreateRequest } from "./ApiKeyCreateRequest";
+export { type ApiKeySearch } from "./ApiKeySearch";
+export { type ApiKeyLatestRequest } from "./ApiKeyLatestRequest";
+export { type ApiKeyDeleteRequest } from "./ApiKeyDeleteRequest";
+export { type ApiKeyUpdateRequest } from "./ApiKeyUpdateRequest";
+export { type ApiKeyRestoreRequest } from "./ApiKeyRestoreRequest";
+export { type ApiKeyHistoryRequest } from "./ApiKeyHistoryRequest";
+export { type ApiKeyRevisionRequest } from "./ApiKeyRevisionRequest";

package/dist/api/resources/apiKeys/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/apiKeys/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";