diff --git a/apps/api/package.json b/apps/api/package.json index c89986e903..c2925636ac 100644 --- a/apps/api/package.json +++ b/apps/api/package.json @@ -22,6 +22,8 @@ "migration:gen": "drizzle-kit generate", "prod": "doppler run -- node dist/server.js", "release": "release-it", + "sdk:gen:react-query": "npm run sdk:gen:swagger && rimraf ../../packages/react-query-sdk/src/api && openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript ./swagger/swagger.json -o ../../packages/react-query-sdk/src/api", + "sdk:gen:swagger": "rimraf ./swagger && ts-node -r tsconfig-paths/register scripts/generateSwagger.ts", "start": "webpack --config webpack.dev.js --watch", "test": "jest --selectProjects unit functional", "test:ci-setup": "dc up -d db mock-oauth2-server provider-proxy", @@ -116,6 +118,7 @@ "@akashnetwork/docker": "*", "@akashnetwork/releaser": "*", "@faker-js/faker": "^8.4.1", + "@openapi-qraft/cli": "^2.5.0", "@types/bcryptjs": "^2.4.6", "@types/dot-object": "^2.1.6", "@types/http-assert": "^1.5.5", @@ -149,6 +152,7 @@ "openapi3-ts": "^4.5.0", "prettier": "^3.3.0", "prettier-plugin-tailwindcss": "^0.6.1", + "rimraf": "^6.0.1", "supertest": "^6.1.5", "ts-jest": "^29.1.4", "ts-loader": "^9.5.2", diff --git a/apps/api/scripts/generateSwagger.ts b/apps/api/scripts/generateSwagger.ts new file mode 100644 index 0000000000..a51331fa94 --- /dev/null +++ b/apps/api/scripts/generateSwagger.ts @@ -0,0 +1,48 @@ +import "reflect-metadata"; +import "@akashnetwork/env-loader"; +import "../src/app"; + +import * as fsp from "fs/promises"; +import { dirname, resolve } from "path"; +import { container } from "tsyringe"; + +import { openApiHonoHandlers } from "../src/app/rest-handlers"; +import { OpenApiDocsService } from "../src/core/services/openapi-docs/openapi-docs.service"; + +async function main() { + const outputPathArg = process.argv[2]; + const defaultOutputPath = resolve(process.cwd(), "swagger/swagger.json"); + const outputPath = outputPathArg ? resolve(process.cwd(), outputPathArg) : defaultOutputPath; + const scope = (process.argv[3] as "full" | "console") || "full"; + + if (!["full", "console"].includes(scope)) { + console.error(`Invalid scope: ${scope}. Valid options: "full", "console"`); + process.exit(1); + } + + console.log(`Generating OpenAPI docs with scope: ${scope}`); + console.log(`Output path: ${outputPath}`); + + try { + const openApiDocsService = container.resolve(OpenApiDocsService); + const docs = await openApiDocsService.generateDocs(openApiHonoHandlers, { scope }); + + // Sanitize path parameter names - remove '?' from optional path parameters + // Hono supports {param?} but OpenAPI doesn't, and it causes invalid TypeScript identifiers + const sanitizedDocs = { + ...docs, + paths: Object.fromEntries(Object.entries(docs.paths || {}).map(([path, pathItem]) => [path.replace(/\{(\w+)\?}/g, "{$1}"), pathItem])) + }; + + const outputDir = dirname(outputPath); + await fsp.mkdir(outputDir, { recursive: true }); + await fsp.writeFile(outputPath, JSON.stringify(sanitizedDocs, null, 2)); + + console.log(`✓ Swagger JSON written successfully to ${outputPath}`); + } catch (error) { + console.error("Error generating Swagger docs:", error); + process.exit(1); + } +} + +main(); diff --git a/apps/api/src/app/rest-handlers.ts b/apps/api/src/app/rest-handlers.ts new file mode 100644 index 0000000000..b73c6ef51b --- /dev/null +++ b/apps/api/src/app/rest-handlers.ts @@ -0,0 +1,99 @@ +import { addressRouter } from "@src/address"; +import { apiKeysRouter, sendVerificationEmailRouter } from "@src/auth"; +import { verifyEmailRouter } from "@src/auth/routes/verify-email/verify-email.router"; +import { bidsRouter } from "@src/bid/routes/bids/bids.router"; +import { + checkoutRouter, + getBalancesRouter, + getWalletListRouter, + signAndBroadcastTxRouter, + startTrialRouter, + stripeCouponsRouter, + stripeCustomersRouter, + stripePaymentMethodsRouter, + stripePricesRouter, + stripeTransactionsRouter, + stripeWebhook, + usageRouter, + walletSettingRouter +} from "@src/billing"; +import { blockPredictionRouter, blocksRouter } from "@src/block"; +import { certificateRouter } from "@src/certificate/routes/certificate.router"; +import type { OpenApiHonoHandler } from "@src/core/services/open-api-hono-handler/open-api-hono-handler"; +import { dashboardDataRouter, graphDataRouter, leasesDurationRouter, marketDataRouter, networkCapacityRouter } from "@src/dashboard"; +import { deploymentSettingRouter } from "@src/deployment/routes/deployment-setting/deployment-setting.router"; +import { deploymentsRouter } from "@src/deployment/routes/deployments/deployments.router"; +import { leasesRouter } from "@src/deployment/routes/leases/leases.router"; +import { gpuRouter } from "@src/gpu"; +import { networkRouter } from "@src/network"; +import { pricingRouter } from "@src/pricing"; +import { proposalsRouter } from "@src/proposal"; +import { + auditorsRouter, + providerAttributesSchemaRouter, + providerDashboardRouter, + providerDeploymentsRouter, + providerEarningsRouter, + providerGraphDataRouter, + providerJwtTokenRouter, + providerRegionsRouter, + providersRouter, + providerVersionsRouter +} from "@src/provider"; +import { templatesRouter } from "@src/template"; +import { transactionsRouter } from "@src/transaction"; +import { createAnonymousUserRouter, getAnonymousUserRouter, getCurrentUserRouter, registerUserRouter } from "@src/user"; +import { validatorsRouter } from "@src/validator"; + +export const openApiHonoHandlers: OpenApiHonoHandler[] = [ + startTrialRouter, + getWalletListRouter, + walletSettingRouter, + signAndBroadcastTxRouter, + checkoutRouter, + stripeWebhook, + stripePricesRouter, + stripeCouponsRouter, + stripeCustomersRouter, + stripePaymentMethodsRouter, + stripeTransactionsRouter, + usageRouter, + createAnonymousUserRouter, + getAnonymousUserRouter, + registerUserRouter, + getCurrentUserRouter, + sendVerificationEmailRouter, + verifyEmailRouter, + deploymentSettingRouter, + deploymentsRouter, + leasesRouter, + apiKeysRouter, + bidsRouter, + certificateRouter, + getBalancesRouter, + providersRouter, + auditorsRouter, + providerAttributesSchemaRouter, + providerRegionsRouter, + providerDashboardRouter, + providerEarningsRouter, + providerVersionsRouter, + providerGraphDataRouter, + providerDeploymentsRouter, + providerJwtTokenRouter, + graphDataRouter, + dashboardDataRouter, + networkCapacityRouter, + blocksRouter, + blockPredictionRouter, + transactionsRouter, + marketDataRouter, + validatorsRouter, + pricingRouter, + gpuRouter, + proposalsRouter, + templatesRouter, + leasesDurationRouter, + addressRouter, + networkRouter +]; diff --git a/apps/api/src/billing/services/index.ts b/apps/api/src/billing/services/index.ts index 56c01d555f..2797d710be 100644 --- a/apps/api/src/billing/services/index.ts +++ b/apps/api/src/billing/services/index.ts @@ -4,5 +4,5 @@ export * from "./wallet-initializer/wallet-initializer.service"; export * from "@src/billing/lib/wallet/wallet"; export * from "@src/billing/lib/batch-signing-client/batch-signing-client.service"; export * from "@src/billing/services/managed-signer/managed-signer.service"; -export * from "./remaining-credits/remaining-credits.service.ts"; +export * from "./remaining-credits/remaining-credits.service"; export * from "./wallet-settings/wallet-settings.service"; diff --git a/apps/api/src/core/services/openapi-docs/openapi-docs.service.ts b/apps/api/src/core/services/openapi-docs/openapi-docs.service.ts index a0db13094e..0a3f253c74 100644 --- a/apps/api/src/core/services/openapi-docs/openapi-docs.service.ts +++ b/apps/api/src/core/services/openapi-docs/openapi-docs.service.ts @@ -63,6 +63,14 @@ export class OpenApiDocsService { }); Object.assign(docs.paths, handlerDocs.paths); + + if (handlerDocs.components?.schemas) { + Object.assign(docs.components.schemas, handlerDocs.components.schemas); + } + + if (handlerDocs.components?.securitySchemes) { + Object.assign(docs.components.securitySchemes, handlerDocs.components.securitySchemes); + } } catch (error) { logger.error({ name: `Error generating OpenAPI docs for handler, example path: ${handler.routes[0]?.path || "unknown"}`, diff --git a/apps/api/src/deployment/services/index.ts b/apps/api/src/deployment/services/index.ts index 0cf1eb7303..0a749322a2 100644 --- a/apps/api/src/deployment/services/index.ts +++ b/apps/api/src/deployment/services/index.ts @@ -1 +1 @@ -export * from "./active-deployments-count/active-deployments-count.service.ts"; +export * from "./active-deployments-count/active-deployments-count.service"; diff --git a/apps/api/src/rest-app.ts b/apps/api/src/rest-app.ts index ce2716edb6..11446273af 100644 --- a/apps/api/src/rest-app.ts +++ b/apps/api/src/rest-app.ts @@ -10,20 +10,14 @@ import assert from "http-assert"; import { container } from "tsyringe"; import packageJson from "../package.json"; -import { verifyEmailRouter } from "./auth/routes/verify-email/verify-email.router"; +import { openApiHonoHandlers } from "./app/rest-handlers"; import { AuthInterceptor } from "./auth/services/auth.interceptor"; -import { bidsRouter } from "./bid/routes/bids/bids.router"; -import { certificateRouter } from "./certificate/routes/certificate.router"; import { HonoErrorHandlerService } from "./core/services/hono-error-handler/hono-error-handler.service"; -import type { OpenApiHonoHandler } from "./core/services/open-api-hono-handler/open-api-hono-handler"; import { OpenApiDocsService } from "./core/services/openapi-docs/openapi-docs.service"; import { RequestContextInterceptor } from "./core/services/request-context-interceptor/request-context.interceptor"; import { startServer } from "./core/services/start-server/start-server"; import type { AppEnv } from "./core/types/app-context"; import { connectUsingSequelize } from "./db/dbConnection"; -import { deploymentSettingRouter } from "./deployment/routes/deployment-setting/deployment-setting.router"; -import { deploymentsRouter } from "./deployment/routes/deployments/deployments.router"; -import { leasesRouter } from "./deployment/routes/leases/leases.router"; import { healthzRouter } from "./healthz/routes/healthz.router"; import { clientInfoMiddleware } from "./middlewares/clientInfoMiddleware"; import { notificationsApiProxy } from "./notifications/routes/proxy/proxy.route"; @@ -35,46 +29,7 @@ import { legacyRouter } from "./routers/legacyRouter"; import { userRouter } from "./routers/userRouter"; import { web3IndexRouter } from "./routers/web3indexRouter"; import { bytesToHumanReadableSize } from "./utils/files"; -import { addressRouter } from "./address"; -import { apiKeysRouter, sendVerificationEmailRouter } from "./auth"; -import { - checkoutRouter, - getBalancesRouter, - getWalletListRouter, - signAndBroadcastTxRouter, - startTrialRouter, - stripeCouponsRouter, - stripeCustomersRouter, - stripePaymentMethodsRouter, - stripePricesRouter, - stripeTransactionsRouter, - stripeWebhook, - usageRouter, - walletSettingRouter -} from "./billing"; -import { blockPredictionRouter, blocksRouter } from "./block"; import { CORE_CONFIG, migratePG } from "./core"; -import { dashboardDataRouter, graphDataRouter, leasesDurationRouter, marketDataRouter, networkCapacityRouter } from "./dashboard"; -import { gpuRouter } from "./gpu"; -import { networkRouter } from "./network"; -import { pricingRouter } from "./pricing"; -import { proposalsRouter } from "./proposal"; -import { - auditorsRouter, - providerAttributesSchemaRouter, - providerDashboardRouter, - providerDeploymentsRouter, - providerEarningsRouter, - providerGraphDataRouter, - providerJwtTokenRouter, - providerRegionsRouter, - providersRouter, - providerVersionsRouter -} from "./provider"; -import { templatesRouter } from "./template"; -import { transactionsRouter } from "./transaction"; -import { createAnonymousUserRouter, getAnonymousUserRouter, getCurrentUserRouter, registerUserRouter } from "./user"; -import { validatorsRouter } from "./validator"; const appHono = new Hono(); appHono.use("*", otel()); @@ -104,58 +59,6 @@ appHono.route("/dashboard", dashboardRouter); appHono.route("/internal", internalRouter); appHono.route("/deployments", deploymentRouter); -const openApiHonoHandlers: OpenApiHonoHandler[] = [ - startTrialRouter, - getWalletListRouter, - walletSettingRouter, - signAndBroadcastTxRouter, - checkoutRouter, - stripeWebhook, - stripePricesRouter, - stripeCouponsRouter, - stripeCustomersRouter, - stripePaymentMethodsRouter, - stripeTransactionsRouter, - usageRouter, - createAnonymousUserRouter, - getAnonymousUserRouter, - registerUserRouter, - getCurrentUserRouter, - sendVerificationEmailRouter, - verifyEmailRouter, - deploymentSettingRouter, - deploymentsRouter, - leasesRouter, - apiKeysRouter, - bidsRouter, - certificateRouter, - getBalancesRouter, - providersRouter, - auditorsRouter, - providerAttributesSchemaRouter, - providerRegionsRouter, - providerDashboardRouter, - providerEarningsRouter, - providerVersionsRouter, - providerGraphDataRouter, - providerDeploymentsRouter, - providerJwtTokenRouter, - graphDataRouter, - dashboardDataRouter, - networkCapacityRouter, - blocksRouter, - blockPredictionRouter, - transactionsRouter, - marketDataRouter, - validatorsRouter, - pricingRouter, - gpuRouter, - proposalsRouter, - templatesRouter, - leasesDurationRouter, - addressRouter, - networkRouter -]; for (const handler of openApiHonoHandlers) { appHono.route("/", handler); } diff --git a/apps/api/swagger/swagger.json b/apps/api/swagger/swagger.json new file mode 100644 index 0000000000..4fadd254ed --- /dev/null +++ b/apps/api/swagger/swagger.json @@ -0,0 +1,21091 @@ +{ + "openapi": "3.0.0", + "servers": [ + { + "url": "http://localhost:3080" + } + ], + "info": { + "title": "Akash Network Console API", + "description": "API providing data to the Akash Network Console", + "version": "v1" + }, + "paths": { + "/v1/start-trial": { + "post": { + "summary": "Start a trial period for a user", + "description": "Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status.", + "tags": [ + "Wallet" + ], + "security": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "userId": { + "type": "string" + } + }, + "required": [ + "userId" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Trial started successfully and wallet created", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number", + "nullable": true + }, + "userId": { + "type": "string", + "nullable": true + }, + "creditAmount": { + "type": "number" + }, + "address": { + "type": "string", + "nullable": true + }, + "isTrialing": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "requires3DS": { + "type": "boolean" + }, + "clientSecret": { + "type": "string", + "nullable": true + }, + "paymentIntentId": { + "type": "string", + "nullable": true + }, + "paymentMethodId": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "userId", + "creditAmount", + "address", + "isTrialing", + "createdAt" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ] + } + } + } + }, + "202": { + "description": "3D Secure authentication required to complete trial setup", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "number", + "nullable": true + }, + "userId": { + "type": "string", + "nullable": true + }, + "creditAmount": { + "type": "number" + }, + "address": { + "type": "string", + "nullable": true + }, + "isTrialing": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "requires3DS": { + "type": "boolean" + }, + "clientSecret": { + "type": "string", + "nullable": true + }, + "paymentIntentId": { + "type": "string", + "nullable": true + }, + "paymentMethodId": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "userId", + "creditAmount", + "address", + "isTrialing", + "createdAt" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/wallets": { + "get": { + "summary": "Get a list of wallets", + "tags": [ + "Wallet" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "userId", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "awaitSessionId", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns a created wallet", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number", + "nullable": true + }, + "userId": { + "type": "string", + "nullable": true + }, + "creditAmount": { + "type": "number" + }, + "address": { + "type": "string", + "nullable": true + }, + "isTrialing": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "nullable": true + }, + "requires3DS": { + "type": "boolean" + }, + "clientSecret": { + "type": "string", + "nullable": true + }, + "paymentIntentId": { + "type": "string", + "nullable": true + }, + "paymentMethodId": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "userId", + "creditAmount", + "address", + "isTrialing", + "createdAt" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/wallet-settings": { + "get": { + "summary": "Get wallet settings", + "description": "Retrieves the wallet settings for the current user's wallet", + "tags": [ + "WalletSetting" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Wallet settings retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoReloadEnabled": { + "type": "boolean" + } + }, + "required": [ + "autoReloadEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "UserWallet Not Found" + } + } + }, + "post": { + "summary": "Create wallet settings", + "description": "Creates wallet settings for a user wallet", + "tags": [ + "WalletSetting" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoReloadEnabled": { + "type": "boolean" + } + }, + "required": [ + "autoReloadEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Wallet settings created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoReloadEnabled": { + "type": "boolean" + } + }, + "required": [ + "autoReloadEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "UserWallet Not Found" + } + } + }, + "put": { + "summary": "Update wallet settings", + "description": "Updates wallet settings for a user wallet", + "tags": [ + "WalletSetting" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoReloadEnabled": { + "type": "boolean" + } + }, + "required": [ + "autoReloadEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Wallet settings updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoReloadEnabled": { + "type": "boolean" + } + }, + "required": [ + "autoReloadEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "UserWallet Not Found" + } + } + }, + "delete": { + "summary": "Delete wallet settings", + "description": "Deletes wallet settings for a user wallet", + "tags": [ + "WalletSetting" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "204": { + "description": "Wallet settings deleted successfully" + }, + "404": { + "description": "UserWallet Not Found" + } + } + } + }, + "/v1/tx": { + "post": { + "summary": "Signs a transaction via a user managed wallet", + "tags": [ + "Wallet" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "typeUrl": { + "type": "string", + "enum": [ + "/akash.deployment.v1beta4.MsgCreateDeployment", + "/akash.cert.v1.MsgCreateCertificate", + "/akash.market.v1beta5.MsgCreateLease", + "/akash.deployment.v1beta4.MsgUpdateDeployment", + "/akash.deployment.v1beta4.MsgCloseDeployment", + "/akash.escrow.v1.MsgAccountDeposit" + ] + }, + "value": { + "type": "string" + } + }, + "required": [ + "typeUrl", + "value" + ] + }, + "minItems": 1 + } + }, + "required": [ + "userId", + "messages" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns a signed transaction", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "transactionHash": { + "type": "string" + }, + "rawLog": { + "type": "string" + } + }, + "required": [ + "code", + "transactionHash", + "rawLog" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/checkout": { + "get": { + "summary": "Creates a stripe checkout session and redirects to checkout", + "tags": [ + "Wallet" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": false, + "name": "amount", + "in": "query" + } + ], + "responses": { + "301": { + "description": "Redirects to the checkout page" + } + } + } + }, + "/v1/stripe-webhook": { + "post": { + "summary": "Stripe Webhook Handler", + "tags": [ + "Payment" + ], + "security": [], + "requestBody": { + "content": { + "text/plain": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "Webhook processed successfully", + "content": {} + }, + "400": { + "description": "Stripe signature is required", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + }, + "required": [ + "error" + ] + } + } + } + } + } + } + }, + "/v1/stripe/prices": { + "get": { + "summary": "Get available Stripe pricing options", + "description": "Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Available pricing options retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "currency": { + "type": "string" + }, + "unitAmount": { + "type": "number" + }, + "isCustom": { + "type": "boolean" + } + }, + "required": [ + "currency", + "unitAmount", + "isCustom" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/coupons/apply": { + "post": { + "summary": "Apply a coupon to the current user", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "couponId": { + "type": "string" + }, + "userId": { + "type": "string" + } + }, + "required": [ + "couponId", + "userId" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Coupon applied successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "coupon": { + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "string" + }, + "percent_off": { + "type": "number", + "nullable": true + }, + "amount_off": { + "type": "number", + "nullable": true + }, + "valid": { + "type": "boolean", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id" + ] + }, + "amountAdded": { + "type": "number" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/customers/organization": { + "put": { + "summary": "Update customer organization", + "description": "Updates the organization/business name for the current user's Stripe customer account", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization": { + "type": "string" + } + }, + "required": [ + "organization" + ] + } + } + } + }, + "responses": { + "204": { + "description": "Organization updated successfully" + } + } + } + }, + "/v1/stripe/payment-methods/setup": { + "post": { + "summary": "Create a Stripe SetupIntent for adding a payment method", + "description": "Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "SetupIntent created successfully with client secret", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "clientSecret": { + "type": "string", + "nullable": true + } + }, + "required": [ + "clientSecret" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/payment-methods/default": { + "post": { + "summary": "Marks a payment method as the default.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Payment method is marked as the default successfully." + } + } + }, + "get": { + "summary": "Get the default payment method for the current user", + "description": "Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Default payment method retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "validated": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "card": { + "type": "object", + "nullable": true, + "properties": { + "brand": { + "type": "string", + "nullable": true + }, + "last4": { + "type": "string", + "nullable": true + }, + "exp_month": { + "type": "number" + }, + "exp_year": { + "type": "number" + }, + "funding": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "network": { + "type": "string", + "nullable": true + }, + "three_d_secure_usage": { + "type": "object", + "nullable": true, + "properties": { + "supported": { + "type": "boolean", + "nullable": true + } + } + } + }, + "required": [ + "brand", + "last4", + "exp_month", + "exp_year" + ] + }, + "billing_details": { + "type": "object", + "properties": { + "address": { + "type": "object", + "nullable": true, + "properties": { + "city": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "line1": { + "type": "string", + "nullable": true + }, + "line2": { + "type": "string", + "nullable": true + }, + "postal_code": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "nullable": true + } + }, + "required": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] + }, + "email": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "phone": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "type" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "Default payment method not found" + } + } + } + }, + "/v1/stripe/payment-methods": { + "get": { + "summary": "Get all payment methods for the current user", + "description": "Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Payment methods retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "validated": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "card": { + "type": "object", + "nullable": true, + "properties": { + "brand": { + "type": "string", + "nullable": true + }, + "last4": { + "type": "string", + "nullable": true + }, + "exp_month": { + "type": "number" + }, + "exp_year": { + "type": "number" + }, + "funding": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "network": { + "type": "string", + "nullable": true + }, + "three_d_secure_usage": { + "type": "object", + "nullable": true, + "properties": { + "supported": { + "type": "boolean", + "nullable": true + } + } + } + }, + "required": [ + "brand", + "last4", + "exp_month", + "exp_year" + ] + }, + "billing_details": { + "type": "object", + "properties": { + "address": { + "type": "object", + "nullable": true, + "properties": { + "city": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "line1": { + "type": "string", + "nullable": true + }, + "line2": { + "type": "string", + "nullable": true + }, + "postal_code": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "nullable": true + } + }, + "required": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] + }, + "email": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "phone": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "type" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/payment-methods/{paymentMethodId}": { + "delete": { + "summary": "Remove a payment method", + "description": "Permanently removes a saved payment method from the user's account. This action cannot be undone.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "description": "The unique identifier of the payment method to remove", + "example": "pm_1234567890" + }, + "required": true, + "name": "paymentMethodId", + "in": "path" + } + ], + "responses": { + "204": { + "description": "Payment method removed successfully" + } + } + } + }, + "/v1/stripe/payment-methods/validate": { + "post": { + "summary": "Validates a payment method after 3D Secure authentication", + "description": "Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" + }, + "paymentIntentId": { + "type": "string" + } + }, + "required": [ + "paymentMethodId", + "paymentIntentId" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Payment method validated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + } + } + } + }, + "/v1/stripe/transactions/confirm": { + "post": { + "summary": "Confirm a payment using a saved payment method", + "description": "Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts.", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "paymentMethodId": { + "type": "string" + }, + "amount": { + "type": "number", + "minimum": 20 + }, + "currency": { + "type": "string" + } + }, + "required": [ + "userId", + "paymentMethodId", + "amount", + "currency" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Payment processed successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "requiresAction": { + "type": "boolean" + }, + "clientSecret": { + "type": "string" + }, + "paymentIntentId": { + "type": "string" + } + }, + "required": [ + "success" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "202": { + "description": "3D Secure authentication required to complete payment", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "requiresAction": { + "type": "boolean" + }, + "clientSecret": { + "type": "string" + }, + "paymentIntentId": { + "type": "string" + } + }, + "required": [ + "success" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/transactions": { + "get": { + "summary": "Get transaction history for the current customer", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "number", + "description": "Number of transactions to return", + "minimum": 1, + "maximum": 100, + "example": 100, + "default": 100 + }, + "required": false, + "name": "limit", + "in": "query" + }, + { + "schema": { + "type": "string", + "description": "ID of the last transaction from the previous page (if paginating forwards)", + "example": "ch_1234567890" + }, + "required": false, + "name": "startingAfter", + "in": "query" + }, + { + "schema": { + "type": "string", + "description": "ID of the first transaction from the previous page (if paginating backwards)", + "example": "ch_0987654321" + }, + "required": false, + "name": "endingBefore", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date-time", + "description": "Start date for filtering transactions (inclusive)", + "example": "2025-01-01T00:00:00Z" + }, + "required": false, + "name": "startDate", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date-time", + "description": "End date for filtering transactions (inclusive)", + "example": "2025-01-02T00:00:00Z" + }, + "required": false, + "name": "endDate", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Customer transactions retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "transactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "currency": { + "type": "string" + }, + "status": { + "type": "string" + }, + "created": { + "type": "number" + }, + "paymentMethod": { + "type": "object", + "nullable": true, + "properties": { + "type": { + "type": "string" + }, + "validated": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "card": { + "type": "object", + "nullable": true, + "properties": { + "brand": { + "type": "string", + "nullable": true + }, + "last4": { + "type": "string", + "nullable": true + }, + "exp_month": { + "type": "number" + }, + "exp_year": { + "type": "number" + }, + "funding": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "network": { + "type": "string", + "nullable": true + }, + "three_d_secure_usage": { + "type": "object", + "nullable": true, + "properties": { + "supported": { + "type": "boolean", + "nullable": true + } + } + } + }, + "required": [ + "brand", + "last4", + "exp_month", + "exp_year" + ] + }, + "billing_details": { + "type": "object", + "properties": { + "address": { + "type": "object", + "nullable": true, + "properties": { + "city": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "line1": { + "type": "string", + "nullable": true + }, + "line2": { + "type": "string", + "nullable": true + }, + "postal_code": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "nullable": true + } + }, + "required": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] + }, + "email": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "phone": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "type" + ] + }, + "receiptUrl": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "metadata": { + "type": "object", + "nullable": true, + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id", + "amount", + "currency", + "status", + "created", + "paymentMethod" + ] + } + }, + "hasMore": { + "type": "boolean" + }, + "nextPage": { + "type": "string", + "nullable": true + } + }, + "required": [ + "transactions", + "hasMore" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/stripe/transactions/export": { + "get": { + "summary": "Export transaction history as CSV for the current customer", + "tags": [ + "Payment" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Timezone for date formatting in the CSV", + "example": "America/New_York" + }, + "required": true, + "name": "timezone", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date-time", + "description": "Start date for filtering transactions (inclusive)", + "example": "2025-01-01T00:00:00Z" + }, + "required": true, + "name": "startDate", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date-time", + "description": "End date for filtering transactions (inclusive)", + "example": "2025-01-02T00:00:00Z" + }, + "required": true, + "name": "endDate", + "in": "query" + } + ], + "responses": { + "200": { + "description": "CSV file with transaction data", + "content": { + "text/csv": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/v1/usage/history": { + "get": { + "summary": "Get historical data of billing and usage for a wallet address.", + "tags": [ + "Billing" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "The wallet address to get billing and usage data for", + "example": "akash18andxgtd6r08zzfpcdqg9pdr6smks7gv76tyt6" + }, + "required": true, + "name": "address", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date", + "description": "Start date (YYYY-MM-DD). Defaults to 30 days before endDate", + "example": "2024-01-01" + }, + "required": false, + "name": "startDate", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date", + "default": "2025-12-30", + "description": "End date (YYYY-MM-DD). Defaults to today by UTC 23:59:59", + "example": "2024-01-31" + }, + "required": false, + "name": "endDate", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns billing and usage data", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date in YYYY-MM-DD format", + "example": "2024-01-15" + }, + "activeDeployments": { + "type": "number", + "description": "Number of active deployments on this date", + "example": 3 + }, + "dailyAktSpent": { + "type": "number", + "description": "AKT tokens spent on this date", + "example": 12.5 + }, + "totalAktSpent": { + "type": "number", + "description": "Cumulative AKT tokens spent up to this date", + "example": 125.75 + }, + "dailyUsdcSpent": { + "type": "number", + "description": "USDC spent on this date", + "example": 5.25 + }, + "totalUsdcSpent": { + "type": "number", + "description": "Cumulative USDC spent up to this date", + "example": 52.5 + }, + "dailyUsdSpent": { + "type": "number", + "description": "Total USD value spent on this date (AKT + USDC)", + "example": 17.75 + }, + "totalUsdSpent": { + "type": "number", + "description": "Cumulative USD value spent up to this date", + "example": 178.25 + } + }, + "required": [ + "date", + "activeDeployments", + "dailyAktSpent", + "totalAktSpent", + "dailyUsdcSpent", + "totalUsdcSpent", + "dailyUsdSpent", + "totalUsdSpent" + ] + } + } + } + } + }, + "400": { + "description": "Invalid address format" + } + } + } + }, + "/v1/usage/history/stats": { + "get": { + "summary": "Get historical usage stats for a wallet address.", + "tags": [ + "Billing" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "The wallet address to get billing and usage data for", + "example": "akash18andxgtd6r08zzfpcdqg9pdr6smks7gv76tyt6" + }, + "required": true, + "name": "address", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date", + "description": "Start date (YYYY-MM-DD). Defaults to 30 days before endDate", + "example": "2024-01-01" + }, + "required": false, + "name": "startDate", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "date", + "default": "2025-12-30", + "description": "End date (YYYY-MM-DD). Defaults to today by UTC 23:59:59", + "example": "2024-01-31" + }, + "required": false, + "name": "endDate", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns usage stats data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "totalSpent": { + "type": "number", + "description": "Total amount spent in USD", + "example": 1234.56 + }, + "averageSpentPerDay": { + "type": "number", + "description": "Average spending per day in USD", + "example": 12.34 + }, + "totalDeployments": { + "type": "number", + "description": "Total number of deployments deployed", + "example": 15 + }, + "averageDeploymentsPerDay": { + "type": "number", + "description": "Average number of deployments deployed per day", + "example": 1.5 + } + }, + "required": [ + "totalSpent", + "averageSpentPerDay", + "totalDeployments", + "averageDeploymentsPerDay" + ] + } + } + } + }, + "400": { + "description": "Invalid address format" + } + } + } + }, + "/v1/anonymous-users": { + "post": { + "summary": "Creates an anonymous user", + "tags": [ + "Users" + ], + "security": [], + "responses": { + "200": { + "description": "Returns a created anonymous user", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "token": { + "type": "string" + } + }, + "required": [ + "data", + "token" + ] + } + } + } + } + } + } + }, + "/v1/anonymous-users/{id}": { + "get": { + "summary": "Retrieves an anonymous user by id", + "tags": [ + "Users" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "required": true, + "name": "id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns an anonymous user", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/register-user": { + "post": { + "summary": "Registers a new user", + "tags": [ + "Users" + ], + "security": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "wantedUsername": { + "type": "string" + }, + "email": { + "type": "string" + }, + "emailVerified": { + "type": "boolean" + }, + "subscribedToNewsletter": { + "type": "boolean" + } + }, + "required": [ + "wantedUsername", + "email", + "emailVerified" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns the registered user", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "emailVerified": { + "type": "boolean" + }, + "stripeCustomerId": { + "type": "string", + "nullable": true + }, + "bio": { + "type": "string", + "nullable": true + }, + "subscribedToNewsletter": { + "type": "boolean" + }, + "youtubeUsername": { + "type": "string", + "nullable": true + }, + "twitterUsername": { + "type": "string", + "nullable": true + }, + "githubUsername": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "userId", + "username", + "email", + "emailVerified", + "subscribedToNewsletter" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/user/me": { + "get": { + "summary": "Retrieves the logged in user", + "tags": [ + "Users" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Returns the logged in user", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/send-verification-email": { + "post": { + "summary": "Resends a verification email", + "tags": [ + "Users" + ], + "security": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "userId": { + "type": "string" + } + }, + "required": [ + "userId" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns a created wallet", + "content": {} + } + } + } + }, + "/v1/verify-email": { + "post": { + "summary": "Checks if the email is verified", + "tags": [ + "Users" + ], + "security": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + } + }, + "required": [ + "email" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns email verification status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "emailVerified": { + "type": "boolean" + } + }, + "required": [ + "emailVerified" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "404": { + "description": "User not found" + } + } + } + }, + "/v1/deployment-settings/{userId}/{dseq}": { + "get": { + "summary": "Get deployment settings by user ID and dseq", + "tags": [ + "Deployment Settings" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "description": "User ID" + }, + "required": true, + "name": "userId", + "in": "path" + }, + { + "schema": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "required": true, + "name": "dseq", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns deployment settings", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "autoTopUpEnabled": { + "type": "boolean" + }, + "estimatedTopUpAmount": { + "type": "number" + }, + "topUpFrequencyMs": { + "type": "number" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "userId", + "dseq", + "autoTopUpEnabled", + "estimatedTopUpAmount", + "topUpFrequencyMs", + "createdAt", + "updatedAt" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "Deployment settings not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + } + } + }, + "patch": { + "summary": "Update deployment settings", + "tags": [ + "Deployment Settings" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "description": "User ID" + }, + "required": true, + "name": "userId", + "in": "path" + }, + { + "schema": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "required": true, + "name": "dseq", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "autoTopUpEnabled": { + "type": "boolean", + "description": "Whether auto top-up is enabled for this deployment" + } + }, + "required": [ + "autoTopUpEnabled" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Deployment settings updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "autoTopUpEnabled": { + "type": "boolean" + }, + "estimatedTopUpAmount": { + "type": "number" + }, + "topUpFrequencyMs": { + "type": "number" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "userId", + "dseq", + "autoTopUpEnabled", + "estimatedTopUpAmount", + "topUpFrequencyMs", + "createdAt", + "updatedAt" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "Deployment settings not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + } + } + } + }, + "/v1/deployment-settings": { + "post": { + "summary": "Create deployment settings", + "tags": [ + "Deployment Settings" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID" + }, + "dseq": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "autoTopUpEnabled": { + "type": "boolean", + "default": false, + "description": "Whether auto top-up is enabled for this deployment" + } + }, + "required": [ + "userId", + "dseq" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "201": { + "description": "Deployment settings created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "autoTopUpEnabled": { + "type": "boolean" + }, + "estimatedTopUpAmount": { + "type": "number" + }, + "topUpFrequencyMs": { + "type": "number" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "userId", + "dseq", + "autoTopUpEnabled", + "estimatedTopUpAmount", + "topUpFrequencyMs", + "createdAt", + "updatedAt" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/deployments/{dseq}": { + "get": { + "summary": "Get a deployment", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "required": true, + "description": "Deployment sequence number", + "name": "dseq", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns deployment info", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "status": { + "type": "object", + "nullable": true, + "properties": { + "forwarded_ports": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "port": { + "type": "number" + }, + "externalPort": { + "type": "number" + }, + "host": { + "type": "string" + }, + "available": { + "type": "number" + } + }, + "required": [ + "port", + "externalPort" + ] + } + } + }, + "ips": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "IP": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ExternalPort": { + "type": "number" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "IP", + "Port", + "ExternalPort", + "Protocol" + ] + } + } + }, + "services": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "available": { + "type": "number" + }, + "total": { + "type": "number" + }, + "uris": { + "type": "array", + "items": { + "type": "string" + } + }, + "observed_generation": { + "type": "number" + }, + "replicas": { + "type": "number" + }, + "updated_replicas": { + "type": "number" + }, + "ready_replicas": { + "type": "number" + }, + "available_replicas": { + "type": "number" + } + }, + "required": [ + "name", + "available", + "total", + "uris", + "observed_generation", + "replicas", + "updated_replicas", + "ready_replicas", + "available_replicas" + ] + } + } + }, + "required": [ + "forwarded_ports", + "ips", + "services" + ] + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on", + "status" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "leases", + "escrow_account" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + }, + "delete": { + "summary": "Close a deployment", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "required": true, + "description": "Deployment sequence number", + "name": "dseq", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Deployment closed successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + }, + "put": { + "summary": "Update a deployment", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "required": true, + "description": "Deployment sequence number", + "name": "dseq", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "sdl": { + "type": "string" + }, + "certificate": { + "type": "object", + "properties": { + "certPem": { + "type": "string" + }, + "keyPem": { + "type": "string" + } + }, + "required": [ + "certPem", + "keyPem" + ] + } + }, + "required": [ + "sdl" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Deployment updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "status": { + "type": "object", + "nullable": true, + "properties": { + "forwarded_ports": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "port": { + "type": "number" + }, + "externalPort": { + "type": "number" + }, + "host": { + "type": "string" + }, + "available": { + "type": "number" + } + }, + "required": [ + "port", + "externalPort" + ] + } + } + }, + "ips": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "IP": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ExternalPort": { + "type": "number" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "IP", + "Port", + "ExternalPort", + "Protocol" + ] + } + } + }, + "services": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "available": { + "type": "number" + }, + "total": { + "type": "number" + }, + "uris": { + "type": "array", + "items": { + "type": "string" + } + }, + "observed_generation": { + "type": "number" + }, + "replicas": { + "type": "number" + }, + "updated_replicas": { + "type": "number" + }, + "ready_replicas": { + "type": "number" + }, + "available_replicas": { + "type": "number" + } + }, + "required": [ + "name", + "available", + "total", + "uris", + "observed_generation", + "replicas", + "updated_replicas", + "ready_replicas", + "available_replicas" + ] + } + } + }, + "required": [ + "forwarded_ports", + "ips", + "services" + ] + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on", + "status" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "leases", + "escrow_account" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/deployments": { + "post": { + "summary": "Create new deployment", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "sdl": { + "type": "string" + }, + "deposit": { + "type": "number", + "description": "Amount to deposit in dollars (e.g. 5.5)" + } + }, + "required": [ + "sdl", + "deposit" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "201": { + "description": "Create deployment successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "manifest": { + "type": "string" + }, + "signTx": { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "transactionHash": { + "type": "string" + }, + "rawLog": { + "type": "string" + } + }, + "required": [ + "code", + "transactionHash", + "rawLog" + ] + } + }, + "required": [ + "dseq", + "manifest", + "signTx" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + }, + "get": { + "summary": "List deployments with pagination and filtering", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "number", + "nullable": true, + "minimum": 0 + }, + "required": false, + "name": "skip", + "in": "query" + }, + { + "schema": { + "type": "number", + "minimum": 1, + "default": 1000 + }, + "required": false, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns paginated list of deployments", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "deployments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "status": { + "type": "object", + "nullable": true, + "properties": { + "forwarded_ports": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "port": { + "type": "number" + }, + "externalPort": { + "type": "number" + }, + "host": { + "type": "string" + }, + "available": { + "type": "number" + } + }, + "required": [ + "port", + "externalPort" + ] + } + } + }, + "ips": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "IP": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ExternalPort": { + "type": "number" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "IP", + "Port", + "ExternalPort", + "Protocol" + ] + } + } + }, + "services": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "available": { + "type": "number" + }, + "total": { + "type": "number" + }, + "uris": { + "type": "array", + "items": { + "type": "string" + } + }, + "observed_generation": { + "type": "number" + }, + "replicas": { + "type": "number" + }, + "updated_replicas": { + "type": "number" + }, + "ready_replicas": { + "type": "number" + }, + "available_replicas": { + "type": "number" + } + }, + "required": [ + "name", + "available", + "total", + "uris", + "observed_generation", + "replicas", + "updated_replicas", + "ready_replicas", + "available_replicas" + ] + } + } + }, + "required": [ + "forwarded_ports", + "ips", + "services" + ] + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on", + "status" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "leases", + "escrow_account" + ] + } + }, + "pagination": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "skip": { + "type": "number" + }, + "limit": { + "type": "number" + }, + "hasMore": { + "type": "boolean" + } + }, + "required": [ + "total", + "skip", + "limit", + "hasMore" + ] + } + }, + "required": [ + "deployments", + "pagination" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/deposit-deployment": { + "post": { + "summary": "Deposit into a deployment", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^d+$", + "description": "Deployment sequence number" + }, + "deposit": { + "type": "number", + "description": "Amount to deposit in dollars (e.g. 5.5)" + } + }, + "required": [ + "dseq", + "deposit" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Deposit successful", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "status": { + "type": "object", + "nullable": true, + "properties": { + "forwarded_ports": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "port": { + "type": "number" + }, + "externalPort": { + "type": "number" + }, + "host": { + "type": "string" + }, + "available": { + "type": "number" + } + }, + "required": [ + "port", + "externalPort" + ] + } + } + }, + "ips": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "IP": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ExternalPort": { + "type": "number" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "IP", + "Port", + "ExternalPort", + "Protocol" + ] + } + } + }, + "services": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "available": { + "type": "number" + }, + "total": { + "type": "number" + }, + "uris": { + "type": "array", + "items": { + "type": "string" + } + }, + "observed_generation": { + "type": "number" + }, + "replicas": { + "type": "number" + }, + "updated_replicas": { + "type": "number" + }, + "ready_replicas": { + "type": "number" + }, + "available_replicas": { + "type": "number" + } + }, + "required": [ + "name", + "available", + "total", + "uris", + "observed_generation", + "replicas", + "updated_replicas", + "ready_replicas", + "available_replicas" + ] + } + } + }, + "required": [ + "forwarded_ports", + "ips", + "services" + ] + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on", + "status" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "leases", + "escrow_account" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/addresses/{address}/deployments/{skip}/{limit}": { + "get": { + "summary": "Get a list of deployments by owner address.", + "tags": [ + "Addresses", + "Deployments" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Wallet Address", + "example": "akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm" + }, + "required": true, + "name": "address", + "in": "path" + }, + { + "schema": { + "type": "number", + "nullable": true, + "minimum": 0, + "description": "Deployments to skip", + "example": 10 + }, + "required": false, + "name": "skip", + "in": "path" + }, + { + "schema": { + "type": "number", + "minimum": 1, + "maximum": 100, + "description": "Deployments to return", + "example": 10 + }, + "required": true, + "name": "limit", + "in": "path" + }, + { + "schema": { + "type": "string", + "enum": [ + "active", + "closed" + ], + "description": "Filter by status", + "example": "closed" + }, + "required": false, + "name": "status", + "in": "query" + }, + { + "schema": { + "type": "string", + "description": "Reverse sorting", + "example": "true" + }, + "required": false, + "name": "reverseSorting", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns deployment list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "status": { + "type": "string" + }, + "createdHeight": { + "type": "number" + }, + "cpuUnits": { + "type": "number" + }, + "gpuUnits": { + "type": "number" + }, + "memoryQuantity": { + "type": "number" + }, + "storageQuantity": { + "type": "number" + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "provider": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "hostUri": { + "type": "string" + } + }, + "required": [ + "address", + "hostUri" + ] + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "id", + "owner", + "dseq", + "gseq", + "oseq", + "state", + "price" + ] + } + } + }, + "required": [ + "owner", + "dseq", + "status", + "createdHeight", + "cpuUnits", + "gpuUnits", + "memoryQuantity", + "storageQuantity", + "leases" + ] + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + }, + "400": { + "description": "Invalid address" + } + } + } + }, + "/v1/deployment/{owner}/{dseq}": { + "get": { + "summary": "Get deployment details", + "tags": [ + "Deployments" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Owner's Address", + "example": "akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm" + }, + "required": true, + "name": "owner", + "in": "path" + }, + { + "schema": { + "$ref": "#/components/schemas/Deployment DSEQ" + }, + "required": true, + "name": "dseq", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns deployment details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "balance": { + "type": "number" + }, + "denom": { + "type": "string" + }, + "status": { + "type": "string" + }, + "totalMonthlyCostUDenom": { + "type": "number" + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "object", + "nullable": true, + "properties": { + "address": { + "type": "string" + }, + "hostUri": { + "type": "string" + }, + "isDeleted": { + "type": "boolean" + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "address", + "hostUri", + "isDeleted", + "attributes" + ] + }, + "status": { + "type": "string" + }, + "monthlyCostUDenom": { + "type": "number" + }, + "cpuUnits": { + "type": "number" + }, + "gpuUnits": { + "type": "number" + }, + "memoryQuantity": { + "type": "number" + }, + "storageQuantity": { + "type": "number" + } + }, + "required": [ + "gseq", + "oseq", + "provider", + "status", + "monthlyCostUDenom", + "cpuUnits", + "gpuUnits", + "memoryQuantity", + "storageQuantity" + ] + } + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "date": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "txHash", + "date", + "type" + ] + } + }, + "other": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string" + }, + "gseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq" + ] + }, + "state": { + "type": "string" + }, + "group_spec": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "requirements": { + "type": "object", + "properties": { + "signed_by": { + "type": "object", + "properties": { + "all_of": { + "type": "array", + "items": { + "type": "string" + } + }, + "any_of": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "all_of", + "any_of" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "signed_by", + "attributes" + ] + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resource": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "cpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "memory": { + "type": "object", + "properties": { + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "quantity", + "attributes" + ] + }, + "storage": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "name", + "quantity", + "attributes" + ] + } + }, + "gpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "sequence_number": { + "type": "number" + } + }, + "required": [ + "kind", + "sequence_number" + ] + } + } + }, + "required": [ + "id", + "cpu", + "memory", + "storage", + "gpu", + "endpoints" + ] + }, + "count": { + "type": "number" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "resource", + "count", + "price" + ] + } + } + }, + "required": [ + "name", + "requirements", + "resources" + ] + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "group_spec", + "created_at" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "groups", + "escrow_account" + ] + } + }, + "required": [ + "owner", + "dseq", + "balance", + "denom", + "status", + "totalMonthlyCostUDenom", + "leases", + "events", + "other" + ] + } + } + } + }, + "400": { + "description": "Invalid address or dseq" + }, + "404": { + "description": "Deployment not found" + } + } + } + }, + "/akash/deployment/{version}/deployments/list": { + "get": { + "summary": "List deployments (database fallback)", + "tags": [ + "Deployments" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": false, + "name": "filters.owner", + "in": "query" + }, + { + "schema": { + "type": "string", + "enum": [ + "active", + "closed" + ] + }, + "required": false, + "name": "filters.state", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "pagination.offset", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "pagination.limit", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "pagination.key", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "pagination.count_total", + "in": "query" + }, + { + "schema": { + "type": "boolean", + "nullable": true + }, + "required": false, + "name": "pagination.reverse", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns paginated list of deployments from database", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "deployments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq" + ] + }, + "state": { + "type": "string" + }, + "group_spec": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "requirements": { + "type": "object", + "properties": { + "signed_by": { + "type": "object", + "properties": { + "all_of": { + "type": "array", + "items": { + "type": "string" + } + }, + "any_of": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "all_of", + "any_of" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "signed_by", + "attributes" + ] + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resource": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "cpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "memory": { + "type": "object", + "properties": { + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "quantity", + "attributes" + ] + }, + "storage": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "name", + "quantity", + "attributes" + ] + } + }, + "gpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "sequence_number": { + "type": "number" + } + }, + "required": [ + "kind", + "sequence_number" + ] + } + } + }, + "required": [ + "id", + "cpu", + "memory", + "storage", + "gpu", + "endpoints" + ] + }, + "count": { + "type": "number" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "resource", + "count", + "price" + ] + } + } + }, + "required": [ + "name", + "requirements", + "resources" + ] + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "group_spec", + "created_at" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "groups", + "escrow_account" + ] + } + }, + "pagination": { + "type": "object", + "properties": { + "next_key": { + "type": "string", + "nullable": true + }, + "total": { + "type": "string" + } + }, + "required": [ + "next_key", + "total" + ] + } + }, + "required": [ + "deployments", + "pagination" + ] + } + } + } + } + } + } + }, + "/akash/deployment/{version}/deployments/info": { + "get": { + "summary": "Get deployment info (database fallback)", + "tags": [ + "Deployments" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": true, + "name": "id.owner", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": true, + "name": "id.dseq", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns deployment info from database", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "code", + "message", + "details" + ] + }, + { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq" + ] + }, + "state": { + "type": "string" + }, + "group_spec": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "requirements": { + "type": "object", + "properties": { + "signed_by": { + "type": "object", + "properties": { + "all_of": { + "type": "array", + "items": { + "type": "string" + } + }, + "any_of": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "all_of", + "any_of" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "signed_by", + "attributes" + ] + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resource": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "cpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "memory": { + "type": "object", + "properties": { + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "quantity", + "attributes" + ] + }, + "storage": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "name", + "quantity", + "attributes" + ] + } + }, + "gpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "sequence_number": { + "type": "number" + } + }, + "required": [ + "kind", + "sequence_number" + ] + } + } + }, + "required": [ + "id", + "cpu", + "memory", + "storage", + "gpu", + "endpoints" + ] + }, + "count": { + "type": "number" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "resource", + "count", + "price" + ] + } + } + }, + "required": [ + "name", + "requirements", + "resources" + ] + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "group_spec", + "created_at" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "groups", + "escrow_account" + ] + } + ] + } + } + } + }, + "404": { + "description": "Deployment not found" + } + } + } + }, + "/v1/weekly-cost": { + "get": { + "summary": "Get weekly deployment cost", + "tags": [ + "Deployments" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Returns weekly cost for all deployments with auto top-up enabled", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "weeklyCost": { + "type": "number", + "description": "Total weekly cost in USD for all deployments with auto top-up enabled" + } + }, + "required": [ + "weeklyCost" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/leases": { + "post": { + "summary": "Create leases and send manifest", + "tags": [ + "Leases" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "manifest": { + "type": "string" + }, + "certificate": { + "type": "object", + "properties": { + "certPem": { + "type": "string" + }, + "keyPem": { + "type": "string" + } + }, + "required": [ + "certPem", + "keyPem" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + } + }, + "required": [ + "dseq", + "gseq", + "oseq", + "provider" + ] + } + } + }, + "required": [ + "manifest", + "leases" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Leases created and manifest sent", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "deployment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + } + }, + "required": [ + "owner", + "dseq" + ] + }, + "state": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "created_at": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "hash", + "created_at" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "status": { + "type": "object", + "nullable": true, + "properties": { + "forwarded_ports": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "port": { + "type": "number" + }, + "externalPort": { + "type": "number" + }, + "host": { + "type": "string" + }, + "available": { + "type": "number" + } + }, + "required": [ + "port", + "externalPort" + ] + } + } + }, + "ips": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "IP": { + "type": "string" + }, + "Port": { + "type": "number" + }, + "ExternalPort": { + "type": "number" + }, + "Protocol": { + "type": "string" + } + }, + "required": [ + "IP", + "Port", + "ExternalPort", + "Protocol" + ] + } + } + }, + "services": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "available": { + "type": "number" + }, + "total": { + "type": "number" + }, + "uris": { + "type": "array", + "items": { + "type": "string" + } + }, + "observed_generation": { + "type": "number" + }, + "replicas": { + "type": "number" + }, + "updated_replicas": { + "type": "number" + }, + "ready_replicas": { + "type": "number" + }, + "available_replicas": { + "type": "number" + } + }, + "required": [ + "name", + "available", + "total", + "uris", + "observed_generation", + "replicas", + "updated_replicas", + "ready_replicas", + "available_replicas" + ] + } + } + }, + "required": [ + "forwarded_ports", + "ips", + "services" + ] + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on", + "status" + ] + } + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "deployment", + "leases", + "escrow_account" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/akash/market/{version}/leases/list": { + "get": { + "summary": "List leases (database fallback)", + "tags": [ + "Leases" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": false, + "name": "filters.owner", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "filters.dseq", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "filters.gseq", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "filters.oseq", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "filters.provider", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "filters.state", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "pagination.offset", + "in": "query" + }, + { + "schema": { + "type": "number", + "nullable": true + }, + "required": false, + "name": "pagination.limit", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "pagination.key", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "pagination.count_total", + "in": "query" + }, + { + "schema": { + "type": "boolean", + "nullable": true + }, + "required": false, + "name": "pagination.reverse", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns paginated list of leases from database", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "lease": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "closed_on": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "closed_on" + ] + }, + "escrow_payment": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "aid": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "xid": { + "type": "string" + } + }, + "required": [ + "aid", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "rate": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "unsettled": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "withdrawn": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "state", + "rate", + "balance", + "unsettled", + "withdrawn" + ] + } + }, + "required": [ + "id", + "state" + ] + } + }, + "required": [ + "lease", + "escrow_payment" + ] + } + }, + "pagination": { + "type": "object", + "properties": { + "next_key": { + "type": "string", + "nullable": true + }, + "total": { + "type": "string" + } + }, + "required": [ + "next_key", + "total" + ] + } + }, + "required": [ + "leases", + "pagination" + ] + } + } + } + } + } + } + }, + "/v1/api-keys": { + "get": { + "summary": "List all API keys", + "tags": [ + "API Keys" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Returns list of API keys", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "lastUsedAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "keyFormat": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "expiresAt", + "createdAt", + "updatedAt", + "lastUsedAt", + "keyFormat" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + }, + "post": { + "summary": "Create new API key", + "tags": [ + "API Keys" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "201": { + "description": "API key created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "lastUsedAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "keyFormat": { + "type": "string" + }, + "apiKey": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "expiresAt", + "createdAt", + "updatedAt", + "lastUsedAt", + "keyFormat", + "apiKey" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/api-keys/{id}": { + "get": { + "summary": "Get API key by ID", + "tags": [ + "API Keys" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "required": true, + "name": "id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns API key details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "lastUsedAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "keyFormat": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "expiresAt", + "createdAt", + "updatedAt", + "lastUsedAt", + "keyFormat" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "API key not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + } + } + }, + "patch": { + "summary": "Update API key", + "tags": [ + "API Keys" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "required": true, + "name": "id", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "200": { + "description": "API key updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "lastUsedAt": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "keyFormat": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "expiresAt", + "createdAt", + "updatedAt", + "lastUsedAt", + "keyFormat" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "API key not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + } + } + }, + "delete": { + "summary": "Delete API key", + "tags": [ + "API Keys" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "required": true, + "name": "id", + "in": "path" + } + ], + "responses": { + "204": { + "description": "API key deleted successfully" + }, + "404": { + "description": "API key not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + } + } + } + }, + "/v1/bids": { + "get": { + "summary": "List bids", + "tags": [ + "Bids" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "^d+$" + }, + "required": true, + "name": "dseq", + "in": "query" + } + ], + "responses": { + "200": { + "description": "List of bids", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bid": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "resources_offer": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "cpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "gpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "memory": { + "type": "object", + "properties": { + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "quantity", + "attributes" + ] + }, + "storage": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "name", + "quantity", + "attributes" + ] + } + }, + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "sequence_number": { + "type": "number" + } + }, + "required": [ + "kind", + "sequence_number" + ] + } + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage", + "endpoints" + ] + }, + "count": { + "type": "number" + } + }, + "required": [ + "resources", + "count" + ] + } + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "resources_offer" + ] + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + }, + "isCertificateRequired": { + "type": "boolean" + } + }, + "required": [ + "bid", + "escrow_account", + "isCertificateRequired" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/bids/{dseq}": { + "get": { + "summary": "List bids by dseq", + "tags": [ + "Bids" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "^d+$" + }, + "required": true, + "name": "dseq", + "in": "path" + } + ], + "responses": { + "200": { + "description": "List of bids", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bid": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "bseq": { + "type": "number" + } + }, + "required": [ + "owner", + "dseq", + "gseq", + "oseq", + "provider", + "bseq" + ] + }, + "state": { + "type": "string" + }, + "price": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + }, + "created_at": { + "type": "string" + }, + "resources_offer": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "cpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "gpu": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "units", + "attributes" + ] + }, + "memory": { + "type": "object", + "properties": { + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "quantity", + "attributes" + ] + }, + "storage": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "quantity": { + "type": "object", + "properties": { + "val": { + "type": "string" + } + }, + "required": [ + "val" + ] + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + } + }, + "required": [ + "name", + "quantity", + "attributes" + ] + } + }, + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "sequence_number": { + "type": "number" + } + }, + "required": [ + "kind", + "sequence_number" + ] + } + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage", + "endpoints" + ] + }, + "count": { + "type": "number" + } + }, + "required": [ + "resources", + "count" + ] + } + } + }, + "required": [ + "id", + "state", + "price", + "created_at", + "resources_offer" + ] + }, + "escrow_account": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "scope": { + "type": "string" + }, + "xid": { + "type": "string" + } + }, + "required": [ + "scope", + "xid" + ] + }, + "state": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "state": { + "type": "string" + }, + "transferred": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "settled_at": { + "type": "string" + }, + "funds": { + "type": "array", + "items": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "deposits": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "height": { + "type": "string" + }, + "source": { + "type": "string" + }, + "balance": { + "type": "object", + "properties": { + "denom": { + "type": "string" + }, + "amount": { + "type": "string" + } + }, + "required": [ + "denom", + "amount" + ] + } + }, + "required": [ + "owner", + "height", + "source", + "balance" + ] + } + } + }, + "required": [ + "owner", + "state", + "transferred", + "settled_at", + "funds", + "deposits" + ] + } + }, + "required": [ + "id", + "state" + ] + }, + "isCertificateRequired": { + "type": "boolean" + } + }, + "required": [ + "bid", + "escrow_account", + "isCertificateRequired" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/certificates": { + "post": { + "summary": "Create certificate", + "tags": [ + "Certificate" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "responses": { + "200": { + "description": "Certificate created", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "certPem": { + "type": "string", + "minLength": 1 + }, + "pubkeyPem": { + "type": "string", + "minLength": 1 + }, + "encryptedKey": { + "type": "string", + "minLength": 1 + } + }, + "required": [ + "certPem", + "pubkeyPem", + "encryptedKey" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/balances": { + "get": { + "summary": "Get user balances", + "tags": [ + "Wallet" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Optional wallet address to fetch balances for instead of the current user" + }, + "required": false, + "description": "Optional wallet address to fetch balances for instead of the current user", + "name": "address", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns user balances", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "balance": { + "type": "number" + }, + "deployments": { + "type": "number" + }, + "total": { + "type": "number" + } + }, + "required": [ + "balance", + "deployments", + "total" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/providers": { + "get": { + "summary": "Get a list of providers.", + "tags": [ + "Providers" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "enum": [ + "all", + "trial" + ], + "default": "all" + }, + "required": false, + "name": "scope", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns a list of providers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "name": { + "type": "string", + "nullable": true + }, + "hostUri": { + "type": "string" + }, + "createdHeight": { + "type": "number" + }, + "email": { + "type": "string", + "nullable": true + }, + "website": { + "type": "string", + "nullable": true + }, + "lastCheckDate": { + "type": "string", + "nullable": true + }, + "deploymentCount": { + "type": "number", + "nullable": true + }, + "leaseCount": { + "type": "number", + "nullable": true + }, + "cosmosSdkVersion": { + "type": "string" + }, + "akashVersion": { + "type": "string" + }, + "ipRegion": { + "type": "string", + "nullable": true + }, + "ipRegionCode": { + "type": "string", + "nullable": true + }, + "ipCountry": { + "type": "string", + "nullable": true + }, + "ipCountryCode": { + "type": "string", + "nullable": true + }, + "ipLat": { + "type": "string", + "nullable": true + }, + "ipLon": { + "type": "string", + "nullable": true + }, + "uptime1d": { + "type": "number", + "nullable": true + }, + "uptime7d": { + "type": "number", + "nullable": true + }, + "uptime30d": { + "type": "number", + "nullable": true + }, + "isValidVersion": { + "type": "boolean" + }, + "isOnline": { + "type": "boolean" + }, + "lastOnlineDate": { + "type": "string", + "nullable": true + }, + "isAudited": { + "type": "boolean" + }, + "activeStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "pendingStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "availableStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "gpuModels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vendor": { + "type": "string" + }, + "model": { + "type": "string" + }, + "ram": { + "type": "string" + }, + "interface": { + "type": "string" + } + }, + "required": [ + "vendor", + "model", + "ram", + "interface" + ] + } + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + }, + "auditedBy": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "auditedBy" + ] + } + }, + "host": { + "type": "string", + "nullable": true + }, + "organization": { + "type": "string", + "nullable": true + }, + "statusPage": { + "type": "string", + "nullable": true + }, + "locationRegion": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "city": { + "type": "string", + "nullable": true + }, + "timezone": { + "type": "string", + "nullable": true + }, + "locationType": { + "type": "string", + "nullable": true + }, + "hostingProvider": { + "type": "string", + "nullable": true + }, + "hardwareCpu": { + "type": "string", + "nullable": true + }, + "hardwareCpuArch": { + "type": "string", + "nullable": true + }, + "hardwareGpuVendor": { + "type": "string", + "nullable": true + }, + "hardwareGpuModels": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + }, + "hardwareDisk": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + }, + "featPersistentStorage": { + "type": "boolean" + }, + "featPersistentStorageType": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + }, + "hardwareMemory": { + "type": "string", + "nullable": true + }, + "networkProvider": { + "type": "string", + "nullable": true + }, + "networkSpeedDown": { + "type": "number" + }, + "networkSpeedUp": { + "type": "number" + }, + "tier": { + "type": "string", + "nullable": true + }, + "featEndpointCustomDomain": { + "type": "boolean" + }, + "workloadSupportChia": { + "type": "boolean" + }, + "workloadSupportChiaCapabilities": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + }, + "featEndpointIp": { + "type": "boolean" + } + }, + "required": [ + "owner", + "name", + "hostUri", + "createdHeight", + "cosmosSdkVersion", + "akashVersion", + "ipRegion", + "ipRegionCode", + "ipCountry", + "ipCountryCode", + "ipLat", + "ipLon", + "uptime1d", + "uptime7d", + "uptime30d", + "isValidVersion", + "isOnline", + "lastOnlineDate", + "isAudited", + "activeStats", + "pendingStats", + "availableStats", + "gpuModels", + "attributes", + "host", + "organization", + "statusPage", + "locationRegion", + "country", + "city", + "timezone", + "locationType", + "hostingProvider", + "hardwareCpu", + "hardwareCpuArch", + "hardwareGpuVendor", + "hardwareGpuModels", + "hardwareDisk", + "featPersistentStorage", + "featPersistentStorageType", + "hardwareMemory", + "networkProvider", + "networkSpeedDown", + "networkSpeedUp", + "tier", + "featEndpointCustomDomain", + "workloadSupportChia", + "workloadSupportChiaCapabilities", + "featEndpointIp" + ] + } + } + } + } + } + } + } + }, + "/v1/providers/{address}": { + "get": { + "summary": "Get a provider details.", + "tags": [ + "Providers" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Provider Address", + "example": "akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc" + }, + "required": true, + "name": "address", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Return a provider details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "name": { + "type": "string" + }, + "hostUri": { + "type": "string" + }, + "createdHeight": { + "type": "number" + }, + "email": { + "type": "string", + "nullable": true + }, + "website": { + "type": "string", + "nullable": true + }, + "lastCheckDate": { + "type": "string", + "nullable": true + }, + "deploymentCount": { + "type": "number" + }, + "leaseCount": { + "type": "number" + }, + "cosmosSdkVersion": { + "type": "string" + }, + "akashVersion": { + "type": "string" + }, + "ipRegion": { + "type": "string", + "nullable": true + }, + "ipRegionCode": { + "type": "string", + "nullable": true + }, + "ipCountry": { + "type": "string", + "nullable": true + }, + "ipCountryCode": { + "type": "string", + "nullable": true + }, + "ipLat": { + "type": "string", + "nullable": true + }, + "ipLon": { + "type": "string", + "nullable": true + }, + "uptime1d": { + "type": "number" + }, + "uptime7d": { + "type": "number" + }, + "uptime30d": { + "type": "number" + }, + "isValidVersion": { + "type": "boolean" + }, + "isOnline": { + "type": "boolean" + }, + "lastOnlineDate": { + "type": "string", + "nullable": true + }, + "isAudited": { + "type": "boolean" + }, + "stats": { + "type": "object", + "properties": { + "cpu": { + "type": "object", + "properties": { + "active": { + "type": "number" + }, + "available": { + "type": "number" + }, + "pending": { + "type": "number" + } + }, + "required": [ + "active", + "available", + "pending" + ] + }, + "gpu": { + "type": "object", + "properties": { + "active": { + "type": "number" + }, + "available": { + "type": "number" + }, + "pending": { + "type": "number" + } + }, + "required": [ + "active", + "available", + "pending" + ] + }, + "memory": { + "type": "object", + "properties": { + "active": { + "type": "number" + }, + "available": { + "type": "number" + }, + "pending": { + "type": "number" + } + }, + "required": [ + "active", + "available", + "pending" + ] + }, + "storage": { + "type": "object", + "properties": { + "ephemeral": { + "type": "object", + "properties": { + "active": { + "type": "number" + }, + "available": { + "type": "number" + }, + "pending": { + "type": "number" + } + }, + "required": [ + "active", + "available", + "pending" + ] + }, + "persistent": { + "type": "object", + "properties": { + "active": { + "type": "number" + }, + "available": { + "type": "number" + }, + "pending": { + "type": "number" + } + }, + "required": [ + "active", + "available", + "pending" + ] + } + }, + "required": [ + "ephemeral", + "persistent" + ] + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "activeStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "pendingStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "availableStats": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "gpuModels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vendor": { + "type": "string" + }, + "model": { + "type": "string" + }, + "ram": { + "type": "string" + }, + "interface": { + "type": "string" + } + }, + "required": [ + "vendor", + "model", + "ram", + "interface" + ] + } + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + }, + "auditedBy": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "auditedBy" + ] + } + }, + "host": { + "type": "string", + "nullable": true + }, + "organization": { + "type": "string", + "nullable": true + }, + "statusPage": { + "type": "string", + "nullable": true + }, + "locationRegion": { + "type": "string", + "nullable": true + }, + "country": { + "type": "string", + "nullable": true + }, + "city": { + "type": "string", + "nullable": true + }, + "timezone": { + "type": "string", + "nullable": true + }, + "locationType": { + "type": "string", + "nullable": true + }, + "hostingProvider": { + "type": "string", + "nullable": true + }, + "hardwareCpu": { + "type": "string", + "nullable": true + }, + "hardwareCpuArch": { + "type": "string", + "nullable": true + }, + "hardwareGpuVendor": { + "type": "string", + "nullable": true + }, + "hardwareGpuModels": { + "type": "array", + "items": { + "type": "string" + } + }, + "hardwareDisk": { + "type": "array", + "items": { + "type": "string" + } + }, + "featPersistentStorage": { + "type": "boolean" + }, + "featPersistentStorageType": { + "type": "array", + "items": { + "type": "string" + } + }, + "hardwareMemory": { + "type": "string", + "nullable": true + }, + "networkProvider": { + "type": "string", + "nullable": true + }, + "networkSpeedDown": { + "type": "number" + }, + "networkSpeedUp": { + "type": "number" + }, + "tier": { + "type": "string", + "nullable": true + }, + "featEndpointCustomDomain": { + "type": "boolean" + }, + "workloadSupportChia": { + "type": "boolean" + }, + "workloadSupportChiaCapabilities": { + "type": "array", + "items": { + "type": "string" + } + }, + "featEndpointIp": { + "type": "boolean" + }, + "uptime": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "isOnline": { + "type": "boolean" + }, + "checkDate": { + "type": "string" + } + }, + "required": [ + "id", + "isOnline", + "checkDate" + ] + } + } + }, + "required": [ + "owner", + "name", + "hostUri", + "createdHeight", + "email", + "website", + "lastCheckDate", + "deploymentCount", + "leaseCount", + "cosmosSdkVersion", + "akashVersion", + "ipRegion", + "ipRegionCode", + "ipCountry", + "ipCountryCode", + "ipLat", + "ipLon", + "uptime1d", + "uptime7d", + "uptime30d", + "isValidVersion", + "isOnline", + "lastOnlineDate", + "isAudited", + "stats", + "activeStats", + "pendingStats", + "availableStats", + "gpuModels", + "attributes", + "host", + "organization", + "statusPage", + "locationRegion", + "country", + "city", + "timezone", + "locationType", + "hostingProvider", + "hardwareCpu", + "hardwareCpuArch", + "hardwareGpuVendor", + "hardwareGpuModels", + "hardwareDisk", + "featPersistentStorage", + "featPersistentStorageType", + "hardwareMemory", + "networkProvider", + "networkSpeedDown", + "networkSpeedUp", + "tier", + "featEndpointCustomDomain", + "workloadSupportChia", + "workloadSupportChiaCapabilities", + "featEndpointIp", + "uptime" + ] + } + } + } + }, + "400": { + "description": "Invalid address" + }, + "404": { + "description": "Provider not found" + } + } + } + }, + "/v1/providers/{providerAddress}/active-leases-graph-data": { + "get": { + "tags": [ + "Analytics", + "Providers" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "example": "akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc" + }, + "required": true, + "name": "providerAddress", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns a provider's active leases graph data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "currentValue": { + "type": "number" + }, + "compareValue": { + "type": "number" + }, + "snapshots": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "example": "2021-07-01T00:00:00.000Z" + }, + "value": { + "type": "number", + "example": 100 + } + }, + "required": [ + "date", + "value" + ] + } + }, + "now": { + "type": "object", + "properties": { + "count": { + "type": "number", + "example": 100 + } + }, + "required": [ + "count" + ] + }, + "compare": { + "type": "object", + "properties": { + "count": { + "type": "number", + "example": 100 + } + }, + "required": [ + "count" + ] + } + }, + "required": [ + "currentValue", + "compareValue", + "snapshots", + "now", + "compare" + ] + } + } + } + }, + "400": { + "description": "Invalid address" + } + } + } + }, + "/v1/auditors": { + "get": { + "tags": [ + "Providers" + ], + "security": [], + "summary": "Get a list of auditors.", + "responses": { + "200": { + "description": "List of auditors", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "address": { + "type": "string" + }, + "website": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "address", + "website" + ] + } + } + } + } + } + } + } + }, + "/v1/provider-attributes-schema": { + "get": { + "summary": "Get the provider attributes schema", + "tags": [ + "Providers" + ], + "security": [], + "responses": { + "200": { + "description": "Return the provider attributes schema", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "host": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "email": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "organization": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "website": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "tier": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "status-page": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "location-region": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "country": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "city": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "timezone": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "location-type": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hosting-provider": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-cpu": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-cpu-arch": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-gpu": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-gpu-model": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-disk": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "hardware-memory": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "network-provider": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "network-speed-up": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "network-speed-down": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "feat-persistent-storage": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "feat-persistent-storage-type": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "workload-support-chia": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "workload-support-chia-capabilities": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "feat-endpoint-ip": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + }, + "feat-endpoint-custom-domain": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "string", + "number", + "boolean", + "option", + "multiple-option" + ] + }, + "required": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "values": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "key", + "description" + ] + } + } + }, + "required": [ + "key", + "type", + "required", + "description" + ] + } + }, + "required": [ + "host", + "email", + "organization", + "website", + "tier", + "status-page", + "location-region", + "country", + "city", + "timezone", + "location-type", + "hosting-provider", + "hardware-cpu", + "hardware-cpu-arch", + "hardware-gpu", + "hardware-gpu-model", + "hardware-disk", + "hardware-memory", + "network-provider", + "network-speed-up", + "network-speed-down", + "feat-persistent-storage", + "feat-persistent-storage-type", + "workload-support-chia", + "workload-support-chia-capabilities", + "feat-endpoint-ip", + "feat-endpoint-custom-domain" + ] + } + } + } + } + } + } + }, + "/v1/provider-regions": { + "get": { + "summary": "Get a list of provider regions", + "tags": [ + "Providers" + ], + "security": [], + "responses": { + "200": { + "description": "Return a list of provider regions", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "providers": { + "type": "array", + "items": { + "type": "string" + } + }, + "key": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "providers", + "key", + "description" + ] + } + } + } + } + } + } + } + }, + "/v1/provider-dashboard/{owner}": { + "get": { + "summary": "Get dashboard data for provider console.", + "tags": [ + "Providers" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "example": "akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc" + }, + "required": true, + "name": "owner", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Dashboard data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "current": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "height": { + "type": "number" + }, + "activeLeaseCount": { + "type": "number" + }, + "totalLeaseCount": { + "type": "number" + }, + "dailyLeaseCount": { + "type": "number" + }, + "totalUAktEarned": { + "type": "number" + }, + "dailyUAktEarned": { + "type": "number" + }, + "totalUUsdcEarned": { + "type": "number" + }, + "dailyUUsdcEarned": { + "type": "number" + }, + "totalUUsdEarned": { + "type": "number" + }, + "dailyUUsdEarned": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeEphemeralStorage": { + "type": "number" + }, + "activePersistentStorage": { + "type": "number" + }, + "activeStorage": { + "type": "number" + } + }, + "required": [ + "date", + "height", + "activeLeaseCount", + "totalLeaseCount", + "dailyLeaseCount", + "totalUAktEarned", + "dailyUAktEarned", + "totalUUsdcEarned", + "dailyUUsdcEarned", + "totalUUsdEarned", + "dailyUUsdEarned", + "activeCPU", + "activeGPU", + "activeMemory", + "activeEphemeralStorage", + "activePersistentStorage", + "activeStorage" + ] + }, + "previous": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "height": { + "type": "number" + }, + "activeLeaseCount": { + "type": "number" + }, + "totalLeaseCount": { + "type": "number" + }, + "dailyLeaseCount": { + "type": "number" + }, + "totalUAktEarned": { + "type": "number" + }, + "dailyUAktEarned": { + "type": "number" + }, + "totalUUsdcEarned": { + "type": "number" + }, + "dailyUUsdcEarned": { + "type": "number" + }, + "totalUUsdEarned": { + "type": "number" + }, + "dailyUUsdEarned": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeEphemeralStorage": { + "type": "number" + }, + "activePersistentStorage": { + "type": "number" + }, + "activeStorage": { + "type": "number" + } + }, + "required": [ + "date", + "height", + "activeLeaseCount", + "totalLeaseCount", + "dailyLeaseCount", + "totalUAktEarned", + "dailyUAktEarned", + "totalUUsdcEarned", + "dailyUUsdcEarned", + "totalUUsdEarned", + "dailyUUsdEarned", + "activeCPU", + "activeGPU", + "activeMemory", + "activeEphemeralStorage", + "activePersistentStorage", + "activeStorage" + ] + } + }, + "required": [ + "current", + "previous" + ] + } + } + } + }, + "404": { + "description": "Provider not found" + } + } + } + }, + "/v1/provider-earnings/{owner}": { + "get": { + "summary": "Get earnings data for provider console.", + "tags": [ + "Providers" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Provider Address", + "example": "akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc" + }, + "required": true, + "name": "owner", + "in": "path" + }, + { + "schema": { + "type": "string", + "format": "YYYY-MM-DD", + "description": "Start date in YYYY-MM-DD format", + "example": "2023-01-01" + }, + "required": true, + "name": "from", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "YYYY-MM-DD", + "description": "End date in YYYY-MM-DD format", + "example": "2023-02-01" + }, + "required": true, + "name": "to", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Earnings data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "earnings": { + "type": "object", + "properties": { + "totalUAktEarned": { + "type": "number" + }, + "totalUUsdcEarned": { + "type": "number" + }, + "totalUUsdEarned": { + "type": "number" + } + }, + "required": [ + "totalUAktEarned", + "totalUUsdcEarned", + "totalUUsdEarned" + ] + } + }, + "required": [ + "earnings" + ] + } + } + } + }, + "404": { + "description": "Provider not found" + } + } + } + }, + "/v1/provider-versions": { + "get": { + "summary": "Get providers grouped by version.", + "tags": [ + "Providers" + ], + "security": [], + "responses": { + "200": { + "description": "List of providers grouped by version.", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "count": { + "type": "number" + }, + "ratio": { + "type": "number" + }, + "providers": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "version", + "count", + "ratio", + "providers" + ] + } + } + } + } + } + } + } + }, + "/v1/provider-graph-data/{dataName}": { + "get": { + "tags": [ + "Analytics" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "example": "cpu", + "enum": [ + "count", + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "required": true, + "name": "dataName", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns provider graph data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "currentValue": { + "type": "number" + }, + "compareValue": { + "type": "number" + }, + "snapshots": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "example": "2021-07-01T00:00:00.000Z" + }, + "value": { + "type": "number", + "example": 100 + } + }, + "required": [ + "date", + "value" + ] + } + }, + "now": { + "type": "object", + "properties": { + "count": { + "type": "number", + "example": 100 + }, + "cpu": { + "type": "number", + "example": 100 + }, + "gpu": { + "type": "number", + "example": 100 + }, + "memory": { + "type": "number", + "example": 100 + }, + "storage": { + "type": "number", + "example": 100 + } + }, + "required": [ + "count", + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "compare": { + "type": "object", + "properties": { + "count": { + "type": "number", + "example": 100 + }, + "cpu": { + "type": "number", + "example": 100 + }, + "gpu": { + "type": "number", + "example": 100 + }, + "memory": { + "type": "number", + "example": 100 + }, + "storage": { + "type": "number", + "example": 100 + } + }, + "required": [ + "count", + "cpu", + "gpu", + "memory", + "storage" + ] + } + }, + "required": [ + "currentValue", + "compareValue", + "snapshots" + ] + } + } + } + }, + "404": { + "description": "Graph data not found" + } + } + } + }, + "/v1/providers/{provider}/deployments/{skip}/{limit}": { + "get": { + "summary": "Get a list of deployments for a provider.", + "tags": [ + "Providers", + "Deployments" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Provider Address", + "example": "akash18ga02jzaq8cw52anyhzkwta5wygufgu6zsz6xc" + }, + "required": true, + "name": "provider", + "in": "path" + }, + { + "schema": { + "type": "number", + "nullable": true, + "minimum": 0, + "description": "Deployments to skip", + "example": 10 + }, + "required": false, + "name": "skip", + "in": "path" + }, + { + "schema": { + "type": "number", + "minimum": 1, + "maximum": 100, + "description": "Deployments to return", + "example": 10 + }, + "required": true, + "name": "limit", + "in": "path" + }, + { + "schema": { + "type": "string", + "enum": [ + "active", + "closed" + ], + "description": "Filter by status", + "example": "closed" + }, + "required": false, + "name": "status", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns deployment list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "deployments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "denom": { + "type": "string" + }, + "createdHeight": { + "type": "number" + }, + "createdDate": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "balance": { + "type": "number" + }, + "transferred": { + "type": "number" + }, + "settledAt": { + "type": "number", + "nullable": true + }, + "resources": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "ephemeralStorage": { + "type": "number" + }, + "persistentStorage": { + "type": "number" + } + }, + "required": [ + "cpu", + "memory", + "gpu", + "ephemeralStorage", + "persistentStorage" + ] + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "provider": { + "type": "string" + }, + "gseq": { + "type": "number" + }, + "oseq": { + "type": "number" + }, + "price": { + "type": "number" + }, + "createdHeight": { + "type": "number" + }, + "createdDate": { + "type": "string", + "nullable": true + }, + "closedHeight": { + "type": "number", + "nullable": true + }, + "closedDate": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "resources": { + "type": "object", + "properties": { + "cpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "ephemeralStorage": { + "type": "number" + }, + "persistentStorage": { + "type": "number" + } + }, + "required": [ + "cpu", + "memory", + "gpu", + "ephemeralStorage", + "persistentStorage" + ] + } + }, + "required": [ + "provider", + "gseq", + "oseq", + "price", + "createdHeight", + "createdDate", + "closedHeight", + "closedDate", + "status", + "resources" + ] + } + } + }, + "required": [ + "owner", + "dseq", + "denom", + "createdHeight", + "createdDate", + "status", + "balance", + "transferred", + "settledAt", + "resources", + "leases" + ] + } + } + }, + "required": [ + "total", + "deployments" + ] + } + } + } + }, + "400": { + "description": "Invalid status filter" + } + } + } + }, + "/v1/create-jwt-token": { + "post": { + "summary": "Create new JWT token for managed wallet", + "tags": [ + "JWT Token" + ], + "security": [ + { + "BearerAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "leases": { + "type": "object", + "additionalProperties": { + "nullable": true + } + } + }, + "required": [ + "ttl", + "leases" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "responses": { + "201": { + "description": "JWT token created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "token": { + "type": "string" + } + }, + "required": [ + "token" + ] + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/graph-data/{dataName}": { + "get": { + "tags": [ + "Analytics" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "example": "dailyUAktSpent", + "enum": [ + "dailyUAktSpent", + "dailyUUsdcSpent", + "dailyUUsdSpent", + "dailyLeaseCount", + "totalUAktSpent", + "totalUUsdcSpent", + "totalUUsdSpent", + "activeLeaseCount", + "totalLeaseCount", + "activeCPU", + "activeGPU", + "activeMemory", + "activeStorage", + "gpuUtilization" + ] + }, + "required": true, + "name": "dataName", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns graph data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "currentValue": { + "type": "number" + }, + "compareValue": { + "type": "number" + }, + "snapshots": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "example": "2021-07-01T00:00:00.000Z" + }, + "value": { + "type": "number", + "example": 100 + } + }, + "required": [ + "date", + "value" + ] + } + } + }, + "required": [ + "currentValue", + "compareValue", + "snapshots" + ] + } + } + } + }, + "404": { + "description": "Graph data not found" + } + } + } + }, + "/v1/dashboard-data": { + "get": { + "tags": [ + "Analytics" + ], + "security": [], + "responses": { + "200": { + "description": "Returns dashboard data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "chainStats": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "transactionCount": { + "type": "number" + }, + "bondedTokens": { + "type": "number" + }, + "totalSupply": { + "type": "number" + }, + "communityPool": { + "type": "number" + }, + "inflation": { + "type": "number" + }, + "stakingAPR": { + "type": "number" + } + }, + "required": [ + "height", + "transactionCount", + "bondedTokens", + "totalSupply", + "communityPool", + "inflation" + ] + }, + "now": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "height": { + "type": "number" + }, + "activeLeaseCount": { + "type": "number" + }, + "totalLeaseCount": { + "type": "number" + }, + "dailyLeaseCount": { + "type": "number" + }, + "totalUAktSpent": { + "type": "number" + }, + "dailyUAktSpent": { + "type": "number" + }, + "totalUUsdcSpent": { + "type": "number" + }, + "dailyUUsdcSpent": { + "type": "number" + }, + "totalUUsdSpent": { + "type": "number" + }, + "dailyUUsdSpent": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeStorage": { + "type": "number" + } + }, + "required": [ + "date", + "height", + "activeLeaseCount", + "totalLeaseCount", + "dailyLeaseCount", + "totalUAktSpent", + "dailyUAktSpent", + "totalUUsdcSpent", + "dailyUUsdcSpent", + "totalUUsdSpent", + "dailyUUsdSpent", + "activeCPU", + "activeGPU", + "activeMemory", + "activeStorage" + ] + }, + "compare": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "height": { + "type": "number" + }, + "activeLeaseCount": { + "type": "number" + }, + "totalLeaseCount": { + "type": "number" + }, + "dailyLeaseCount": { + "type": "number" + }, + "totalUAktSpent": { + "type": "number" + }, + "dailyUAktSpent": { + "type": "number" + }, + "totalUUsdcSpent": { + "type": "number" + }, + "dailyUUsdcSpent": { + "type": "number" + }, + "totalUUsdSpent": { + "type": "number" + }, + "dailyUUsdSpent": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeStorage": { + "type": "number" + } + }, + "required": [ + "date", + "height", + "activeLeaseCount", + "totalLeaseCount", + "dailyLeaseCount", + "totalUAktSpent", + "dailyUAktSpent", + "totalUUsdcSpent", + "dailyUUsdcSpent", + "totalUUsdSpent", + "dailyUUsdSpent", + "activeCPU", + "activeGPU", + "activeMemory", + "activeStorage" + ] + }, + "networkCapacity": { + "type": "object", + "properties": { + "activeProviderCount": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeStorage": { + "type": "number" + }, + "pendingCPU": { + "type": "number" + }, + "pendingGPU": { + "type": "number" + }, + "pendingMemory": { + "type": "number" + }, + "pendingStorage": { + "type": "number" + }, + "availableCPU": { + "type": "number" + }, + "availableGPU": { + "type": "number" + }, + "availableMemory": { + "type": "number" + }, + "availableStorage": { + "type": "number" + }, + "totalCPU": { + "type": "number" + }, + "totalGPU": { + "type": "number" + }, + "totalMemory": { + "type": "number" + }, + "totalStorage": { + "type": "number" + }, + "activeEphemeralStorage": { + "type": "number" + }, + "pendingEphemeralStorage": { + "type": "number" + }, + "availableEphemeralStorage": { + "type": "number" + }, + "activePersistentStorage": { + "type": "number" + }, + "pendingPersistentStorage": { + "type": "number" + }, + "availablePersistentStorage": { + "type": "number" + } + }, + "required": [ + "activeProviderCount", + "activeCPU", + "activeGPU", + "activeMemory", + "activeStorage", + "pendingCPU", + "pendingGPU", + "pendingMemory", + "pendingStorage", + "availableCPU", + "availableGPU", + "availableMemory", + "availableStorage", + "totalCPU", + "totalGPU", + "totalMemory", + "totalStorage", + "activeEphemeralStorage", + "pendingEphemeralStorage", + "availableEphemeralStorage", + "activePersistentStorage", + "pendingPersistentStorage", + "availablePersistentStorage" + ] + }, + "networkCapacityStats": { + "type": "object", + "properties": { + "currentValue": { + "type": "number" + }, + "compareValue": { + "type": "number" + }, + "snapshots": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "value": { + "type": "number" + } + }, + "required": [ + "date", + "value" + ] + } + }, + "now": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "count", + "cpu", + "gpu", + "memory", + "storage" + ] + }, + "compare": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "cpu": { + "type": "number" + }, + "gpu": { + "type": "number" + }, + "memory": { + "type": "number" + }, + "storage": { + "type": "number" + } + }, + "required": [ + "count", + "cpu", + "gpu", + "memory", + "storage" + ] + } + }, + "required": [ + "currentValue", + "compareValue", + "snapshots", + "now", + "compare" + ] + }, + "latestBlocks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "proposer": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "operatorAddress": { + "type": "string" + }, + "moniker": { + "type": "string", + "nullable": true + }, + "avatarUrl": { + "type": "string", + "nullable": true + } + }, + "required": [ + "address", + "operatorAddress", + "moniker", + "avatarUrl" + ] + }, + "transactionCount": { + "type": "number" + }, + "totalTransactionCount": { + "type": "number" + }, + "datetime": { + "type": "string" + } + }, + "required": [ + "height", + "proposer", + "transactionCount", + "totalTransactionCount", + "datetime" + ] + } + }, + "latestTransactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "error": { + "type": "string", + "nullable": true + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "memo": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "amount": { + "type": "number" + } + }, + "required": [ + "id", + "type", + "amount" + ] + } + } + }, + "required": [ + "height", + "datetime", + "hash", + "isSuccess", + "error", + "gasUsed", + "gasWanted", + "fee", + "memo", + "messages" + ] + } + } + }, + "required": [ + "chainStats", + "now", + "compare", + "networkCapacity", + "networkCapacityStats", + "latestBlocks", + "latestTransactions" + ] + } + } + } + } + } + } + }, + "/v1/network-capacity": { + "get": { + "tags": [ + "Analytics" + ], + "security": [], + "responses": { + "200": { + "description": "Returns network capacity stats", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "activeProviderCount": { + "type": "number" + }, + "activeCPU": { + "type": "number" + }, + "activeGPU": { + "type": "number" + }, + "activeMemory": { + "type": "number" + }, + "activeStorage": { + "type": "number" + }, + "pendingCPU": { + "type": "number" + }, + "pendingGPU": { + "type": "number" + }, + "pendingMemory": { + "type": "number" + }, + "pendingStorage": { + "type": "number" + }, + "availableCPU": { + "type": "number" + }, + "availableGPU": { + "type": "number" + }, + "availableMemory": { + "type": "number" + }, + "availableStorage": { + "type": "number" + }, + "totalCPU": { + "type": "number" + }, + "totalGPU": { + "type": "number" + }, + "totalMemory": { + "type": "number" + }, + "totalStorage": { + "type": "number" + }, + "activeEphemeralStorage": { + "type": "number" + }, + "pendingEphemeralStorage": { + "type": "number" + }, + "availableEphemeralStorage": { + "type": "number" + }, + "activePersistentStorage": { + "type": "number" + }, + "pendingPersistentStorage": { + "type": "number" + }, + "availablePersistentStorage": { + "type": "number" + } + }, + "required": [ + "activeProviderCount", + "activeCPU", + "activeGPU", + "activeMemory", + "activeStorage", + "pendingCPU", + "pendingGPU", + "pendingMemory", + "pendingStorage", + "availableCPU", + "availableGPU", + "availableMemory", + "availableStorage", + "totalCPU", + "totalGPU", + "totalMemory", + "totalStorage", + "activeEphemeralStorage", + "pendingEphemeralStorage", + "availableEphemeralStorage", + "activePersistentStorage", + "pendingPersistentStorage", + "availablePersistentStorage" + ] + } + } + } + } + } + } + }, + "/v1/blocks": { + "get": { + "summary": "Get a list of recent blocks.", + "tags": [ + "Blocks" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "description": "Number of blocks to return", + "minimum": 1, + "maximum": 100, + "example": 20, + "default": 20 + }, + "required": false, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns block list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "proposer": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "operatorAddress": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "avatarUrl": { + "type": "string", + "nullable": true + } + }, + "required": [ + "address", + "operatorAddress", + "moniker", + "avatarUrl" + ] + }, + "transactionCount": { + "type": "number" + }, + "totalTransactionCount": { + "type": "number" + }, + "datetime": { + "type": "string" + } + }, + "required": [ + "height", + "proposer", + "transactionCount", + "totalTransactionCount", + "datetime" + ] + } + } + } + } + } + } + } + }, + "/v1/blocks/{height}": { + "get": { + "summary": "Get a block by height.", + "tags": [ + "Blocks" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "nullable": true, + "description": "Block Height", + "example": 12121212 + }, + "required": false, + "name": "height", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns predicted block date", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "proposer": { + "type": "object", + "properties": { + "operatorAddress": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "avatarUrl": { + "type": "string" + }, + "address": { + "type": "string" + } + }, + "required": [ + "operatorAddress", + "moniker", + "address" + ] + }, + "hash": { + "type": "string" + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "transactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "error": { + "type": "string", + "nullable": true + }, + "fee": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "amount": { + "type": "number" + } + }, + "required": [ + "id", + "type", + "amount" + ] + } + } + }, + "required": [ + "hash", + "isSuccess", + "fee", + "datetime", + "messages" + ] + } + } + }, + "required": [ + "height", + "datetime", + "proposer", + "hash", + "gasUsed", + "gasWanted", + "transactions" + ] + } + } + } + }, + "400": { + "description": "Invalid height" + }, + "404": { + "description": "Block not found" + } + } + } + }, + "/v1/predicted-block-date/{height}": { + "get": { + "summary": "Get the estimated date of a future block.", + "tags": [ + "Blocks" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "description": "Block height", + "example": 20000000 + }, + "required": false, + "name": "height", + "in": "path" + }, + { + "schema": { + "type": "number", + "default": 10000, + "description": "Block window", + "example": 10000 + }, + "required": false, + "name": "blockWindow", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns predicted block date", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "predictedDate": { + "type": "string" + }, + "height": { + "type": "number", + "example": 10000000 + }, + "blockWindow": { + "type": "number", + "example": 10000 + } + }, + "required": [ + "predictedDate", + "height", + "blockWindow" + ] + } + } + } + }, + "400": { + "description": "Invalid height or block window" + } + } + } + }, + "/v1/predicted-date-height/{timestamp}": { + "get": { + "summary": "Get the estimated height of a future date and time.", + "tags": [ + "Blocks" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "description": "Unix Timestamp", + "example": 1704392968 + }, + "required": false, + "name": "timestamp", + "in": "path" + }, + { + "schema": { + "type": "number", + "default": 10000, + "description": "Block window", + "example": 10000 + }, + "required": false, + "name": "blockWindow", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns predicted block height", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "predictedHeight": { + "type": "number", + "example": 10000000 + }, + "date": { + "type": "string", + "example": "2024-01-04T18:29:28.000Z" + }, + "blockWindow": { + "type": "number", + "example": 10000 + } + }, + "required": [ + "predictedHeight", + "date", + "blockWindow" + ] + } + } + } + }, + "400": { + "description": "Invalid timestamp or block window" + } + } + } + }, + "/v1/transactions": { + "get": { + "summary": "Get a list of transactions.", + "tags": [ + "Transactions" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "description": "Number of transactions to return", + "minimum": 1, + "maximum": 100, + "example": 20, + "default": 20 + }, + "required": false, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Returns transaction list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "error": { + "type": "string", + "nullable": true + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "memo": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "amount": { + "type": "number" + } + }, + "required": [ + "id", + "type", + "amount" + ] + } + } + }, + "required": [ + "height", + "datetime", + "hash", + "isSuccess", + "error", + "gasUsed", + "gasWanted", + "fee", + "memo", + "messages" + ] + } + } + } + } + } + } + } + }, + "/v1/transactions/{hash}": { + "get": { + "summary": "Get a transaction by hash.", + "tags": [ + "Transactions" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "minLength": 1, + "description": "Transaction hash", + "example": "A19F1950D97E576F0D7B591D71A8D0366AA8BA0A7F3DA76F44769188644BE9EB" + }, + "required": true, + "name": "hash", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns predicted block date", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "multisigThreshold": { + "type": "number" + }, + "signers": { + "type": "array", + "items": { + "type": "string" + } + }, + "error": { + "type": "string", + "nullable": true + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "memo": { + "type": "string" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "data": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "relatedDeploymentId": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "type", + "data" + ] + } + } + }, + "required": [ + "height", + "datetime", + "hash", + "isSuccess", + "signers", + "error", + "gasUsed", + "gasWanted", + "fee", + "memo", + "messages" + ] + } + } + } + }, + "404": { + "description": "Transaction not found" + } + } + } + }, + "/v1/market-data/{coin}": { + "get": { + "tags": [ + "Analytics" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "enum": [ + "akash-network", + "usd-coin" + ], + "default": "akash-network", + "example": "akash-network" + }, + "required": false, + "name": "coin", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns market stats", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "volume": { + "type": "number" + }, + "marketCap": { + "type": "number" + }, + "marketCapRank": { + "type": "number" + }, + "priceChange24h": { + "type": "number" + }, + "priceChangePercentage24": { + "type": "number" + } + }, + "required": [ + "price", + "volume", + "marketCap", + "marketCapRank", + "priceChange24h", + "priceChangePercentage24" + ] + } + } + } + } + } + } + }, + "/v1/validators": { + "get": { + "tags": [ + "Validators" + ], + "security": [], + "responses": { + "200": { + "description": "Returns validators", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "operatorAddress": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "votingPower": { + "type": "number" + }, + "commission": { + "type": "number" + }, + "identity": { + "type": "string" + }, + "votingPowerRatio": { + "type": "number" + }, + "rank": { + "type": "number" + }, + "keybaseAvatarUrl": { + "type": "string", + "nullable": true + } + }, + "required": [ + "operatorAddress", + "moniker", + "votingPower", + "commission", + "identity", + "votingPowerRatio", + "rank", + "keybaseAvatarUrl" + ] + } + } + } + } + } + } + } + }, + "/v1/validators/{address}": { + "get": { + "tags": [ + "Validators" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Validator Address", + "example": "akashvaloper14mt78hz73d9tdwpdvkd59ne9509kxw8yj7qy8f" + }, + "required": true, + "name": "address", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Return a validator information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "operatorAddress": { + "type": "string" + }, + "address": { + "type": "string", + "nullable": true + }, + "moniker": { + "type": "string" + }, + "keybaseUsername": { + "type": "string", + "nullable": true + }, + "keybaseAvatarUrl": { + "type": "string", + "nullable": true + }, + "votingPower": { + "type": "number" + }, + "commission": { + "type": "number" + }, + "maxCommission": { + "type": "number" + }, + "maxCommissionChange": { + "type": "number" + }, + "identity": { + "type": "string" + }, + "description": { + "type": "string" + }, + "website": { + "type": "string" + }, + "rank": { + "type": "number" + } + }, + "required": [ + "operatorAddress", + "address", + "moniker", + "keybaseUsername", + "keybaseAvatarUrl", + "votingPower", + "commission", + "maxCommission", + "maxCommissionChange", + "identity", + "description", + "website", + "rank" + ] + } + } + } + }, + "400": { + "description": "Invalid address" + }, + "404": { + "description": "Validator not found" + } + } + } + }, + "/v1/pricing": { + "post": { + "tags": [ + "Other" + ], + "security": [], + "summary": "Estimate the price of a deployment on akash and other cloud providers.", + "requestBody": { + "description": "Deployment specs to use for the price estimation. **An array of specs can also be sent, in that case an array of estimations will be returned in the same order.**", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "type": "object", + "properties": { + "cpu": { + "type": "number", + "minimum": 0, + "description": "CPU in thousandths of a core. 1000 = 1 core", + "example": 1000 + }, + "memory": { + "type": "number", + "description": "Memory in bytes", + "example": 1000000000 + }, + "storage": { + "type": "number", + "description": "Storage in bytes", + "example": 1000000000 + } + }, + "required": [ + "cpu", + "memory", + "storage" + ] + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "cpu": { + "type": "number", + "minimum": 0, + "description": "CPU in thousandths of a core. 1000 = 1 core", + "example": 1000 + }, + "memory": { + "type": "number", + "description": "Memory in bytes", + "example": 1000000000 + }, + "storage": { + "type": "number", + "description": "Storage in bytes", + "example": 1000000000 + } + }, + "required": [ + "cpu", + "memory", + "storage" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns a list of deployment templates grouped by cateogories", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "type": "object", + "properties": { + "spec": { + "type": "object", + "properties": { + "cpu": { + "type": "number", + "minimum": 0, + "description": "CPU in thousandths of a core. 1000 = 1 core", + "example": 1000 + }, + "memory": { + "type": "number", + "description": "Memory in bytes", + "example": 1000000000 + }, + "storage": { + "type": "number", + "description": "Storage in bytes", + "example": 1000000000 + } + }, + "required": [ + "cpu", + "memory", + "storage" + ] + }, + "akash": { + "type": "number", + "description": "Akash price estimation (USD/month)" + }, + "aws": { + "type": "number", + "description": "AWS price estimation (USD/month)" + }, + "gcp": { + "type": "number", + "description": "GCP price estimation (USD/month)" + }, + "azure": { + "type": "number", + "description": "Azure price estimation (USD/month)" + } + }, + "required": [ + "spec", + "akash", + "aws", + "gcp", + "azure" + ] + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "spec": { + "type": "object", + "properties": { + "cpu": { + "type": "number", + "minimum": 0, + "description": "CPU in thousandths of a core. 1000 = 1 core", + "example": 1000 + }, + "memory": { + "type": "number", + "description": "Memory in bytes", + "example": 1000000000 + }, + "storage": { + "type": "number", + "description": "Storage in bytes", + "example": 1000000000 + } + }, + "required": [ + "cpu", + "memory", + "storage" + ] + }, + "akash": { + "type": "number", + "description": "Akash price estimation (USD/month)" + }, + "aws": { + "type": "number", + "description": "AWS price estimation (USD/month)" + }, + "gcp": { + "type": "number", + "description": "GCP price estimation (USD/month)" + }, + "azure": { + "type": "number", + "description": "Azure price estimation (USD/month)" + } + }, + "required": [ + "spec", + "akash", + "aws", + "gcp", + "azure" + ] + } + } + ] + } + } + } + }, + "400": { + "description": "Invalid parameters" + } + } + } + }, + "/v1/gpu": { + "get": { + "summary": "Get a list of gpu models and their availability.", + "tags": [ + "Gpu" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": false, + "name": "provider", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "vendor", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "model", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "memory_size", + "in": "query" + } + ], + "responses": { + "200": { + "description": "List of gpu models and their availability.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "gpus": { + "type": "object", + "properties": { + "total": { + "type": "object", + "properties": { + "allocatable": { + "type": "number" + }, + "allocated": { + "type": "number" + } + }, + "required": [ + "allocatable", + "allocated" + ] + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "model": { + "type": "string" + }, + "ram": { + "type": "string" + }, + "interface": { + "type": "string" + }, + "allocatable": { + "type": "number" + }, + "allocated": { + "type": "number" + } + }, + "required": [ + "model", + "ram", + "interface", + "allocatable", + "allocated" + ] + } + } + } + }, + "required": [ + "total", + "details" + ] + } + }, + "required": [ + "gpus" + ] + } + } + } + }, + "400": { + "description": "Invalid provider parameter, should be a valid akash address or host uri" + } + } + } + }, + "/v1/gpu-models": { + "get": { + "summary": "Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json.", + "tags": [ + "Gpu" + ], + "security": [], + "responses": { + "200": { + "description": "List of gpu models per.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "models": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "interface": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "memory", + "interface" + ] + } + } + }, + "required": [ + "name", + "models" + ] + } + } + } + } + } + } + } + }, + "/v1/gpu-breakdown": { + "get": { + "tags": [ + "Gpu" + ], + "security": [], + "summary": "Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned.", + "parameters": [ + { + "schema": { + "type": "string" + }, + "required": false, + "name": "vendor", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "required": false, + "name": "model", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "vendor": { + "type": "string" + }, + "model": { + "type": "string" + }, + "providerCount": { + "type": "number" + }, + "nodeCount": { + "type": "number" + }, + "totalGpus": { + "type": "number" + }, + "leasedGpus": { + "type": "number" + }, + "gpuUtilization": { + "type": "number" + } + }, + "required": [ + "date", + "vendor", + "model", + "providerCount", + "nodeCount", + "totalGpus", + "leasedGpus", + "gpuUtilization" + ] + } + } + } + } + } + } + } + }, + "/v1/gpu-prices": { + "get": { + "summary": "Get a list of gpu models with their availability and pricing.", + "tags": [ + "Gpu" + ], + "security": [], + "responses": { + "200": { + "description": "List of gpu models with their availability and pricing.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "availability": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "available": { + "type": "number" + } + }, + "required": [ + "total", + "available" + ] + }, + "models": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vendor": { + "type": "string" + }, + "model": { + "type": "string" + }, + "ram": { + "type": "string" + }, + "interface": { + "type": "string" + }, + "availability": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "available": { + "type": "number" + } + }, + "required": [ + "total", + "available" + ] + }, + "providerAvailability": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "available": { + "type": "number" + } + }, + "required": [ + "total", + "available" + ] + }, + "price": { + "type": "object", + "nullable": true, + "properties": { + "currency": { + "type": "string", + "example": "USD" + }, + "min": { + "type": "number" + }, + "max": { + "type": "number" + }, + "avg": { + "type": "number" + }, + "weightedAverage": { + "type": "number" + }, + "med": { + "type": "number" + } + }, + "required": [ + "currency", + "min", + "max", + "avg", + "weightedAverage", + "med" + ] + } + }, + "required": [ + "vendor", + "model", + "ram", + "interface", + "availability", + "providerAvailability", + "price" + ] + } + } + }, + "required": [ + "availability", + "models" + ] + } + } + } + } + } + } + }, + "/v1/proposals": { + "get": { + "tags": [ + "Proposals" + ], + "security": [], + "responses": { + "200": { + "description": "Returns a list of proposals", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "title": { + "type": "string" + }, + "status": { + "type": "string" + }, + "submitTime": { + "type": "string" + }, + "votingStartTime": { + "type": "string" + }, + "votingEndTime": { + "type": "string" + }, + "totalDeposit": { + "type": "number" + } + }, + "required": [ + "id", + "title", + "status", + "submitTime", + "votingStartTime", + "votingEndTime", + "totalDeposit" + ] + } + } + } + } + } + } + } + }, + "/v1/proposals/{id}": { + "get": { + "tags": [ + "Proposals" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "number", + "nullable": true, + "description": "Proposal ID", + "example": 1 + }, + "required": false, + "name": "id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Return a proposal by id", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "type": "string" + }, + "submitTime": { + "type": "string" + }, + "votingStartTime": { + "type": "string" + }, + "votingEndTime": { + "type": "string" + }, + "totalDeposit": { + "type": "number" + }, + "tally": { + "type": "object", + "properties": { + "yes": { + "type": "number" + }, + "abstain": { + "type": "number" + }, + "no": { + "type": "number" + }, + "noWithVeto": { + "type": "number" + }, + "total": { + "type": "number" + } + }, + "required": [ + "yes", + "abstain", + "no", + "noWithVeto", + "total" + ] + }, + "paramChanges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "subspace": { + "type": "string" + }, + "key": { + "type": "string" + }, + "value": { + "nullable": true + } + }, + "required": [ + "subspace", + "key" + ] + } + } + }, + "required": [ + "id", + "title", + "description", + "status", + "submitTime", + "votingStartTime", + "votingEndTime", + "totalDeposit", + "tally", + "paramChanges" + ] + } + } + } + }, + "400": { + "description": "Invalid proposal id" + }, + "404": { + "description": "Proposal not found" + } + } + } + }, + "/v1/templates": { + "get": { + "tags": [ + "Other" + ], + "security": [], + "responses": { + "200": { + "description": "Returns a list of deployment templates grouped by categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "templates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "deploy": { + "type": "string" + }, + "persistentStorageEnabled": { + "type": "boolean" + }, + "guide": { + "type": "string" + }, + "githubUrl": { + "type": "string" + }, + "config": { + "type": "object", + "properties": { + "ssh": { + "type": "boolean" + } + } + } + }, + "required": [ + "id", + "name", + "path", + "logoUrl", + "summary", + "readme", + "deploy", + "persistentStorageEnabled", + "githubUrl", + "config" + ] + } + } + }, + "required": [ + "title", + "templates" + ] + } + } + } + } + } + } + } + }, + "/v1/templates-list": { + "get": { + "tags": [ + "Other" + ], + "security": [], + "responses": { + "200": { + "description": "Returns a list of deployment templates grouped by categories", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "templates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "deploy": { + "type": "string" + }, + "persistentStorageEnabled": { + "type": "boolean" + }, + "guide": { + "type": "string" + }, + "githubUrl": { + "type": "string" + }, + "config": { + "type": "object", + "properties": { + "ssh": { + "type": "boolean" + } + } + } + }, + "required": [ + "id", + "name", + "path", + "logoUrl", + "summary", + "readme", + "deploy", + "persistentStorageEnabled", + "githubUrl", + "config" + ] + } + } + }, + "required": [ + "title", + "templates" + ] + } + } + }, + "required": [ + "data" + ] + } + } + } + } + } + } + }, + "/v1/templates/{id}": { + "get": { + "tags": [ + "Other" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Template ID", + "example": "akash-network-cosmos-omnibus-agoric" + }, + "required": true, + "name": "id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Return a template by id", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "logoUrl": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "deploy": { + "type": "string" + }, + "persistentStorageEnabled": { + "type": "boolean" + }, + "guide": { + "type": "string" + }, + "githubUrl": { + "type": "string" + }, + "config": { + "type": "object", + "properties": { + "ssh": { + "type": "boolean" + } + } + } + }, + "required": [ + "id", + "name", + "path", + "logoUrl", + "summary", + "readme", + "deploy", + "persistentStorageEnabled", + "githubUrl", + "config" + ] + } + }, + "required": [ + "data" + ] + } + } + } + }, + "404": { + "description": "Template not found" + } + } + } + }, + "/v1/leases-duration/{owner}": { + "get": { + "summary": "Get leases durations.", + "tags": [ + "Analytics" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "example": "akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm" + }, + "required": true, + "name": "owner", + "in": "path" + }, + { + "schema": { + "type": "string", + "pattern": "^d+$" + }, + "required": false, + "name": "dseq", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "YYYY-MM-DD", + "default": "2000-01-01" + }, + "required": false, + "name": "startDate", + "in": "query" + }, + { + "schema": { + "type": "string", + "format": "YYYY-MM-DD", + "default": "2100-01-01" + }, + "required": false, + "name": "endDate", + "in": "query" + } + ], + "responses": { + "200": { + "description": "List of leases durations and total duration.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "leaseCount": { + "type": "number" + }, + "totalDurationInSeconds": { + "type": "number" + }, + "totalDurationInHours": { + "type": "number" + }, + "leases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^d+$" + }, + "oseq": { + "type": "number" + }, + "gseq": { + "type": "number" + }, + "provider": { + "type": "string" + }, + "startHeight": { + "type": "number" + }, + "startDate": { + "type": "string" + }, + "closedHeight": { + "type": "number" + }, + "closedDate": { + "type": "string" + }, + "durationInBlocks": { + "type": "number" + }, + "durationInSeconds": { + "type": "number" + }, + "durationInHours": { + "type": "number" + } + }, + "required": [ + "dseq", + "oseq", + "gseq", + "provider", + "startHeight", + "startDate", + "closedHeight", + "closedDate", + "durationInBlocks", + "durationInSeconds", + "durationInHours" + ] + } + } + }, + "required": [ + "leaseCount", + "totalDurationInSeconds", + "totalDurationInHours", + "leases" + ] + } + } + } + }, + "400": { + "description": "Invalid start date, must be in the following format: YYYY-MM-DD" + } + } + } + }, + "/v1/addresses/{address}": { + "get": { + "summary": "Get address details", + "tags": [ + "Addresses" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Account Address", + "example": "akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm" + }, + "required": true, + "name": "address", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns address details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "number" + }, + "delegations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "validator": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "operatorAddress": { + "type": "string" + }, + "avatarUrl": { + "type": "string" + } + } + }, + "amount": { + "type": "number" + }, + "reward": { + "type": "number", + "nullable": true + } + }, + "required": [ + "validator", + "amount", + "reward" + ] + } + }, + "available": { + "type": "number" + }, + "delegated": { + "type": "number" + }, + "rewards": { + "type": "number" + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "symbol": { + "type": "string" + }, + "ibcToken": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "description": { + "type": "string" + }, + "amount": { + "type": "number" + } + }, + "required": [ + "amount" + ] + } + }, + "redelegations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "srcAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "operatorAddress": { + "type": "string" + }, + "avatarUrl": { + "type": "string" + } + } + }, + "dstAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "moniker": { + "type": "string" + }, + "operatorAddress": { + "type": "string" + }, + "avatarUrl": { + "type": "string" + } + } + }, + "creationHeight": { + "type": "number" + }, + "completionTime": { + "type": "string" + }, + "amount": { + "type": "number" + } + }, + "required": [ + "srcAddress", + "dstAddress", + "creationHeight", + "completionTime", + "amount" + ] + } + }, + "commission": { + "type": "number" + }, + "latestTransactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "error": { + "type": "string", + "nullable": true + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "memo": { + "type": "string", + "nullable": true + }, + "isSigner": { + "type": "boolean" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "isReceiver": { + "type": "boolean" + } + }, + "required": [ + "id", + "type", + "amount", + "isReceiver" + ] + } + } + }, + "required": [ + "height", + "datetime", + "hash", + "isSuccess", + "error", + "gasUsed", + "gasWanted", + "fee", + "memo", + "isSigner", + "messages" + ] + } + } + }, + "required": [ + "total", + "delegations", + "available", + "delegated", + "rewards", + "assets", + "redelegations", + "commission", + "latestTransactions" + ] + } + } + } + }, + "400": { + "description": "Invalid address" + } + } + } + }, + "/v1/addresses/{address}/transactions/{skip}/{limit}": { + "get": { + "summary": "Get a list of transactions for a given address.", + "tags": [ + "Addresses", + "Transactions" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "description": "Wallet Address", + "example": "akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm" + }, + "required": true, + "name": "address", + "in": "path" + }, + { + "schema": { + "type": "number", + "nullable": true, + "minimum": 0, + "description": "Transactions to skip", + "example": 10 + }, + "required": false, + "name": "skip", + "in": "path" + }, + { + "schema": { + "type": "number", + "minimum": 1, + "maximum": 100, + "description": "Transactions to return", + "example": 10 + }, + "required": true, + "name": "limit", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Returns transaction list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "count": { + "type": "number" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number" + }, + "datetime": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "isSuccess": { + "type": "boolean" + }, + "error": { + "type": "string", + "nullable": true + }, + "gasUsed": { + "type": "number" + }, + "gasWanted": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "memo": { + "type": "string", + "nullable": true + }, + "isSigner": { + "type": "boolean" + }, + "messages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "isReceiver": { + "type": "boolean" + } + }, + "required": [ + "id", + "type", + "amount", + "isReceiver" + ] + } + } + }, + "required": [ + "height", + "datetime", + "hash", + "isSuccess", + "error", + "gasUsed", + "gasWanted", + "fee", + "memo", + "isSigner", + "messages" + ] + } + } + }, + "required": [ + "count", + "results" + ] + } + } + } + }, + "400": { + "description": "Invalid address or parameters" + } + } + } + }, + "/v1/nodes/{network}": { + "get": { + "summary": "Get a list of nodes (api/rpc) for a specific network.", + "tags": [ + "Chain" + ], + "security": [], + "parameters": [ + { + "schema": { + "type": "string", + "enum": [ + "mainnet", + "testnet", + "sandbox" + ] + }, + "required": true, + "name": "network", + "in": "path" + } + ], + "responses": { + "200": { + "description": "List of nodes", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "api": { + "type": "string" + }, + "rpc": { + "type": "string" + } + }, + "required": [ + "id", + "api", + "rpc" + ] + } + } + } + } + } + } + } + }, + "/v1/alerts": { + "post": { + "operationId": "createAlert", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertCreateInput" + } + } + } + }, + "responses": { + "201": { + "description": "Returns the created alert", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertOutputResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "Alert" + ] + }, + "get": { + "operationId": "getAlerts", + "parameters": [ + { + "name": "limit", + "required": false, + "in": "query", + "description": "Number of items per page", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "Page number", + "schema": { + "type": "number" + } + }, + { + "name": "type", + "required": false, + "in": "query", + "description": "Chain message type, used in conjunction with dseq to filter alerts liked to a specific deployment", + "schema": { + "type": "string" + } + }, + { + "name": "dseq", + "required": false, + "in": "query", + "description": "Linked deployment's dseq", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the list of alerts", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertListOutputResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "Alert" + ] + } + }, + "/v1/alerts/{id}": { + "get": { + "operationId": "getAlert", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested alert by id", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertOutputResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "Alert" + ] + }, + "patch": { + "operationId": "patchAlert", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertPatchInput" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated alert", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertOutputResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "Alert" + ] + }, + "delete": { + "operationId": "deleteAlert", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the deleted alert", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AlertOutputResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "Alert" + ] + } + }, + "/v1/notification-channels": { + "post": { + "operationId": "createNotificationChannel", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelCreateInput" + } + } + } + }, + "responses": { + "201": { + "description": "Returns the created notification channel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelOutput" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "NotificationChannel" + ] + }, + "get": { + "operationId": "getNotificationChannels", + "parameters": [ + { + "name": "limit", + "required": false, + "in": "query", + "description": "Number of items per page", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "Page number", + "schema": { + "type": "number" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns a paginated list of notification channels", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelListOutput" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "NotificationChannel" + ] + } + }, + "/v1/notification-channels/default": { + "post": { + "operationId": "createDefaultChannel", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelCreateDefaultInput" + } + } + } + }, + "responses": { + "204": { + "description": "Creates the default notification channel only if it doesn't exist." + } + }, + "tags": [ + "NotificationChannel" + ] + } + }, + "/v1/notification-channels/{id}": { + "get": { + "operationId": "getNotificationChannel", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested notification channel by id", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelOutput" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "404": { + "description": "Returns 404 if the notification channel is not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotFoundErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "NotificationChannel" + ] + }, + "patch": { + "operationId": "patchNotificationChannel", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelPatchInput" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated notification channel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelOutput" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "404": { + "description": "Returns 404 if the notification channel is not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotFoundErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "NotificationChannel" + ] + }, + "delete": { + "operationId": "deleteNotificationChannel", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the deleted notification channel", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationChannelOutput" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "404": { + "description": "Returns 404 if the notification channel is not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotFoundErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "NotificationChannel" + ] + } + }, + "/v1/deployment-alerts/{dseq}": { + "post": { + "operationId": "upsertDeploymentAlert", + "parameters": [ + { + "name": "dseq", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "x-owner-address", + "required": false, + "in": "header", + "description": "The address of the user who owns the deployment", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeploymentAlertCreateInput" + } + } + } + }, + "responses": { + "201": { + "description": "Returns the created alert", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeploymentAlertsResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "DeploymentAlert" + ] + }, + "get": { + "operationId": "getDeploymentAlerts", + "parameters": [ + { + "name": "dseq", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns alerts for the specified deployment", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeploymentAlertsResponse" + } + } + } + }, + "400": { + "description": "Validation error responded when some request parameters are invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized error responded when the user is not authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnauthorizedErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden error responded when the user is not authorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error, should probably be reported", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalServerErrorResponse" + } + } + } + } + }, + "tags": [ + "DeploymentAlert" + ] + } + } + }, + "components": { + "schemas": { + "Deployment DSEQ": { + "type": "string", + "pattern": "^d+$" + }, + "AlertCreateInput": { + "type": "object", + "properties": { + "data": { + "oneOf": [ + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean", + "default": true + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_MESSAGE" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "summary", + "description", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean", + "default": true + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_EVENT" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "summary", + "description", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean", + "default": true + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "type": { + "type": "string", + "enum": [ + "DEPLOYMENT_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "owner": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "owner" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "summary", + "description", + "type", + "conditions", + "params" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean", + "default": true + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "type": { + "type": "string", + "enum": [ + "WALLET_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "denom": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "owner", + "denom" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "summary", + "description", + "type", + "conditions", + "params" + ] + } + ] + } + }, + "required": [ + "data" + ] + }, + "AlertOutputResponse": { + "type": "object", + "properties": { + "data": { + "oneOf": [ + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_MESSAGE" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_EVENT" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "type": { + "type": "string", + "enum": [ + "DEPLOYMENT_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "owner": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "owner" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "type", + "conditions", + "params" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "type": { + "type": "string", + "enum": [ + "WALLET_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "denom": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "owner", + "denom" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "type", + "conditions", + "params" + ] + } + ] + } + }, + "required": [ + "data" + ] + }, + "ValidationErrorResponse": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "minimum": 400, + "maximum": 400 + }, + "message": { + "type": "string" + }, + "errors": { + "type": "object", + "properties": { + "issues": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + } + }, + "required": [ + "issues" + ] + } + }, + "required": [ + "statusCode", + "message", + "errors" + ] + }, + "UnauthorizedErrorResponse": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "minimum": 401, + "maximum": 401 + }, + "message": { + "type": "string" + } + }, + "required": [ + "statusCode", + "message" + ] + }, + "ForbiddenErrorResponse": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "minimum": 403, + "maximum": 403 + }, + "message": { + "type": "string" + } + }, + "required": [ + "statusCode", + "message" + ] + }, + "InternalServerErrorResponse": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "minimum": 500, + "maximum": 500 + }, + "message": { + "type": "string" + } + }, + "required": [ + "statusCode", + "message" + ] + }, + "AlertListOutputResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_MESSAGE" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "type": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "type" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "type": { + "type": "string", + "enum": [ + "CHAIN_EVENT" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "conditions", + "type" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "type": { + "type": "string", + "enum": [ + "DEPLOYMENT_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "dseq": { + "type": "string", + "pattern": "^\\d+$" + }, + "owner": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "dseq", + "owner" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "type", + "conditions", + "params" + ] + }, + { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean" + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "notificationChannelName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createdAt": {}, + "updatedAt": {}, + "type": { + "type": "string", + "enum": [ + "WALLET_BALANCE" + ] + }, + "conditions": { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + "params": { + "type": "object", + "properties": { + "owner": { + "type": "string" + }, + "denom": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "owner", + "denom" + ] + } + }, + "required": [ + "notificationChannelId", + "name", + "enabled", + "summary", + "description", + "id", + "userId", + "status", + "createdAt", + "updatedAt", + "type", + "conditions", + "params" + ] + } + ] + } + }, + "pagination": { + "type": "object", + "properties": { + "page": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "limit": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false, + "maximum": 1000, + "exclusiveMaximum": false + }, + "total": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "totalPages": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "hasNextPage": { + "type": "boolean" + }, + "hasPreviousPage": { + "type": "boolean" + } + }, + "required": [ + "page", + "limit", + "total", + "totalPages", + "hasNextPage", + "hasPreviousPage" + ] + } + }, + "required": [ + "data", + "pagination" + ] + }, + "AlertPatchInput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string", + "minLength": 3 + }, + "enabled": { + "type": "boolean", + "default": true + }, + "summary": { + "type": "string", + "minLength": 3 + }, + "description": { + "type": "string", + "minLength": 3 + }, + "conditions": { + "oneOf": [ + { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + }, + { + "oneOf": [ + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "and" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "type": "string", + "enum": [ + "or" + ] + }, + "value": { + "type": "array", + "minItems": 2, + "items": { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + } + }, + "required": [ + "operator", + "value" + ] + }, + { + "type": "object", + "properties": { + "operator": { + "oneOf": [ + { + "type": "string", + "enum": [ + "eq" + ] + }, + { + "type": "string", + "enum": [ + "lt" + ] + }, + { + "type": "string", + "enum": [ + "gt" + ] + }, + { + "type": "string", + "enum": [ + "lte" + ] + }, + { + "type": "string", + "enum": [ + "gte" + ] + } + ] + }, + "field": { + "type": "string", + "enum": [ + "balance" + ] + }, + "value": { + "type": "number" + } + }, + "required": [ + "operator", + "field", + "value" + ] + } + ] + } + ] + } + } + } + }, + "required": [ + "data" + ] + }, + "NotificationChannelCreateInput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "email" + ] + }, + "config": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string", + "format": "email" + } + } + }, + "required": [ + "addresses" + ] + }, + "isDefault": { + "type": "boolean" + } + }, + "required": [ + "name", + "type", + "config" + ] + } + }, + "required": [ + "data" + ] + }, + "NotificationChannelOutput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "email" + ] + }, + "config": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string", + "format": "email" + } + } + }, + "required": [ + "addresses" + ] + }, + "isDefault": { + "type": "boolean" + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "createdAt": {}, + "updatedAt": {} + }, + "required": [ + "name", + "type", + "config", + "isDefault", + "id", + "userId", + "createdAt", + "updatedAt" + ] + } + }, + "required": [ + "data" + ] + }, + "NotificationChannelCreateDefaultInput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "email" + ] + }, + "config": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string", + "format": "email" + } + } + }, + "required": [ + "addresses" + ] + } + }, + "required": [ + "name", + "type", + "config" + ] + } + }, + "required": [ + "data" + ] + }, + "NotFoundErrorResponse": { + "type": "object", + "properties": { + "statusCode": { + "type": "number", + "minimum": 404, + "maximum": 404 + }, + "message": { + "type": "string" + } + }, + "required": [ + "statusCode", + "message" + ] + }, + "NotificationChannelListOutput": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "email" + ] + }, + "config": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string", + "format": "email" + } + } + }, + "required": [ + "addresses" + ] + }, + "isDefault": { + "type": "boolean" + }, + "id": { + "type": "string", + "format": "uuid" + }, + "userId": { + "type": "string", + "format": "uuid" + }, + "createdAt": {}, + "updatedAt": {} + }, + "required": [ + "name", + "type", + "config", + "isDefault", + "id", + "userId", + "createdAt", + "updatedAt" + ] + } + }, + "pagination": { + "type": "object", + "properties": { + "page": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "limit": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false, + "maximum": 1000, + "exclusiveMaximum": false + }, + "total": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "totalPages": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "hasNextPage": { + "type": "boolean" + }, + "hasPreviousPage": { + "type": "boolean" + } + }, + "required": [ + "page", + "limit", + "total", + "totalPages", + "hasNextPage", + "hasPreviousPage" + ] + } + }, + "required": [ + "data", + "pagination" + ] + }, + "NotificationChannelPatchInput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "email" + ] + }, + "config": { + "type": "object", + "properties": { + "addresses": { + "type": "array", + "items": { + "type": "string", + "format": "email" + } + } + }, + "required": [ + "addresses" + ] + } + } + } + }, + "required": [ + "data" + ] + }, + "DeploymentAlertCreateInput": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "alerts": { + "type": "object", + "properties": { + "deploymentBalance": { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "threshold": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + } + }, + "required": [ + "notificationChannelId", + "threshold" + ] + }, + "deploymentClosed": { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "enabled": { + "type": "boolean", + "default": true + } + }, + "required": [ + "notificationChannelId" + ] + } + } + } + }, + "required": [ + "alerts" + ] + } + }, + "required": [ + "data" + ] + }, + "DeploymentAlertsResponse": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "dseq": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "alerts": { + "type": "object", + "properties": { + "deploymentBalance": { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "threshold": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false + }, + "id": { + "type": "string", + "format": "uuid" + }, + "status": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "notificationChannelId", + "threshold", + "id", + "status" + ] + }, + "deploymentClosed": { + "type": "object", + "properties": { + "notificationChannelId": { + "type": "string", + "format": "uuid" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "id": { + "type": "string", + "format": "uuid" + }, + "status": { + "type": "string" + }, + "suppressedBySystem": { + "type": "boolean" + } + }, + "required": [ + "notificationChannelId", + "id", + "status" + ] + } + } + } + }, + "required": [ + "dseq", + "alerts" + ] + } + }, + "required": [ + "data" + ] + } + }, + "securitySchemes": { + "BearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT", + "description": "JWT token for authenticated users, sent in \"Authorization: Bearer %token\" header." + }, + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "x-api-key", + "description": "API key for programmatic access." + }, + "x-user-id": { + "type": "apiKey", + "in": "header", + "name": "x-user-id" + }, + "x-owner-address": { + "type": "apiKey", + "in": "header", + "name": "x-owner-address" + } + } + } +} \ No newline at end of file diff --git a/apps/deploy-web/src/queries/useManagedWalletQuery.ts b/apps/deploy-web/src/queries/useManagedWalletQuery.ts index 2867a53999..73b93abcf0 100644 --- a/apps/deploy-web/src/queries/useManagedWalletQuery.ts +++ b/apps/deploy-web/src/queries/useManagedWalletQuery.ts @@ -1,22 +1,23 @@ -import type { QueryKey } from "@tanstack/react-query"; -import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; +import { useMutation, useQueryClient } from "@tanstack/react-query"; import { useServices } from "@src/context/ServicesProvider/ServicesProvider"; import { QueryKeys } from "./queryKeys"; export function useManagedWalletQuery(userId?: string) { - const { managedWalletService } = useServices(); - return useQuery({ - queryKey: QueryKeys.getManagedWalletKey(userId) as QueryKey, - queryFn: async () => { - if (userId) { - return await managedWalletService.getWallet(userId); + const { consoleApi } = useServices(); + + return consoleApi.v1.getWallets.useQuery( + { + query: { + userId: userId ?? "" } - return null; }, - enabled: !!userId, - staleTime: Infinity - }); + { + select: response => response.data[0], + enabled: !!userId, + staleTime: Infinity + } + ); } export function useCreateManagedWalletMutation() { diff --git a/apps/deploy-web/src/services/app-di-container/browser-di-container.ts b/apps/deploy-web/src/services/app-di-container/browser-di-container.ts index 718d7e07f1..8c05862797 100644 --- a/apps/deploy-web/src/services/app-di-container/browser-di-container.ts +++ b/apps/deploy-web/src/services/app-di-container/browser-di-container.ts @@ -1,4 +1,5 @@ -import { createAPIClient } from "@akashnetwork/react-query-sdk/notifications"; +import { createAPIClient as createConsoleApiClient } from "@akashnetwork/react-query-sdk/api"; +import { createAPIClient as createNotificationsApiClient } from "@akashnetwork/react-query-sdk/notifications"; import { requestFn } from "@openapi-qraft/react"; import { browserEnvConfig } from "@src/config/browser-env.config"; @@ -23,7 +24,13 @@ const rootContainer = createAppRootContainer({ export const services = createChildContainer(rootContainer, { notificationsApi: () => - createAPIClient({ + createNotificationsApiClient({ + requestFn, + baseUrl: "/api/proxy", + queryClient: services.queryClient + }), + consoleApi: () => + createConsoleApiClient({ requestFn, baseUrl: "/api/proxy", queryClient: services.queryClient diff --git a/package-lock.json b/package-lock.json index ba12d31aaf..df637d0b41 100644 --- a/package-lock.json +++ b/package-lock.json @@ -117,6 +117,7 @@ "@akashnetwork/docker": "*", "@akashnetwork/releaser": "*", "@faker-js/faker": "^8.4.1", + "@openapi-qraft/cli": "^2.5.0", "@types/bcryptjs": "^2.4.6", "@types/dot-object": "^2.1.6", "@types/http-assert": "^1.5.5", @@ -150,6 +151,7 @@ "openapi3-ts": "^4.5.0", "prettier": "^3.3.0", "prettier-plugin-tailwindcss": "^0.6.1", + "rimraf": "^6.0.1", "supertest": "^6.1.5", "ts-jest": "^29.1.4", "ts-loader": "^9.5.2", @@ -826,6 +828,40 @@ "integrity": "sha512-CENXb4O5GN+VyB68HYXFT2SOhv126Z59631rZC56m8uMWa6/cSlFeai8BwZGT1NMepw0Ecf+U8XSOnBzZUWh9Q==", "license": "Apache-2.0" }, + "apps/api/node_modules/glob": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.0.tgz", + "integrity": "sha512-tvZgpqk6fz4BaNZ66ZsRaZnbHvP/jG3uKJvAZOwEVUL4RTA5nJeeLYfyN9/VA8NX/V3IBG+hkeuGpKjvELkVhA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "minimatch": "^10.1.1", + "minipass": "^7.1.2", + "path-scurry": "^2.0.0" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "apps/api/node_modules/glob/node_modules/minimatch": { + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.1.1.tgz", + "integrity": "sha512-enIvLvRAFZYXJzkCYG5RKmPfrFArdLv+R+lbQ53BmIMLIry74bjKzX6iHAm8WYamJkhSSEabrWN5D97XnKObjQ==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/brace-expansion": "^5.0.0" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "apps/api/node_modules/lru-cache": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.1.0.tgz", @@ -911,6 +947,23 @@ "semver": "bin/semver" } }, + "apps/api/node_modules/path-scurry": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.1.tgz", + "integrity": "sha512-oWyT4gICAu+kaA7QWk/jvCHWarMKNs6pXOGWKDTr7cw4IGcUbW+PeTfbaQiLGheFRpjo6O9J0PmyMfQPjH71oA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^11.0.0", + "minipass": "^7.1.2" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "apps/api/node_modules/pg-boss": { "version": "11.0.4", "resolved": "https://registry.npmjs.org/pg-boss/-/pg-boss-11.0.4.tgz", @@ -980,6 +1033,26 @@ "node": ">=0.10.0" } }, + "apps/api/node_modules/rimraf": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-6.1.2.tgz", + "integrity": "sha512-cFCkPslJv7BAXJsYlK1dZsbP8/ZNLkCAQ0bi1hf5EKX2QHegmDFEFA6QhuYJlk7UDdc+02JjO80YSOrWPpw06g==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "glob": "^13.0.0", + "package-json-from-dist": "^1.0.1" + }, + "bin": { + "rimraf": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "apps/api/node_modules/type-fest": { "version": "4.27.0", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.27.0.tgz", @@ -14438,6 +14511,29 @@ "@swc/helpers": "^0.5.0" } }, + "node_modules/@isaacs/balanced-match": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz", + "integrity": "sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "20 || >=22" + } + }, + "node_modules/@isaacs/brace-expansion": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz", + "integrity": "sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@isaacs/balanced-match": "^4.0.1" + }, + "engines": { + "node": "20 || >=22" + } + }, "node_modules/@isaacs/cliui": { "version": "8.0.2", "license": "ISC", @@ -47431,9 +47527,9 @@ } }, "node_modules/package-json-from-dist": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz", - "integrity": "sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "license": "BlueOak-1.0.0" }, "node_modules/pako": { diff --git a/packages/react-query-sdk/package.json b/packages/react-query-sdk/package.json index 038d6aca17..f988dd0275 100644 --- a/packages/react-query-sdk/package.json +++ b/packages/react-query-sdk/package.json @@ -6,12 +6,13 @@ "license": "Apache-2.0", "author": "", "exports": { - "./notifications": "./src/notifications/index.ts" + "./notifications": "./src/notifications/index.ts", + "./api": "./src/api/index.ts" }, "main": "src/index.ts", "scripts": { "format": "prettier --write ./*.{js,json} **/*.{ts,js,json}", - "gen": "npm run sdk:gen:react-query -w ../../apps/notifications && npm run lint:fix && npm run format", + "gen": "npm run sdk:gen:react-query -w ../../apps/notifications && npm run sdk:gen:react-query -w ../../apps/api && npm run lint:fix && npm run format", "lint:fix": "eslint . --fix", "validate:types": "tsc --noEmit && echo" }, diff --git a/packages/react-query-sdk/src/api/create-api-client.ts b/packages/react-query-sdk/src/api/create-api-client.ts new file mode 100644 index 0000000000..481a6912b8 --- /dev/null +++ b/packages/react-query-sdk/src/api/create-api-client.ts @@ -0,0 +1,37 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +import type { + APIBasicClientServices, + APIBasicQueryClientServices, + APIDefaultQueryClientServices, + APIUtilityClientServices, + CreateAPIBasicClientOptions, + CreateAPIBasicQueryClientOptions, + CreateAPIClientOptions, + CreateAPIQueryClientOptions +} from "@openapi-qraft/react"; +import { qraftAPIClient } from "@openapi-qraft/react"; +import * as allCallbacks from "@openapi-qraft/react/callbacks/index"; + +import { services } from "./services/index"; +export function createAPIClient(options: CreateAPIQueryClientOptions): APIDefaultQueryClientServices; +export function createAPIClient(options: CreateAPIBasicQueryClientOptions): APIBasicQueryClientServices; +export function createAPIClient(options: CreateAPIBasicClientOptions): APIBasicClientServices; +export function createAPIClient(): APIUtilityClientServices; +export function createAPIClient( + options?: CreateAPIClientOptions +): + | APIDefaultQueryClientServices + | APIBasicQueryClientServices + | APIBasicClientServices + | APIUtilityClientServices { + if (!options) return qraftAPIClient(services, allCallbacks); + if ("requestFn" in options) return qraftAPIClient(services, allCallbacks, options); + if ("queryClient" in options) return qraftAPIClient(services, allCallbacks, options); + return qraftAPIClient(services, allCallbacks); +} +type AllCallbacks = typeof allCallbacks; +type Services = typeof services; diff --git a/packages/react-query-sdk/src/api/index.ts b/packages/react-query-sdk/src/api/index.ts new file mode 100644 index 0000000000..73e61503b3 --- /dev/null +++ b/packages/react-query-sdk/src/api/index.ts @@ -0,0 +1,9 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +export type { $defs, paths, components, operations, webhooks } from "./schema"; +export { services } from "./services/index"; +export type { Services } from "./services/index"; +export { createAPIClient } from "./create-api-client"; diff --git a/packages/react-query-sdk/src/api/schema.ts b/packages/react-query-sdk/src/api/schema.ts new file mode 100644 index 0000000000..91f3b9b46f --- /dev/null +++ b/packages/react-query-sdk/src/api/schema.ts @@ -0,0 +1,8429 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +export interface paths { + "/v1/start-trial": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + userId: string; + }; + }; + }; + }; + responses: { + /** @description Trial started successfully and wallet created */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: number | null; + userId: string | null; + creditAmount: number; + address: string | null; + isTrialing: boolean; + createdAt: string | null; + requires3DS?: boolean; + clientSecret?: string | null; + paymentIntentId?: string | null; + paymentMethodId?: string | null; + }; + }; + }; + }; + /** @description 3D Secure authentication required to complete trial setup */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: number | null; + userId: string | null; + creditAmount: number; + address: string | null; + isTrialing: boolean; + createdAt: string | null; + requires3DS?: boolean; + clientSecret?: string | null; + paymentIntentId?: string | null; + paymentMethodId?: string | null; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/wallets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of wallets */ + get: { + parameters: { + query: { + userId: string; + awaitSessionId?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a created wallet */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: number | null; + userId: string | null; + creditAmount: number; + address: string | null; + isTrialing: boolean; + createdAt: string | null; + requires3DS?: boolean; + clientSecret?: string | null; + paymentIntentId?: string | null; + paymentMethodId?: string | null; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/wallet-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Wallet settings retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + autoReloadEnabled: boolean; + }; + }; + }; + }; + /** @description UserWallet Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + /** + * Update wallet settings + * @description Updates wallet settings for a user wallet + */ + put: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + autoReloadEnabled: boolean; + }; + }; + }; + }; + responses: { + /** @description Wallet settings updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + autoReloadEnabled: boolean; + }; + }; + }; + }; + /** @description UserWallet Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + /** + * Create wallet settings + * @description Creates wallet settings for a user wallet + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + autoReloadEnabled: boolean; + }; + }; + }; + }; + responses: { + /** @description Wallet settings created successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + autoReloadEnabled: boolean; + }; + }; + }; + }; + /** @description UserWallet Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + /** + * Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ + delete: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Wallet settings deleted successfully */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description UserWallet Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/tx": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Signs a transaction via a user managed wallet */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + userId: string; + messages: { + /** @enum {string} */ + typeUrl: + | "/akash.deployment.v1beta4.MsgCreateDeployment" + | "/akash.cert.v1.MsgCreateCertificate" + | "/akash.market.v1beta5.MsgCreateLease" + | "/akash.deployment.v1beta4.MsgUpdateDeployment" + | "/akash.deployment.v1beta4.MsgCloseDeployment" + | "/akash.escrow.v1.MsgAccountDeposit"; + value: string; + }[]; + }; + }; + }; + }; + responses: { + /** @description Returns a signed transaction */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + code: number; + transactionHash: string; + rawLog: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/checkout": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Creates a stripe checkout session and redirects to checkout */ + get: { + parameters: { + query?: { + amount?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Redirects to the checkout page */ + 301: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe-webhook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Stripe Webhook Handler */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "text/plain": string; + }; + }; + responses: { + /** @description Webhook processed successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Stripe signature is required */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + error: string; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/prices": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Available pricing options retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + currency: string; + unitAmount: number; + isCustom: boolean; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/coupons/apply": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Apply a coupon to the current user */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + couponId: string; + userId: string; + }; + }; + }; + }; + responses: { + /** @description Coupon applied successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + coupon?: { + id: string; + percent_off?: number | null; + amount_off?: number | null; + valid?: boolean | null; + name?: string | null; + description?: string | null; + } | null; + amountAdded?: number; + error?: { + message: string; + code?: string; + type?: string; + }; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/customers/organization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ + put: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + organization: string; + }; + }; + }; + responses: { + /** @description Organization updated successfully */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/payment-methods/setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description SetupIntent created successfully with client secret */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + clientSecret: string | null; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/payment-methods/default": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Default payment method retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + type: string; + validated?: boolean; + isDefault?: boolean; + card?: { + brand: string | null; + last4: string | null; + exp_month: number; + exp_year: number; + funding?: string | null; + country?: string | null; + network?: string | null; + three_d_secure_usage?: { + supported?: boolean | null; + } | null; + } | null; + billing_details?: { + address?: { + city: string | null; + country: string | null; + line1: string | null; + line2: string | null; + postal_code: string | null; + state: string | null; + } | null; + email?: string | null; + name?: string | null; + phone?: string | null; + }; + }; + }; + }; + }; + /** @description Default payment method not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + /** Marks a payment method as the default. */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + id: string; + }; + }; + }; + }; + responses: { + /** @description Payment method is marked as the default successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/payment-methods": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Payment methods retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + type: string; + validated?: boolean; + isDefault?: boolean; + card?: { + brand: string | null; + last4: string | null; + exp_month: number; + exp_year: number; + funding?: string | null; + country?: string | null; + network?: string | null; + three_d_secure_usage?: { + supported?: boolean | null; + } | null; + } | null; + billing_details?: { + address?: { + city: string | null; + country: string | null; + line1: string | null; + line2: string | null; + postal_code: string | null; + state: string | null; + } | null; + email?: string | null; + name?: string | null; + phone?: string | null; + }; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/payment-methods/{paymentMethodId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ + delete: { + parameters: { + query?: never; + header?: never; + path: { + paymentMethodId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Payment method removed successfully */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/payment-methods/validate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + paymentMethodId: string; + paymentIntentId: string; + }; + }; + }; + }; + responses: { + /** @description Payment method validated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + success: boolean; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/transactions/confirm": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + userId: string; + paymentMethodId: string; + amount: number; + currency: string; + }; + }; + }; + }; + responses: { + /** @description Payment processed successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + success: boolean; + requiresAction?: boolean; + clientSecret?: string; + paymentIntentId?: string; + }; + }; + }; + }; + /** @description 3D Secure authentication required to complete payment */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + success: boolean; + requiresAction?: boolean; + clientSecret?: string; + paymentIntentId?: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get transaction history for the current customer */ + get: { + parameters: { + query?: { + limit?: number; + startingAfter?: string; + endingBefore?: string; + startDate?: string; + endDate?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Customer transactions retrieved successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + transactions: { + id: string; + amount: number; + currency: string; + status: string; + created: number; + paymentMethod: { + type: string; + validated?: boolean; + isDefault?: boolean; + card?: { + brand: string | null; + last4: string | null; + exp_month: number; + exp_year: number; + funding?: string | null; + country?: string | null; + network?: string | null; + three_d_secure_usage?: { + supported?: boolean | null; + } | null; + } | null; + billing_details?: { + address?: { + city: string | null; + country: string | null; + line1: string | null; + line2: string | null; + postal_code: string | null; + state: string | null; + } | null; + email?: string | null; + name?: string | null; + phone?: string | null; + }; + } | null; + receiptUrl?: string | null; + description?: string | null; + metadata?: { + [key: string]: string; + } | null; + }[]; + hasMore: boolean; + nextPage?: string | null; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/stripe/transactions/export": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Export transaction history as CSV for the current customer */ + get: { + parameters: { + query: { + timezone: string; + startDate: string; + endDate: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description CSV file with transaction data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "text/csv": Blob; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/usage/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get historical data of billing and usage for a wallet address. */ + get: { + parameters: { + query: { + address: string; + startDate?: string; + endDate?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns billing and usage data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Date in YYYY-MM-DD format + * @example 2024-01-15 + */ + date: string; + /** + * @description Number of active deployments on this date + * @example 3 + */ + activeDeployments: number; + /** + * @description AKT tokens spent on this date + * @example 12.5 + */ + dailyAktSpent: number; + /** + * @description Cumulative AKT tokens spent up to this date + * @example 125.75 + */ + totalAktSpent: number; + /** + * @description USDC spent on this date + * @example 5.25 + */ + dailyUsdcSpent: number; + /** + * @description Cumulative USDC spent up to this date + * @example 52.5 + */ + totalUsdcSpent: number; + /** + * @description Total USD value spent on this date (AKT + USDC) + * @example 17.75 + */ + dailyUsdSpent: number; + /** + * @description Cumulative USD value spent up to this date + * @example 178.25 + */ + totalUsdSpent: number; + }[]; + }; + }; + /** @description Invalid address format */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/usage/history/stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get historical usage stats for a wallet address. */ + get: { + parameters: { + query: { + address: string; + startDate?: string; + endDate?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns usage stats data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Total amount spent in USD + * @example 1234.56 + */ + totalSpent: number; + /** + * @description Average spending per day in USD + * @example 12.34 + */ + averageSpentPerDay: number; + /** + * @description Total number of deployments deployed + * @example 15 + */ + totalDeployments: number; + /** + * @description Average number of deployments deployed per day + * @example 1.5 + */ + averageDeploymentsPerDay: number; + }; + }; + }; + /** @description Invalid address format */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/anonymous-users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Creates an anonymous user */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a created anonymous user */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: string; + }; + token: string; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/anonymous-users/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Retrieves an anonymous user by id */ + get: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns an anonymous user */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: string; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/register-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Registers a new user */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + wantedUsername: string; + email: string; + emailVerified: boolean; + subscribedToNewsletter?: boolean; + }; + }; + }; + responses: { + /** @description Returns the registered user */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: string; + userId: string; + username: string; + email: string; + emailVerified: boolean; + stripeCustomerId?: string | null; + bio?: string | null; + subscribedToNewsletter: boolean; + youtubeUsername?: string | null; + twitterUsername?: string | null; + githubUsername?: string | null; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/user/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Retrieves the logged in user */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the logged in user */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: string; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/send-verification-email": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Resends a verification email */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + data: { + userId: string; + }; + }; + }; + }; + responses: { + /** @description Returns a created wallet */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/verify-email": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Checks if the email is verified */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + data: { + /** Format: email */ + email: string; + }; + }; + }; + }; + responses: { + /** @description Returns email verification status */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + emailVerified: boolean; + }; + }; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description User not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/deployment-settings/{userId}/{dseq}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get deployment settings by user ID and dseq */ + get: { + parameters: { + query?: never; + header?: never; + path: { + userId: string; + dseq: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment settings */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + userId: string; + dseq: string; + autoTopUpEnabled: boolean; + estimatedTopUpAmount: number; + topUpFrequencyMs: number; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + }; + }; + }; + }; + /** @description Deployment settings not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message: string; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** Update deployment settings */ + patch: { + parameters: { + query?: never; + header?: never; + path: { + userId: string; + dseq: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + /** @description Whether auto top-up is enabled for this deployment */ + autoTopUpEnabled: boolean; + }; + }; + }; + }; + responses: { + /** @description Deployment settings updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + userId: string; + dseq: string; + autoTopUpEnabled: boolean; + estimatedTopUpAmount: number; + topUpFrequencyMs: number; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + }; + }; + }; + }; + /** @description Deployment settings not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message: string; + }; + }; + }; + }; + }; + trace?: never; + }; + "/v1/deployment-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Create deployment settings */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + /** @description User ID */ + userId: string; + /** @description Deployment sequence number */ + dseq: string; + /** + * @description Whether auto top-up is enabled for this deployment + * @default false + */ + autoTopUpEnabled?: boolean; + }; + }; + }; + }; + responses: { + /** @description Deployment settings created successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + userId: string; + dseq: string; + autoTopUpEnabled: boolean; + estimatedTopUpAmount: number; + topUpFrequencyMs: number; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/deployments/{dseq}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a deployment */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Deployment sequence number */ + dseq: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment info */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + leases: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + status: { + forwarded_ports: { + [key: string]: { + port: number; + externalPort: number; + host?: string; + available?: number; + }[]; + }; + ips: { + [key: string]: { + IP: string; + Port: number; + ExternalPort: number; + Protocol: string; + }[]; + }; + services: { + [key: string]: { + name: string; + available: number; + total: number; + uris: string[]; + observed_generation: number; + replicas: number; + updated_replicas: number; + ready_replicas: number; + available_replicas: number; + }; + }; + } | null; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + }; + }; + }; + /** Update a deployment */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Deployment sequence number */ + dseq: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + sdl: string; + certificate?: { + certPem: string; + keyPem: string; + }; + }; + }; + }; + }; + responses: { + /** @description Deployment updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + leases: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + status: { + forwarded_ports: { + [key: string]: { + port: number; + externalPort: number; + host?: string; + available?: number; + }[]; + }; + ips: { + [key: string]: { + IP: string; + Port: number; + ExternalPort: number; + Protocol: string; + }[]; + }; + services: { + [key: string]: { + name: string; + available: number; + total: number; + uris: string[]; + observed_generation: number; + replicas: number; + updated_replicas: number; + ready_replicas: number; + available_replicas: number; + }; + }; + } | null; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + }; + }; + }; + post?: never; + /** Close a deployment */ + delete: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Deployment sequence number */ + dseq: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Deployment closed successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + success: boolean; + }; + }; + }; + }; + }; + }; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List deployments with pagination and filtering */ + get: { + parameters: { + query?: { + skip?: number | null; + limit?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns paginated list of deployments */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + deployments: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + leases: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + status: { + forwarded_ports: { + [key: string]: { + port: number; + externalPort: number; + host?: string; + available?: number; + }[]; + }; + ips: { + [key: string]: { + IP: string; + Port: number; + ExternalPort: number; + Protocol: string; + }[]; + }; + services: { + [key: string]: { + name: string; + available: number; + total: number; + uris: string[]; + observed_generation: number; + replicas: number; + updated_replicas: number; + ready_replicas: number; + available_replicas: number; + }; + }; + } | null; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }[]; + pagination: { + total: number; + skip: number; + limit: number; + hasMore: boolean; + }; + }; + }; + }; + }; + }; + }; + put?: never; + /** Create new deployment */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + sdl: string; + /** @description Amount to deposit in dollars (e.g. 5.5) */ + deposit: number; + }; + }; + }; + }; + responses: { + /** @description Create deployment successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + dseq: string; + manifest: string; + signTx: { + code: number; + transactionHash: string; + rawLog: string; + }; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/deposit-deployment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Deposit into a deployment */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + /** @description Deployment sequence number */ + dseq: string; + /** @description Amount to deposit in dollars (e.g. 5.5) */ + deposit: number; + }; + }; + }; + }; + responses: { + /** @description Deposit successful */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + leases: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + status: { + forwarded_ports: { + [key: string]: { + port: number; + externalPort: number; + host?: string; + available?: number; + }[]; + }; + ips: { + [key: string]: { + IP: string; + Port: number; + ExternalPort: number; + Protocol: string; + }[]; + }; + services: { + [key: string]: { + name: string; + available: number; + total: number; + uris: string[]; + observed_generation: number; + replicas: number; + updated_replicas: number; + ready_replicas: number; + available_replicas: number; + }; + }; + } | null; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/addresses/{address}/deployments/{skip}/{limit}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of deployments by owner address. */ + get: { + parameters: { + query?: { + status?: "active" | "closed"; + reverseSorting?: string; + }; + header?: never; + path: { + address: string; + skip: number | null; + limit: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + count: number; + results: { + owner: string; + dseq: string; + status: string; + createdHeight: number; + cpuUnits: number; + gpuUnits: number; + memoryQuantity: number; + storageQuantity: number; + leases: { + id: string; + owner: string; + provider?: { + address: string; + hostUri: string; + }; + dseq: string; + gseq: number; + oseq: number; + state: string; + price: { + denom: string; + amount: string; + }; + }[]; + }[]; + }; + }; + }; + /** @description Invalid address */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/deployment/{owner}/{dseq}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get deployment details */ + get: { + parameters: { + query?: never; + header?: never; + path: { + owner: string; + dseq: components["schemas"]["Deployment DSEQ"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + owner: string; + dseq: string; + balance: number; + denom: string; + status: string; + totalMonthlyCostUDenom: number; + leases: { + gseq: number; + oseq: number; + provider: { + address: string; + hostUri: string; + isDeleted: boolean; + attributes: { + key: string; + value: string; + }[]; + } | null; + status: string; + monthlyCostUDenom: number; + cpuUnits: number; + gpuUnits: number; + memoryQuantity: number; + storageQuantity: number; + }[]; + events: { + txHash: string; + date: string; + type: string; + }[]; + other: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + groups: { + id: { + owner: string; + dseq: string; + gseq: number; + }; + state: string; + group_spec: { + name: string; + requirements: { + signed_by: { + all_of: string[]; + any_of: string[]; + }; + attributes: { + key: string; + value: string; + }[]; + }; + resources: { + resource: { + id: number; + cpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + memory: { + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + storage: { + name: string; + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }[]; + gpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + endpoints: { + kind: string; + sequence_number: number; + }[]; + }; + count: number; + price: { + denom: string; + amount: string; + }; + }[]; + }; + created_at: string; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + }; + /** @description Invalid address or dseq */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Deployment not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/akash/deployment/{version}/deployments/list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List deployments (database fallback) */ + get: { + parameters: { + query?: { + "filters.owner"?: string; + "filters.state"?: "active" | "closed"; + "pagination.offset"?: number | null; + "pagination.limit"?: number | null; + "pagination.key"?: string; + "pagination.count_total"?: string; + "pagination.reverse"?: boolean | null; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns paginated list of deployments from database */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + deployments: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + groups: { + id: { + owner: string; + dseq: string; + gseq: number; + }; + state: string; + group_spec: { + name: string; + requirements: { + signed_by: { + all_of: string[]; + any_of: string[]; + }; + attributes: { + key: string; + value: string; + }[]; + }; + resources: { + resource: { + id: number; + cpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + memory: { + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + storage: { + name: string; + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }[]; + gpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + endpoints: { + kind: string; + sequence_number: number; + }[]; + }; + count: number; + price: { + denom: string; + amount: string; + }; + }[]; + }; + created_at: string; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }[]; + pagination: { + next_key: string | null; + total: string; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/akash/deployment/{version}/deployments/info": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get deployment info (database fallback) */ + get: { + parameters: { + query: { + "id.owner": string; + "id.dseq": string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment info from database */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": + | { + code: number; + message: string; + details: string[]; + } + | { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + groups: { + id: { + owner: string; + dseq: string; + gseq: number; + }; + state: string; + group_spec: { + name: string; + requirements: { + signed_by: { + all_of: string[]; + any_of: string[]; + }; + attributes: { + key: string; + value: string; + }[]; + }; + resources: { + resource: { + id: number; + cpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + memory: { + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + storage: { + name: string; + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }[]; + gpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + endpoints: { + kind: string; + sequence_number: number; + }[]; + }; + count: number; + price: { + denom: string; + amount: string; + }; + }[]; + }; + created_at: string; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + /** @description Deployment not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/weekly-cost": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get weekly deployment cost */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns weekly cost for all deployments with auto top-up enabled */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** @description Total weekly cost in USD for all deployments with auto top-up enabled */ + weeklyCost: number; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/leases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Create leases and send manifest */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + manifest: string; + certificate?: { + certPem: string; + keyPem: string; + }; + leases: { + dseq: string; + gseq: number; + oseq: number; + provider: string; + }[]; + }; + }; + }; + responses: { + /** @description Leases created and manifest sent */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + deployment: { + id: { + owner: string; + dseq: string; + }; + state: string; + hash: string; + created_at: string; + }; + leases: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + status: { + forwarded_ports: { + [key: string]: { + port: number; + externalPort: number; + host?: string; + available?: number; + }[]; + }; + ips: { + [key: string]: { + IP: string; + Port: number; + ExternalPort: number; + Protocol: string; + }[]; + }; + services: { + [key: string]: { + name: string; + available: number; + total: number; + uris: string[]; + observed_generation: number; + replicas: number; + updated_replicas: number; + ready_replicas: number; + available_replicas: number; + }; + }; + } | null; + }[]; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/akash/market/{version}/leases/list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List leases (database fallback) */ + get: { + parameters: { + query?: { + "filters.owner"?: string; + "filters.dseq"?: string; + "filters.gseq"?: number | null; + "filters.oseq"?: number | null; + "filters.provider"?: string; + "filters.state"?: string; + "pagination.offset"?: number | null; + "pagination.limit"?: number | null; + "pagination.key"?: string; + "pagination.count_total"?: string; + "pagination.reverse"?: boolean | null; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns paginated list of leases from database */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + leases: { + lease: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + closed_on: string; + reason?: string; + }; + escrow_payment: { + id: { + aid: { + scope: string; + xid: string; + }; + xid: string; + }; + state: { + owner: string; + state: string; + rate: { + denom: string; + amount: string; + }; + balance: { + denom: string; + amount: string; + }; + unsettled: { + denom: string; + amount: string; + }; + withdrawn: { + denom: string; + amount: string; + }; + }; + }; + }[]; + pagination: { + next_key: string | null; + total: string; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/api-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List all API keys */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns list of API keys */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + name: string; + /** Format: date-time */ + expiresAt: string | null; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + /** Format: date-time */ + lastUsedAt: string | null; + keyFormat: string; + }[]; + }; + }; + }; + }; + }; + put?: never; + /** Create new API key */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + name: string; + /** Format: date-time */ + expiresAt?: string; + }; + }; + }; + }; + responses: { + /** @description API key created successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + name: string; + /** Format: date-time */ + expiresAt: string | null; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + /** Format: date-time */ + lastUsedAt: string | null; + keyFormat: string; + apiKey: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/api-keys/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get API key by ID */ + get: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns API key details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + name: string; + /** Format: date-time */ + expiresAt: string | null; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + /** Format: date-time */ + lastUsedAt: string | null; + keyFormat: string; + }; + }; + }; + }; + /** @description API key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message: string; + }; + }; + }; + }; + }; + put?: never; + post?: never; + /** Delete API key */ + delete: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description API key deleted successfully */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description API key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message: string; + }; + }; + }; + }; + }; + options?: never; + head?: never; + /** Update API key */ + patch: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + name?: string; + }; + }; + }; + }; + responses: { + /** @description API key updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + /** Format: uuid */ + id: string; + name: string; + /** Format: date-time */ + expiresAt: string | null; + /** Format: date-time */ + createdAt: string; + /** Format: date-time */ + updatedAt: string; + /** Format: date-time */ + lastUsedAt: string | null; + keyFormat: string; + }; + }; + }; + }; + /** @description API key not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message: string; + }; + }; + }; + }; + }; + trace?: never; + }; + "/v1/bids": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List bids */ + get: { + parameters: { + query: { + dseq: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of bids */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + bid: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + resources_offer: { + resources: { + cpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + gpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + memory: { + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + storage: { + name: string; + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }[]; + endpoints: { + kind: string; + sequence_number: number; + }[]; + }; + count: number; + }[]; + }; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + isCertificateRequired: boolean; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/bids/{dseq}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List bids by dseq */ + get: { + parameters: { + query?: never; + header?: never; + path: { + dseq: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of bids */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + bid: { + id: { + owner: string; + dseq: string; + gseq: number; + oseq: number; + provider: string; + bseq: number; + }; + state: string; + price: { + denom: string; + amount: string; + }; + created_at: string; + resources_offer: { + resources: { + cpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + gpu: { + units: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + memory: { + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }; + storage: { + name: string; + quantity: { + val: string; + }; + attributes: { + key: string; + value: string; + }[]; + }[]; + endpoints: { + kind: string; + sequence_number: number; + }[]; + }; + count: number; + }[]; + }; + escrow_account: { + id: { + scope: string; + xid: string; + }; + state: { + owner: string; + state: string; + transferred: { + denom: string; + amount: string; + }[]; + settled_at: string; + funds: { + denom: string; + amount: string; + }[]; + deposits: { + owner: string; + height: string; + source: string; + balance: { + denom: string; + amount: string; + }; + }[]; + }; + }; + isCertificateRequired: boolean; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/certificates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Create certificate */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Certificate created */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + certPem: string; + pubkeyPem: string; + encryptedKey: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/balances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get user balances */ + get: { + parameters: { + query?: { + /** @description Optional wallet address to fetch balances for instead of the current user */ + address?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns user balances */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + balance: number; + deployments: number; + total: number; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of providers. */ + get: { + parameters: { + query?: { + scope?: "all" | "trial"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a list of providers */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + owner: string; + name: string | null; + hostUri: string; + createdHeight: number; + email?: string | null; + website?: string | null; + lastCheckDate?: string | null; + deploymentCount?: number | null; + leaseCount?: number | null; + cosmosSdkVersion: string; + akashVersion: string; + ipRegion: string | null; + ipRegionCode: string | null; + ipCountry: string | null; + ipCountryCode: string | null; + ipLat: string | null; + ipLon: string | null; + uptime1d: number | null; + uptime7d: number | null; + uptime30d: number | null; + isValidVersion: boolean; + isOnline: boolean; + lastOnlineDate: string | null; + isAudited: boolean; + activeStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + pendingStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + availableStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + gpuModels: { + vendor: string; + model: string; + ram: string; + interface: string; + }[]; + attributes: { + key: string; + value: string; + auditedBy: string[]; + }[]; + host: string | null; + organization: string | null; + statusPage: string | null; + locationRegion: string | null; + country: string | null; + city: string | null; + timezone: string | null; + locationType: string | null; + hostingProvider: string | null; + hardwareCpu: string | null; + hardwareCpuArch: string | null; + hardwareGpuVendor: string | null; + hardwareGpuModels: string[] | null; + hardwareDisk: string[] | null; + featPersistentStorage: boolean; + featPersistentStorageType: string[] | null; + hardwareMemory: string | null; + networkProvider: string | null; + networkSpeedDown: number; + networkSpeedUp: number; + tier: string | null; + featEndpointCustomDomain: boolean; + workloadSupportChia: boolean; + workloadSupportChiaCapabilities: string[] | null; + featEndpointIp: boolean; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/providers/{address}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a provider details. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + address: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return a provider details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + owner: string; + name: string; + hostUri: string; + createdHeight: number; + email: string | null; + website: string | null; + lastCheckDate: string | null; + deploymentCount: number; + leaseCount: number; + cosmosSdkVersion: string; + akashVersion: string; + ipRegion: string | null; + ipRegionCode: string | null; + ipCountry: string | null; + ipCountryCode: string | null; + ipLat: string | null; + ipLon: string | null; + uptime1d: number; + uptime7d: number; + uptime30d: number; + isValidVersion: boolean; + isOnline: boolean; + lastOnlineDate: string | null; + isAudited: boolean; + stats: { + cpu: { + active: number; + available: number; + pending: number; + }; + gpu: { + active: number; + available: number; + pending: number; + }; + memory: { + active: number; + available: number; + pending: number; + }; + storage: { + ephemeral: { + active: number; + available: number; + pending: number; + }; + persistent: { + active: number; + available: number; + pending: number; + }; + }; + }; + activeStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + pendingStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + availableStats: { + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + gpuModels: { + vendor: string; + model: string; + ram: string; + interface: string; + }[]; + attributes: { + key: string; + value: string; + auditedBy: string[]; + }[]; + host: string | null; + organization: string | null; + statusPage: string | null; + locationRegion: string | null; + country: string | null; + city: string | null; + timezone: string | null; + locationType: string | null; + hostingProvider: string | null; + hardwareCpu: string | null; + hardwareCpuArch: string | null; + hardwareGpuVendor: string | null; + hardwareGpuModels: string[]; + hardwareDisk: string[]; + featPersistentStorage: boolean; + featPersistentStorageType: string[]; + hardwareMemory: string | null; + networkProvider: string | null; + networkSpeedDown: number; + networkSpeedUp: number; + tier: string | null; + featEndpointCustomDomain: boolean; + workloadSupportChia: boolean; + workloadSupportChiaCapabilities: string[]; + featEndpointIp: boolean; + uptime: { + id: string; + isOnline: boolean; + checkDate: string; + }[]; + }; + }; + }; + /** @description Invalid address */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Provider not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/providers/{providerAddress}/active-leases-graph-data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + providerAddress: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a provider's active leases graph data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + currentValue: number; + compareValue: number; + snapshots: { + /** @example 2021-07-01T00:00:00.000Z */ + date: string; + /** @example 100 */ + value: number; + }[]; + now: { + /** @example 100 */ + count: number; + }; + compare: { + /** @example 100 */ + count: number; + }; + }; + }; + }; + /** @description Invalid address */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/auditors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of auditors. */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of auditors */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id: string; + name: string; + address: string; + website: string; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-attributes-schema": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get the provider attributes schema */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return the provider attributes schema */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + host: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + email: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + organization: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + website: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + tier: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "status-page": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "location-region": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + country: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + city: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + timezone: { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "location-type": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hosting-provider": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-cpu": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-cpu-arch": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-gpu": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-gpu-model": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-disk": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "hardware-memory": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "network-provider": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "network-speed-up": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "network-speed-down": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "feat-persistent-storage": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "feat-persistent-storage-type": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "workload-support-chia": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "workload-support-chia-capabilities": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "feat-endpoint-ip": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + "feat-endpoint-custom-domain": { + key: string; + /** @enum {string} */ + type: "string" | "number" | "boolean" | "option" | "multiple-option"; + required: boolean; + description: string; + values?: + | { + key: string; + description: string; + value?: unknown; + }[] + | null; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-regions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of provider regions */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return a list of provider regions */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + providers: string[]; + key: string; + description: string; + value?: string; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-dashboard/{owner}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get dashboard data for provider console. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + owner: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Dashboard data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + current: { + date: string; + height: number; + activeLeaseCount: number; + totalLeaseCount: number; + dailyLeaseCount: number; + totalUAktEarned: number; + dailyUAktEarned: number; + totalUUsdcEarned: number; + dailyUUsdcEarned: number; + totalUUsdEarned: number; + dailyUUsdEarned: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeEphemeralStorage: number; + activePersistentStorage: number; + activeStorage: number; + }; + previous: { + date: string; + height: number; + activeLeaseCount: number; + totalLeaseCount: number; + dailyLeaseCount: number; + totalUAktEarned: number; + dailyUAktEarned: number; + totalUUsdcEarned: number; + dailyUUsdcEarned: number; + totalUUsdEarned: number; + dailyUUsdEarned: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeEphemeralStorage: number; + activePersistentStorage: number; + activeStorage: number; + }; + }; + }; + }; + /** @description Provider not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-earnings/{owner}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get earnings data for provider console. */ + get: { + parameters: { + query: { + from: string; + to: string; + }; + header?: never; + path: { + owner: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Earnings data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + earnings: { + totalUAktEarned: number; + totalUUsdcEarned: number; + totalUUsdEarned: number; + }; + }; + }; + }; + /** @description Provider not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get providers grouped by version. */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of providers grouped by version. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: { + version: string; + count: number; + ratio: number; + providers: string[]; + }; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/provider-graph-data/{dataName}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + dataName: "count" | "cpu" | "gpu" | "memory" | "storage"; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns provider graph data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + currentValue: number; + compareValue: number; + snapshots: { + /** @example 2021-07-01T00:00:00.000Z */ + date: string; + /** @example 100 */ + value: number; + }[]; + now?: { + /** @example 100 */ + count: number; + /** @example 100 */ + cpu: number; + /** @example 100 */ + gpu: number; + /** @example 100 */ + memory: number; + /** @example 100 */ + storage: number; + }; + compare?: { + /** @example 100 */ + count: number; + /** @example 100 */ + cpu: number; + /** @example 100 */ + gpu: number; + /** @example 100 */ + memory: number; + /** @example 100 */ + storage: number; + }; + }; + }; + }; + /** @description Graph data not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/providers/{provider}/deployments/{skip}/{limit}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of deployments for a provider. */ + get: { + parameters: { + query?: { + status?: "active" | "closed"; + }; + header?: never; + path: { + provider: string; + skip: number | null; + limit: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns deployment list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total: number; + deployments: { + owner: string; + dseq: string; + denom: string; + createdHeight: number; + createdDate: string | null; + status: string; + balance: number; + transferred: number; + settledAt: number | null; + resources: { + cpu: number; + memory: number; + gpu: number; + ephemeralStorage: number; + persistentStorage: number; + }; + leases: { + provider: string; + gseq: number; + oseq: number; + price: number; + createdHeight: number; + createdDate: string | null; + closedHeight: number | null; + closedDate: string | null; + status: string; + resources: { + cpu: number; + memory: number; + gpu: number; + ephemeralStorage: number; + persistentStorage: number; + }; + }[]; + }[]; + }; + }; + }; + /** @description Invalid status filter */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/create-jwt-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Create new JWT token for managed wallet */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + ttl: number; + leases: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description JWT token created successfully */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + token: string; + }; + }; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/graph-data/{dataName}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + dataName: + | "dailyUAktSpent" + | "dailyUUsdcSpent" + | "dailyUUsdSpent" + | "dailyLeaseCount" + | "totalUAktSpent" + | "totalUUsdcSpent" + | "totalUUsdSpent" + | "activeLeaseCount" + | "totalLeaseCount" + | "activeCPU" + | "activeGPU" + | "activeMemory" + | "activeStorage" + | "gpuUtilization"; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns graph data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + currentValue: number; + compareValue: number; + snapshots: { + /** @example 2021-07-01T00:00:00.000Z */ + date: string; + /** @example 100 */ + value: number; + }[]; + }; + }; + }; + /** @description Graph data not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/dashboard-data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns dashboard data */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + chainStats: { + height: number; + transactionCount: number; + bondedTokens: number; + totalSupply: number; + communityPool: number; + inflation: number; + stakingAPR?: number; + }; + now: { + date: string; + height: number; + activeLeaseCount: number; + totalLeaseCount: number; + dailyLeaseCount: number; + totalUAktSpent: number; + dailyUAktSpent: number; + totalUUsdcSpent: number; + dailyUUsdcSpent: number; + totalUUsdSpent: number; + dailyUUsdSpent: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeStorage: number; + }; + compare: { + date: string; + height: number; + activeLeaseCount: number; + totalLeaseCount: number; + dailyLeaseCount: number; + totalUAktSpent: number; + dailyUAktSpent: number; + totalUUsdcSpent: number; + dailyUUsdcSpent: number; + totalUUsdSpent: number; + dailyUUsdSpent: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeStorage: number; + }; + networkCapacity: { + activeProviderCount: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeStorage: number; + pendingCPU: number; + pendingGPU: number; + pendingMemory: number; + pendingStorage: number; + availableCPU: number; + availableGPU: number; + availableMemory: number; + availableStorage: number; + totalCPU: number; + totalGPU: number; + totalMemory: number; + totalStorage: number; + activeEphemeralStorage: number; + pendingEphemeralStorage: number; + availableEphemeralStorage: number; + activePersistentStorage: number; + pendingPersistentStorage: number; + availablePersistentStorage: number; + }; + networkCapacityStats: { + currentValue: number; + compareValue: number; + snapshots: { + date: string; + value: number; + }[]; + now: { + count: number; + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + compare: { + count: number; + cpu: number; + gpu: number; + memory: number; + storage: number; + }; + }; + latestBlocks: { + height: number; + proposer: { + address: string; + operatorAddress: string; + moniker: string | null; + avatarUrl: string | null; + }; + transactionCount: number; + totalTransactionCount: number; + datetime: string; + }[]; + latestTransactions: { + height: number; + datetime: string; + hash: string; + isSuccess: boolean; + error: string | null; + gasUsed: number; + gasWanted: number; + fee: number; + memo: string; + messages: { + id: string; + type: string; + amount: number; + }[]; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/network-capacity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns network capacity stats */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + activeProviderCount: number; + activeCPU: number; + activeGPU: number; + activeMemory: number; + activeStorage: number; + pendingCPU: number; + pendingGPU: number; + pendingMemory: number; + pendingStorage: number; + availableCPU: number; + availableGPU: number; + availableMemory: number; + availableStorage: number; + totalCPU: number; + totalGPU: number; + totalMemory: number; + totalStorage: number; + activeEphemeralStorage: number; + pendingEphemeralStorage: number; + availableEphemeralStorage: number; + activePersistentStorage: number; + pendingPersistentStorage: number; + availablePersistentStorage: number; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of recent blocks. */ + get: { + parameters: { + query?: { + limit?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns block list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + height: number; + proposer: { + address: string; + operatorAddress: string; + moniker: string; + avatarUrl: string | null; + }; + transactionCount: number; + totalTransactionCount: number; + datetime: string; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/blocks/{height}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a block by height. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + height: number | null; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns predicted block date */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + height: number; + datetime: string; + proposer: { + operatorAddress: string; + moniker: string; + avatarUrl?: string; + address: string; + }; + hash: string; + gasUsed: number; + gasWanted: number; + transactions: { + hash: string; + isSuccess: boolean; + error?: string | null; + fee: number; + datetime: string; + messages: { + id: string; + type: string; + amount: number; + }[]; + }[]; + }; + }; + }; + /** @description Invalid height */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Block not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/predicted-block-date/{height}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get the estimated date of a future block. */ + get: { + parameters: { + query?: { + blockWindow?: number; + }; + header?: never; + path: { + height: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns predicted block date */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + predictedDate: string; + /** @example 10000000 */ + height: number; + /** @example 10000 */ + blockWindow: number; + }; + }; + }; + /** @description Invalid height or block window */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/predicted-date-height/{timestamp}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get the estimated height of a future date and time. */ + get: { + parameters: { + query?: { + blockWindow?: number; + }; + header?: never; + path: { + timestamp: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns predicted block height */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 10000000 */ + predictedHeight: number; + /** @example 2024-01-04T18:29:28.000Z */ + date: string; + /** @example 10000 */ + blockWindow: number; + }; + }; + }; + /** @description Invalid timestamp or block window */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of transactions. */ + get: { + parameters: { + query?: { + limit?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns transaction list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + height: number; + datetime: string; + hash: string; + isSuccess: boolean; + error: string | null; + gasUsed: number; + gasWanted: number; + fee: number; + memo: string; + messages: { + id: string; + type: string; + amount: number; + }[]; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/transactions/{hash}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a transaction by hash. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + hash: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns predicted block date */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + height: number; + datetime: string; + hash: string; + isSuccess: boolean; + multisigThreshold?: number; + signers: string[]; + error: string | null; + gasUsed: number; + gasWanted: number; + fee: number; + memo: string; + messages: { + id: string; + type: string; + data: { + [key: string]: string; + }; + relatedDeploymentId?: string | null; + }[]; + }; + }; + }; + /** @description Transaction not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/market-data/{coin}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + coin: "akash-network" | "usd-coin"; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns market stats */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + price: number; + volume: number; + marketCap: number; + marketCapRank: number; + priceChange24h: number; + priceChangePercentage24: number; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/validators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns validators */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + operatorAddress: string; + moniker: string; + votingPower: number; + commission: number; + identity: string; + votingPowerRatio: number; + rank: number; + keybaseAvatarUrl: string | null; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/validators/{address}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + address: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return a validator information */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + operatorAddress: string; + address: string | null; + moniker: string; + keybaseUsername: string | null; + keybaseAvatarUrl: string | null; + votingPower: number; + commission: number; + maxCommission: number; + maxCommissionChange: number; + identity: string; + description: string; + website: string; + rank: number; + }; + }; + }; + /** @description Invalid address */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Validator not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/pricing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Estimate the price of a deployment on akash and other cloud providers. */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Deployment specs to use for the price estimation. **An array of specs can also be sent, in that case an array of estimations will be returned in the same order.** */ + requestBody?: { + content: { + "application/json": + | { + /** + * @description CPU in thousandths of a core. 1000 = 1 core + * @example 1000 + */ + cpu: number; + /** + * @description Memory in bytes + * @example 1000000000 + */ + memory: number; + /** + * @description Storage in bytes + * @example 1000000000 + */ + storage: number; + } + | { + /** + * @description CPU in thousandths of a core. 1000 = 1 core + * @example 1000 + */ + cpu: number; + /** + * @description Memory in bytes + * @example 1000000000 + */ + memory: number; + /** + * @description Storage in bytes + * @example 1000000000 + */ + storage: number; + }[]; + }; + }; + responses: { + /** @description Returns a list of deployment templates grouped by cateogories */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": + | { + spec: { + /** + * @description CPU in thousandths of a core. 1000 = 1 core + * @example 1000 + */ + cpu: number; + /** + * @description Memory in bytes + * @example 1000000000 + */ + memory: number; + /** + * @description Storage in bytes + * @example 1000000000 + */ + storage: number; + }; + /** @description Akash price estimation (USD/month) */ + akash: number; + /** @description AWS price estimation (USD/month) */ + aws: number; + /** @description GCP price estimation (USD/month) */ + gcp: number; + /** @description Azure price estimation (USD/month) */ + azure: number; + } + | { + spec: { + /** + * @description CPU in thousandths of a core. 1000 = 1 core + * @example 1000 + */ + cpu: number; + /** + * @description Memory in bytes + * @example 1000000000 + */ + memory: number; + /** + * @description Storage in bytes + * @example 1000000000 + */ + storage: number; + }; + /** @description Akash price estimation (USD/month) */ + akash: number; + /** @description AWS price estimation (USD/month) */ + aws: number; + /** @description GCP price estimation (USD/month) */ + gcp: number; + /** @description Azure price estimation (USD/month) */ + azure: number; + }[]; + }; + }; + /** @description Invalid parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/gpu": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of gpu models and their availability. */ + get: { + parameters: { + query?: { + provider?: string; + vendor?: string; + model?: string; + memory_size?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of gpu models and their availability. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + gpus: { + total: { + allocatable: number; + allocated: number; + }; + details: { + [key: string]: { + model: string; + ram: string; + interface: string; + allocatable: number; + allocated: number; + }[]; + }; + }; + }; + }; + }; + /** @description Invalid provider parameter, should be a valid akash address or host uri */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/gpu-models": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of gpu models per. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + name: string; + models: { + name: string; + memory: string[]; + interface: string[]; + }[]; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/gpu-breakdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + get: { + parameters: { + query?: { + vendor?: string; + model?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + date: string; + vendor: string; + model: string; + providerCount: number; + nodeCount: number; + totalGpus: number; + leasedGpus: number; + gpuUtilization: number; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/gpu-prices": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of gpu models with their availability and pricing. */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of gpu models with their availability and pricing. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + availability: { + total: number; + available: number; + }; + models: { + vendor: string; + model: string; + ram: string; + interface: string; + availability: { + total: number; + available: number; + }; + providerAvailability: { + total: number; + available: number; + }; + price: { + /** @example USD */ + currency: string; + min: number; + max: number; + avg: number; + weightedAverage: number; + med: number; + } | null; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/proposals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a list of proposals */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id: number; + title: string; + status: string; + submitTime: string; + votingStartTime: string; + votingEndTime: string; + totalDeposit: number; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/proposals/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + id: number | null; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return a proposal by id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id: number; + title: string; + description: string; + status: string; + submitTime: string; + votingStartTime: string; + votingEndTime: string; + totalDeposit: number; + tally: { + yes: number; + abstain: number; + no: number; + noWithVeto: number; + total: number; + }; + paramChanges: { + subspace: string; + key: string; + value?: unknown; + }[]; + }; + }; + }; + /** @description Invalid proposal id */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Proposal not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a list of deployment templates grouped by categories */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + title: string; + templates: { + id: string; + name: string; + path: string; + logoUrl: string | null; + summary: string; + readme: string; + deploy: string; + persistentStorageEnabled: boolean; + guide?: string; + githubUrl: string; + config: { + ssh?: boolean; + }; + }[]; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/templates-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a list of deployment templates grouped by categories */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + title: string; + templates: { + id: string; + name: string; + path: string; + logoUrl: string | null; + summary: string; + readme: string; + deploy: string; + persistentStorageEnabled: boolean; + guide?: string; + githubUrl: string; + config: { + ssh?: boolean; + }; + }[]; + }[]; + }; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/templates/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Return a template by id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: { + id: string; + name: string; + path: string; + logoUrl: string | null; + summary: string; + readme: string; + deploy: string; + persistentStorageEnabled: boolean; + guide?: string; + githubUrl: string; + config: { + ssh?: boolean; + }; + }; + }; + }; + }; + /** @description Template not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/leases-duration/{owner}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get leases durations. */ + get: { + parameters: { + query?: { + dseq?: string; + startDate?: string; + endDate?: string; + }; + header?: never; + path: { + owner: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of leases durations and total duration. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + leaseCount: number; + totalDurationInSeconds: number; + totalDurationInHours: number; + leases: { + dseq: string; + oseq: number; + gseq: number; + provider: string; + startHeight: number; + startDate: string; + closedHeight: number; + closedDate: string; + durationInBlocks: number; + durationInSeconds: number; + durationInHours: number; + }[]; + }; + }; + }; + /** @description Invalid start date, must be in the following format: YYYY-MM-DD */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/addresses/{address}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get address details */ + get: { + parameters: { + query?: never; + header?: never; + path: { + address: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns address details */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total: number; + delegations: { + validator: { + address?: string; + moniker?: string; + operatorAddress?: string; + avatarUrl?: string; + }; + amount: number; + reward: number | null; + }[]; + available: number; + delegated: number; + rewards: number; + assets: { + symbol?: string; + ibcToken?: string; + logoUrl?: string; + description?: string; + amount: number; + }[]; + redelegations: { + srcAddress: { + address?: string; + moniker?: string; + operatorAddress?: string; + avatarUrl?: string; + }; + dstAddress: { + address?: string; + moniker?: string; + operatorAddress?: string; + avatarUrl?: string; + }; + creationHeight: number; + completionTime: string; + amount: number; + }[]; + commission: number; + latestTransactions: { + height: number; + datetime: string; + hash: string; + isSuccess: boolean; + error: string | null; + gasUsed: number; + gasWanted: number; + fee: number; + memo: string | null; + isSigner: boolean; + messages: { + id: string; + type: string; + amount: number; + isReceiver: boolean; + }[]; + }[]; + }; + }; + }; + /** @description Invalid address */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/addresses/{address}/transactions/{skip}/{limit}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of transactions for a given address. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + address: string; + skip: number | null; + limit: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns transaction list */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + count: number; + results: { + height: number; + datetime: string; + hash: string; + isSuccess: boolean; + error: string | null; + gasUsed: number; + gasWanted: number; + fee: number; + memo: string | null; + isSigner: boolean; + messages: { + id: string; + type: string; + amount: number; + isReceiver: boolean; + }[]; + }[]; + }; + }; + }; + /** @description Invalid address or parameters */ + 400: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/nodes/{network}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a list of nodes (api/rpc) for a specific network. */ + get: { + parameters: { + query?: never; + header?: never; + path: { + network: "mainnet" | "testnet" | "sandbox"; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description List of nodes */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id: string; + api: string; + rpc: string; + }[]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getAlerts"]; + put?: never; + post: operations["createAlert"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/alerts/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getAlert"]; + put?: never; + post?: never; + delete: operations["deleteAlert"]; + options?: never; + head?: never; + patch: operations["patchAlert"]; + trace?: never; + }; + "/v1/notification-channels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getNotificationChannels"]; + put?: never; + post: operations["createNotificationChannel"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/notification-channels/default": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post: operations["createDefaultChannel"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/notification-channels/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getNotificationChannel"]; + put?: never; + post?: never; + delete: operations["deleteNotificationChannel"]; + options?: never; + head?: never; + patch: operations["patchNotificationChannel"]; + trace?: never; + }; + "/v1/deployment-alerts/{dseq}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getDeploymentAlerts"]; + put?: never; + post: operations["upsertDeploymentAlert"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + "Deployment DSEQ": string; + AlertCreateInput: { + data: + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + /** @default true */ + enabled: boolean; + summary: string; + description: string; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_MESSAGE"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + /** @default true */ + enabled: boolean; + summary: string; + description: string; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_EVENT"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + /** @default true */ + enabled: boolean; + summary: string; + description: string; + /** @enum {string} */ + type: "DEPLOYMENT_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + dseq: string; + owner: string; + suppressedBySystem?: boolean; + }; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + /** @default true */ + enabled: boolean; + summary: string; + description: string; + /** @enum {string} */ + type: "WALLET_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + owner: string; + denom: string; + suppressedBySystem?: boolean; + }; + }; + }; + AlertOutputResponse: { + data: + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_MESSAGE"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_EVENT"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + /** @enum {string} */ + type: "DEPLOYMENT_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + dseq: string; + owner: string; + suppressedBySystem?: boolean; + }; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + /** @enum {string} */ + type: "WALLET_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + owner: string; + denom: string; + suppressedBySystem?: boolean; + }; + }; + }; + ValidationErrorResponse: { + statusCode: number; + message: string; + errors: { + issues: Record[]; + }; + }; + UnauthorizedErrorResponse: { + statusCode: number; + message: string; + }; + ForbiddenErrorResponse: { + statusCode: number; + message: string; + }; + InternalServerErrorResponse: { + statusCode: number; + message: string; + }; + AlertListOutputResponse: { + data: ( + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_MESSAGE"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + params?: { + dseq: string; + type: string; + suppressedBySystem?: boolean; + }; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }; + /** @enum {string} */ + type: "CHAIN_EVENT"; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + /** @enum {string} */ + type: "DEPLOYMENT_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + dseq: string; + owner: string; + suppressedBySystem?: boolean; + }; + } + | { + /** Format: uuid */ + notificationChannelId: string; + name: string; + enabled: boolean; + summary: string; + description: string; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + notificationChannelName?: string; + status: string; + createdAt: unknown; + updatedAt: unknown; + /** @enum {string} */ + type: "WALLET_BALANCE"; + conditions: + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }; + params: { + owner: string; + denom: string; + suppressedBySystem?: boolean; + }; + } + )[]; + pagination: { + page: number; + limit: number; + total: number; + totalPages: number; + hasNextPage: boolean; + hasPreviousPage: boolean; + }; + }; + AlertPatchInput: { + data: { + /** Format: uuid */ + notificationChannelId?: string; + name?: string; + /** @default true */ + enabled: boolean; + summary?: string; + description?: string; + conditions?: + | ( + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + field: string; + value: string | number | boolean; + } + ) + | ( + | { + /** @enum {string} */ + operator: "and"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + /** @enum {string} */ + operator: "or"; + value: { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + }[]; + } + | { + operator: "eq" | "lt" | "gt" | "lte" | "gte"; + /** @enum {string} */ + field: "balance"; + value: number; + } + ); + }; + }; + NotificationChannelCreateInput: { + data: { + name: string; + /** @enum {string} */ + type: "email"; + config: { + addresses: string[]; + }; + isDefault?: boolean; + }; + }; + NotificationChannelOutput: { + data: { + name: string; + /** @enum {string} */ + type: "email"; + config: { + addresses: string[]; + }; + isDefault: boolean; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + createdAt: unknown; + updatedAt: unknown; + }; + }; + NotificationChannelCreateDefaultInput: { + data: { + name: string; + /** @enum {string} */ + type: "email"; + config: { + addresses: string[]; + }; + }; + }; + NotFoundErrorResponse: { + statusCode: number; + message: string; + }; + NotificationChannelListOutput: { + data: { + name: string; + /** @enum {string} */ + type: "email"; + config: { + addresses: string[]; + }; + isDefault: boolean; + /** Format: uuid */ + id: string; + /** Format: uuid */ + userId: string; + createdAt: unknown; + updatedAt: unknown; + }[]; + pagination: { + page: number; + limit: number; + total: number; + totalPages: number; + hasNextPage: boolean; + hasPreviousPage: boolean; + }; + }; + NotificationChannelPatchInput: { + data: { + name?: string; + /** @enum {string} */ + type?: "email"; + config?: { + addresses: string[]; + }; + }; + }; + DeploymentAlertCreateInput: { + data: { + alerts: { + deploymentBalance?: { + /** Format: uuid */ + notificationChannelId: string; + /** @default true */ + enabled: boolean; + threshold: number; + }; + deploymentClosed?: { + /** Format: uuid */ + notificationChannelId: string; + /** @default true */ + enabled: boolean; + }; + }; + }; + }; + DeploymentAlertsResponse: { + data: { + dseq: string; + owner?: string; + alerts: { + deploymentBalance?: { + /** Format: uuid */ + notificationChannelId: string; + /** @default true */ + enabled: boolean; + threshold: number; + /** Format: uuid */ + id: string; + status: string; + suppressedBySystem?: boolean; + }; + deploymentClosed?: { + /** Format: uuid */ + notificationChannelId: string; + /** @default true */ + enabled: boolean; + /** Format: uuid */ + id: string; + status: string; + suppressedBySystem?: boolean; + }; + }; + }; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + getAlerts: { + parameters: { + query?: { + /** @description Number of items per page */ + limit?: number; + /** @description Page number */ + page?: number; + /** @description Chain message type, used in conjunction with dseq to filter alerts liked to a specific deployment */ + type?: string; + /** @description Linked deployment's dseq */ + dseq?: string; + }; + header?: { + Authorization?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the list of alerts */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AlertListOutputResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + createAlert: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["AlertCreateInput"]; + }; + }; + responses: { + /** @description Returns the created alert */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AlertOutputResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + getAlert: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the requested alert by id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AlertOutputResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + deleteAlert: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the deleted alert */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AlertOutputResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + patchAlert: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["AlertPatchInput"]; + }; + }; + responses: { + /** @description Returns the updated alert */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AlertOutputResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + getNotificationChannels: { + parameters: { + query?: { + /** @description Number of items per page */ + limit?: number; + /** @description Page number */ + page?: number; + }; + header?: { + Authorization?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a paginated list of notification channels */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationChannelListOutput"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + createNotificationChannel: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationChannelCreateInput"]; + }; + }; + responses: { + /** @description Returns the created notification channel */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationChannelOutput"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + createDefaultChannel: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationChannelCreateDefaultInput"]; + }; + }; + responses: { + /** @description Creates the default notification channel only if it doesn't exist. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNotificationChannel: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the requested notification channel by id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationChannelOutput"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Returns 404 if the notification channel is not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotFoundErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + deleteNotificationChannel: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns the deleted notification channel */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationChannelOutput"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Returns 404 if the notification channel is not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotFoundErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + patchNotificationChannel: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationChannelPatchInput"]; + }; + }; + responses: { + /** @description Returns the updated notification channel */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationChannelOutput"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Returns 404 if the notification channel is not found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotFoundErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + getDeploymentAlerts: { + parameters: { + query?: never; + header?: { + Authorization?: string; + }; + path: { + dseq: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns alerts for the specified deployment */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeploymentAlertsResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; + upsertDeploymentAlert: { + parameters: { + query?: never; + header?: { + /** @description The address of the user who owns the deployment */ + "x-owner-address"?: string; + Authorization?: string; + }; + path: { + dseq: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeploymentAlertCreateInput"]; + }; + }; + responses: { + /** @description Returns the created alert */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeploymentAlertsResponse"]; + }; + }; + /** @description Validation error responded when some request parameters are invalid */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ValidationErrorResponse"]; + }; + }; + /** @description Unauthorized error responded when the user is not authenticated */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["UnauthorizedErrorResponse"]; + }; + }; + /** @description Forbidden error responded when the user is not authorized */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ForbiddenErrorResponse"]; + }; + }; + /** @description Internal server error, should probably be reported */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InternalServerErrorResponse"]; + }; + }; + }; + }; +} diff --git a/packages/react-query-sdk/src/api/services/AkashService.ts b/packages/react-query-sdk/src/api/services/AkashService.ts new file mode 100644 index 0000000000..b7b4fa9f8a --- /dev/null +++ b/packages/react-query-sdk/src/api/services/AkashService.ts @@ -0,0 +1,2346 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +import type { + DeepReadonly, + InvalidateQueryFilters, + OperationInfiniteData, + PartialParameters, + QraftServiceOperationsToken, + QueryFiltersByParameters, + QueryFiltersByQueryKey, + QueryFnOptionsByParameters, + QueryFnOptionsByQueryKey, + RequestFnResponse, + ServiceOperationEnsureInfiniteQueryDataOptions, + ServiceOperationEnsureQueryDataOptions, + ServiceOperationFetchInfiniteQueryOptions, + ServiceOperationFetchQueryOptions, + ServiceOperationInfiniteQueryKey, + ServiceOperationQueryKey, + UseQueryOptionsForUseQueries, + UseQueryOptionsForUseSuspenseQuery, + WithOptional +} from "@openapi-qraft/tanstack-query-react-types"; +import type { + CancelOptions, + InfiniteQueryPageParamsOptions, + InvalidateOptions, + NoInfer, + QueryState, + RefetchOptions, + ResetOptions, + SetDataOptions, + Updater +} from "@tanstack/query-core"; +import type { + DefinedInitialDataInfiniteOptions, + DefinedInitialDataOptions, + DefinedUseInfiniteQueryResult, + DefinedUseQueryResult, + UndefinedInitialDataInfiniteOptions, + UndefinedInitialDataOptions, + UseInfiniteQueryResult, + UseQueryResult, + UseSuspenseInfiniteQueryOptions, + UseSuspenseInfiniteQueryResult, + UseSuspenseQueryOptions, + UseSuspenseQueryResult +} from "@tanstack/react-query"; + +import type { paths } from "../schema"; +export interface AkashService { + /** @summary List deployments (database fallback) */ + getDeploymentVersionDeploymentsList: { + /** @summary List deployments (database fallback) */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + >, + options?: CancelOptions + ): Promise; + /** @summary List deployments (database fallback) */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary List deployments (database fallback) */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise>; + /** @summary List deployments (database fallback) */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise; + /** @summary List deployments (database fallback) */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise>; + /** @summary List deployments (database fallback) */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise; + /** @summary List deployments (database fallback) */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise; + /** @summary List deployments (database fallback) */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > | void + ): Promise; + /** @summary List deployments (database fallback) */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary List deployments (database fallback) */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetDeploymentVersionDeploymentsListData | undefined + ] + >; + /** @summary List deployments (database fallback) */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetDeploymentVersionDeploymentsListData | undefined; + /** @summary List deployments (database fallback) */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary List deployments (database fallback) */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): + | QueryState< + OperationInfiniteData, + GetDeploymentVersionDeploymentsListError + > + | undefined; + /** @summary List deployments (database fallback) */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + >, + options?: InvalidateOptions + ): Promise; + /** @summary List deployments (database fallback) */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + ): number; + /** @summary List deployments (database fallback) */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetDeploymentVersionDeploymentsListSchema, + options: { + parameters: GetDeploymentVersionDeploymentsListParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List deployments (database fallback) */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + >, + options?: RefetchOptions + ): Promise; + /** @summary List deployments (database fallback) */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + ): void; + /** @summary List deployments (database fallback) */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + >, + options?: ResetOptions + ): Promise; + /** @summary List deployments (database fallback) */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List deployments (database fallback) */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List deployments (database fallback) */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetDeploymentVersionDeploymentsListData | undefined; + /** @summary List deployments (database fallback) */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsList.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentVersionDeploymentsListParameters, + TQueryFnData = GetDeploymentVersionDeploymentsListData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsList.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentVersionDeploymentsListParameters, + TQueryFnData = GetDeploymentVersionDeploymentsListData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentVersionDeploymentsListTotal = qraft.akashService.getDeploymentVersionDeploymentsList.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentVersionDeploymentsListByParametersTotal = qraft.akashService.getDeploymentVersionDeploymentsList.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * "filters.owner": filtersOwner + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListData, + TInfinite, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentVersionDeploymentsListResults = qraft.akashService.getDeploymentVersionDeploymentsList.useQueries({ + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentVersionDeploymentsListCombinedResults = qraft.akashService.getDeploymentVersionDeploymentsList.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsListCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List deployments (database fallback) */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsList.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + OperationInfiniteData, + GetDeploymentVersionDeploymentsListData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetDeploymentVersionDeploymentsListError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentVersionDeploymentsListData = qraft.akashService.getDeploymentVersionDeploymentsList.useSuspenseQueries({ + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentVersionDeploymentsListCombinedData = qraft.akashService.getDeploymentVersionDeploymentsList.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsListCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetDeploymentVersionDeploymentsListSchema, + GetDeploymentVersionDeploymentsListParameters, + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List deployments (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.akashService.getDeploymentVersionDeploymentsList.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.akashService.getDeploymentVersionDeploymentsList.useSuspenseQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentVersionDeploymentsListData, + GetDeploymentVersionDeploymentsListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentVersionDeploymentsListSchema; + types: { + parameters: GetDeploymentVersionDeploymentsListParameters; + data: GetDeploymentVersionDeploymentsListData; + error: GetDeploymentVersionDeploymentsListError; + }; + }; + /** @summary Get deployment info (database fallback) */ + getDeploymentVersionDeploymentsInfo: { + /** @summary Get deployment info (database fallback) */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + >, + options?: CancelOptions + ): Promise; + /** @summary Get deployment info (database fallback) */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get deployment info (database fallback) */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise>; + /** @summary Get deployment info (database fallback) */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise; + /** @summary Get deployment info (database fallback) */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + DeepReadonly, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise>; + /** @summary Get deployment info (database fallback) */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise; + /** @summary Get deployment info (database fallback) */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise; + /** @summary Get deployment info (database fallback) */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): Promise; + /** @summary Get deployment info (database fallback) */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get deployment info (database fallback) */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetDeploymentVersionDeploymentsInfoData | undefined + ] + >; + /** @summary Get deployment info (database fallback) */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetDeploymentVersionDeploymentsInfoData | undefined; + /** @summary Get deployment info (database fallback) */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get deployment info (database fallback) */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState< + OperationInfiniteData, + GetDeploymentVersionDeploymentsInfoError + > + | undefined; + /** @summary Get deployment info (database fallback) */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get deployment info (database fallback) */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): number; + /** @summary Get deployment info (database fallback) */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetDeploymentVersionDeploymentsInfoSchema, + options: { + parameters: GetDeploymentVersionDeploymentsInfoParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get deployment info (database fallback) */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get deployment info (database fallback) */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): void; + /** @summary Get deployment info (database fallback) */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + >, + options?: ResetOptions + ): Promise; + /** @summary Get deployment info (database fallback) */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get deployment info (database fallback) */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get deployment info (database fallback) */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetDeploymentVersionDeploymentsInfoData | undefined; + /** @summary Get deployment info (database fallback) */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useInfiniteQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }, { + * initialPageParam: { + * query: { + * "id.owner": initialIdOwner, + * "id.dseq": initialIdDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentVersionDeploymentsInfoParameters, + TQueryFnData = GetDeploymentVersionDeploymentsInfoData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useInfiniteQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }, { + * initialPageParam: { + * query: { + * "id.owner": initialIdOwner, + * "id.dseq": initialIdDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentVersionDeploymentsInfoParameters, + TQueryFnData = GetDeploymentVersionDeploymentsInfoData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentVersionDeploymentsInfoTotal = qraft.akashService.getDeploymentVersionDeploymentsInfo.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentVersionDeploymentsInfoByParametersTotal = qraft.akashService.getDeploymentVersionDeploymentsInfo.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + | QueryFiltersByQueryKey< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoData, + TInfinite, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentVersionDeploymentsInfoResults = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQueries({ + * queries: [ + * { + * query: { + * "id.owner": idOwner1, + * "id.dseq": idDseq1 + * } + * }, + * { + * query: { + * "id.owner": idOwner2, + * "id.dseq": idDseq2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsInfoResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentVersionDeploymentsInfoCombinedResults = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "id.owner": idOwner1, + * "id.dseq": idDseq1 + * } + * }, + * { + * query: { + * "id.owner": idOwner2, + * "id.dseq": idDseq2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsInfoCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get deployment info (database fallback) */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getDeploymentVersionDeploymentsInfo.useSuspenseInfiniteQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }, { + * initialPageParam: { + * query: { + * "id.owner": initialIdOwner, + * "id.dseq": initialIdDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + OperationInfiniteData, + GetDeploymentVersionDeploymentsInfoData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetDeploymentVersionDeploymentsInfoError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentVersionDeploymentsInfoData = qraft.akashService.getDeploymentVersionDeploymentsInfo.useSuspenseQueries({ + * queries: [ + * { + * query: { + * "id.owner": idOwner1, + * "id.dseq": idDseq1 + * } + * }, + * { + * query: { + * "id.owner": idOwner2, + * "id.dseq": idDseq2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsInfoResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentVersionDeploymentsInfoCombinedData = qraft.akashService.getDeploymentVersionDeploymentsInfo.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "id.owner": idOwner1, + * "id.dseq": idDseq1 + * } + * }, + * { + * query: { + * "id.owner": idOwner2, + * "id.dseq": idDseq2 + * } + * } + * ] + * }); + * getDeploymentVersionDeploymentsInfoCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetDeploymentVersionDeploymentsInfoSchema, + GetDeploymentVersionDeploymentsInfoParameters, + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get deployment info (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.akashService.getDeploymentVersionDeploymentsInfo.useSuspenseQuery({ + * query: { + * "id.owner": idOwner, + * "id.dseq": idDseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentVersionDeploymentsInfoData, + GetDeploymentVersionDeploymentsInfoError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentVersionDeploymentsInfoSchema; + types: { + parameters: GetDeploymentVersionDeploymentsInfoParameters; + data: GetDeploymentVersionDeploymentsInfoData; + error: GetDeploymentVersionDeploymentsInfoError; + }; + }; + /** @summary List leases (database fallback) */ + getMarketVersionLeasesList: { + /** @summary List leases (database fallback) */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + >, + options?: CancelOptions + ): Promise; + /** @summary List leases (database fallback) */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary List leases (database fallback) */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + DeepReadonly, + GetMarketVersionLeasesListError + > | void + ): Promise>; + /** @summary List leases (database fallback) */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + DeepReadonly, + GetMarketVersionLeasesListError + > | void + ): Promise; + /** @summary List leases (database fallback) */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + DeepReadonly, + GetMarketVersionLeasesListError + > | void + ): Promise>; + /** @summary List leases (database fallback) */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > | void + ): Promise; + /** @summary List leases (database fallback) */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > | void + ): Promise; + /** @summary List leases (database fallback) */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > | void + ): Promise; + /** @summary List leases (database fallback) */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary List leases (database fallback) */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetMarketVersionLeasesListData | undefined + ] + >; + /** @summary List leases (database fallback) */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetMarketVersionLeasesListData | undefined; + /** @summary List leases (database fallback) */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary List leases (database fallback) */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetMarketVersionLeasesListError> | undefined; + /** @summary List leases (database fallback) */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + >, + options?: InvalidateOptions + ): Promise; + /** @summary List leases (database fallback) */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + ): number; + /** @summary List leases (database fallback) */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetMarketVersionLeasesListSchema, + options: { + parameters: GetMarketVersionLeasesListParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List leases (database fallback) */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + >, + options?: RefetchOptions + ): Promise; + /** @summary List leases (database fallback) */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + ): void; + /** @summary List leases (database fallback) */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + >, + options?: ResetOptions + ): Promise; + /** @summary List leases (database fallback) */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List leases (database fallback) */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List leases (database fallback) */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetMarketVersionLeasesListData | undefined; + /** @summary List leases (database fallback) */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getMarketVersionLeasesList.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetMarketVersionLeasesListParameters, + TQueryFnData = GetMarketVersionLeasesListData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getMarketVersionLeasesList.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetMarketVersionLeasesListParameters, + TQueryFnData = GetMarketVersionLeasesListData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getMarketVersionLeasesListTotal = qraft.akashService.getMarketVersionLeasesList.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getMarketVersionLeasesListByParametersTotal = qraft.akashService.getMarketVersionLeasesList.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * "filters.owner": filtersOwner + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + | QueryFiltersByQueryKey< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListData, + TInfinite, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getMarketVersionLeasesListResults = qraft.akashService.getMarketVersionLeasesList.useQueries({ + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getMarketVersionLeasesListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getMarketVersionLeasesListCombinedResults = qraft.akashService.getMarketVersionLeasesList.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getMarketVersionLeasesListCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List leases (database fallback) */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.akashService.getMarketVersionLeasesList.useQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.akashService.getMarketVersionLeasesList.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * "filters.owner": initialFiltersOwner + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + OperationInfiniteData, + GetMarketVersionLeasesListData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetMarketVersionLeasesListError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getMarketVersionLeasesListData = qraft.akashService.getMarketVersionLeasesList.useSuspenseQueries({ + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getMarketVersionLeasesListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getMarketVersionLeasesListCombinedData = qraft.akashService.getMarketVersionLeasesList.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * "filters.owner": filtersOwner1 + * } + * }, + * { + * query: { + * "filters.owner": filtersOwner2 + * } + * } + * ] + * }); + * getMarketVersionLeasesListCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetMarketVersionLeasesListSchema, + GetMarketVersionLeasesListParameters, + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List leases (database fallback) + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.akashService.getMarketVersionLeasesList.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.akashService.getMarketVersionLeasesList.useSuspenseQuery({ + * query: { + * "filters.owner": filtersOwner + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetMarketVersionLeasesListData, + GetMarketVersionLeasesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetMarketVersionLeasesListSchema; + types: { + parameters: GetMarketVersionLeasesListParameters; + data: GetMarketVersionLeasesListData; + error: GetMarketVersionLeasesListError; + }; + }; +} +/** @summary List deployments (database fallback) */ +export const getDeploymentVersionDeploymentsList = { + schema: { + method: "get", + url: "/akash/deployment/{version}/deployments/list", + security: [] + } +} as { + schema: GetDeploymentVersionDeploymentsListSchema; + [QraftServiceOperationsToken]: AkashService["getDeploymentVersionDeploymentsList"]; +}; +/** @summary Get deployment info (database fallback) */ +export const getDeploymentVersionDeploymentsInfo = { + schema: { + method: "get", + url: "/akash/deployment/{version}/deployments/info", + security: [] + } +} as { + schema: GetDeploymentVersionDeploymentsInfoSchema; + [QraftServiceOperationsToken]: AkashService["getDeploymentVersionDeploymentsInfo"]; +}; +/** @summary List leases (database fallback) */ +export const getMarketVersionLeasesList = { + schema: { + method: "get", + url: "/akash/market/{version}/leases/list", + security: [] + } +} as { + schema: GetMarketVersionLeasesListSchema; + [QraftServiceOperationsToken]: AkashService["getMarketVersionLeasesList"]; +}; +export const akashService = { + getDeploymentVersionDeploymentsList, + getDeploymentVersionDeploymentsInfo, + getMarketVersionLeasesList +} as const; +type GetDeploymentVersionDeploymentsListSchema = { + method: "get"; + url: "/akash/deployment/{version}/deployments/list"; + security: []; +}; +type GetDeploymentVersionDeploymentsListParameters = paths["/akash/deployment/{version}/deployments/list"]["get"]["parameters"]; +type GetDeploymentVersionDeploymentsListData = paths["/akash/deployment/{version}/deployments/list"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentVersionDeploymentsListError = unknown; +type GetDeploymentVersionDeploymentsInfoSchema = { + method: "get"; + url: "/akash/deployment/{version}/deployments/info"; + security: []; +}; +type GetDeploymentVersionDeploymentsInfoParameters = paths["/akash/deployment/{version}/deployments/info"]["get"]["parameters"]; +type GetDeploymentVersionDeploymentsInfoData = paths["/akash/deployment/{version}/deployments/info"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentVersionDeploymentsInfoError = null; +type GetMarketVersionLeasesListSchema = { + method: "get"; + url: "/akash/market/{version}/leases/list"; + security: []; +}; +type GetMarketVersionLeasesListParameters = paths["/akash/market/{version}/leases/list"]["get"]["parameters"]; +type GetMarketVersionLeasesListData = paths["/akash/market/{version}/leases/list"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetMarketVersionLeasesListError = unknown; diff --git a/packages/react-query-sdk/src/api/services/V1Service.ts b/packages/react-query-sdk/src/api/services/V1Service.ts new file mode 100644 index 0000000000..fc4846ab78 --- /dev/null +++ b/packages/react-query-sdk/src/api/services/V1Service.ts @@ -0,0 +1,46247 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +import type { + DeepReadonly, + InvalidateQueryFilters, + MutationFiltersByMutationKey, + MutationFiltersByParameters, + MutationVariables, + OperationInfiniteData, + PartialParameters, + QraftServiceOperationsToken, + QueryFiltersByParameters, + QueryFiltersByQueryKey, + QueryFnOptionsByParameters, + QueryFnOptionsByQueryKey, + RequestFnResponse, + ServiceOperationEnsureInfiniteQueryDataOptions, + ServiceOperationEnsureQueryDataOptions, + ServiceOperationFetchInfiniteQueryOptions, + ServiceOperationFetchQueryOptions, + ServiceOperationInfiniteQueryKey, + ServiceOperationMutationFnOptions, + ServiceOperationMutationKey, + ServiceOperationQueryKey, + ServiceOperationUseMutationOptions, + UseQueryOptionsForUseQueries, + UseQueryOptionsForUseSuspenseQuery, + WithOptional +} from "@openapi-qraft/tanstack-query-react-types"; +import type { + CancelOptions, + InfiniteQueryPageParamsOptions, + InvalidateOptions, + Mutation, + MutationState, + NoInfer, + QueryState, + RefetchOptions, + ResetOptions, + SetDataOptions, + Updater +} from "@tanstack/query-core"; +import type { + DefinedInitialDataInfiniteOptions, + DefinedInitialDataOptions, + DefinedUseInfiniteQueryResult, + DefinedUseQueryResult, + UndefinedInitialDataInfiniteOptions, + UndefinedInitialDataOptions, + UseInfiniteQueryResult, + UseMutationResult, + UseQueryResult, + UseSuspenseInfiniteQueryOptions, + UseSuspenseInfiniteQueryResult, + UseSuspenseQueryOptions, + UseSuspenseQueryResult +} from "@tanstack/react-query"; + +import type { paths } from "../schema"; +export interface V1Service { + /** + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ + postStartTrial: { + /** + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStartTrial.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStartTrial.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStartTrialSchema, + PostStartTrialData, + PostStartTrialParameters, + TVariables, + PostStartTrialError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStartTrial.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStartTrial.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStartTrialSchema, + PostStartTrialData, + PostStartTrialParameters, + TVariables, + PostStartTrialError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStartTrialTotal = qraft.v1Service.postStartTrial.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStartTrialTotal = qraft.v1Service.postStartTrial.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStartTrialSchema, + PostStartTrialBody, + PostStartTrialData, + PostStartTrialParameters, + PostStartTrialError | Error, + TContext + > + ): number; + /** + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStartTrialSchema, + PostStartTrialBody, + PostStartTrialData, + PostStartTrialParameters, + PostStartTrialError | Error, + TContext + > + ): number; + /** + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStartTrialSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStartTrialPendingMutationVariables = qraft.v1Service.postStartTrial.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStartTrialMutationData = qraft.v1Service.postStartTrial.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStartTrialSchema, + PostStartTrialBody, + PostStartTrialData, + PostStartTrialParameters, + PostStartTrialError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PostStartTrialSchema; + types: { + parameters: PostStartTrialParameters; + data: PostStartTrialData; + error: PostStartTrialError; + body: PostStartTrialBody; + }; + }; + /** @summary Get a list of wallets */ + getWallets: { + /** @summary Get a list of wallets */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of wallets */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWallets.useQuery({ + * query: { + * userId: userId + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWallets.useQuery({ + * query: { + * userId: userId + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of wallets */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetWalletsError> + ): Promise>; + /** @summary Get a list of wallets */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetWalletsError> + ): Promise; + /** @summary Get a list of wallets */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions, GetWalletsError> + ): Promise>; + /** @summary Get a list of wallets */ + fetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary Get a list of wallets */ + prefetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary Get a list of wallets */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary Get a list of wallets */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a list of wallets */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetWalletsData | undefined]>; + /** @summary Get a list of wallets */ + getQueryData(parameters: ServiceOperationQueryKey | DeepReadonly): GetWalletsData | undefined; + /** @summary Get a list of wallets */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get a list of wallets */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetWalletsError> | undefined; + /** @summary Get a list of wallets */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of wallets */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of wallets */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetWalletsSchema, + options: { + parameters: GetWalletsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of wallets */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of wallets */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of wallets */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of wallets */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of wallets */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of wallets */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetWalletsData | undefined; + /** @summary Get a list of wallets */ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWallets.useInfiniteQuery({ + * query: { + * userId: userId + * } + * }, { + * initialPageParam: { + * query: { + * userId: initialUserId + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWalletsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWallets.useInfiniteQuery({ + * query: { + * userId: userId + * } + * }, { + * initialPageParam: { + * query: { + * userId: initialUserId + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWalletsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getWalletsTotal = qraft.v1Service.getWallets.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getWalletsByParametersTotal = qraft.v1Service.getWallets.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * userId: userId + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getWalletsResults = qraft.v1Service.getWallets.useQueries({ + * queries: [ + * { + * query: { + * userId: userId1 + * } + * }, + * { + * query: { + * userId: userId2 + * } + * } + * ] + * }); + * getWalletsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getWalletsCombinedResults = qraft.v1Service.getWallets.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * userId: userId1 + * } + * }, + * { + * query: { + * userId: userId2 + * } + * } + * ] + * }); + * getWalletsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of wallets */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWallets.useQuery({ + * query: { + * userId: userId + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWallets.useQuery({ + * query: { + * userId: userId + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWallets.useSuspenseInfiniteQuery({ + * query: { + * userId: userId + * } + * }, { + * initialPageParam: { + * query: { + * userId: initialUserId + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetWalletsData, + GetWalletsError, + OperationInfiniteData, + GetWalletsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetWalletsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getWalletsData = qraft.v1Service.getWallets.useSuspenseQueries({ + * queries: [ + * { + * query: { + * userId: userId1 + * } + * }, + * { + * query: { + * userId: userId2 + * } + * } + * ] + * }); + * getWalletsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getWalletsCombinedData = qraft.v1Service.getWallets.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * userId: userId1 + * } + * }, + * { + * query: { + * userId: userId2 + * } + * } + * ] + * }); + * getWalletsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of wallets + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getWallets.useSuspenseQuery({ + * query: { + * userId: userId + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetWalletsSchema; + types: { + parameters: GetWalletsParameters; + data: GetWalletsData; + error: GetWalletsError; + }; + }; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getWalletSettings: { + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWalletSettings.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetWalletSettingsData, + GetWalletSettingsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWalletSettings.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetWalletSettingsData, + GetWalletSettingsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetWalletSettingsSchema, + GetWalletSettingsData, + GetWalletSettingsParameters, + DeepReadonly, + GetWalletSettingsError + > | void + ): Promise>; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetWalletSettingsSchema, + GetWalletSettingsData, + GetWalletSettingsParameters, + DeepReadonly, + GetWalletSettingsError + > | void + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetWalletSettingsSchema, + GetWalletSettingsData, + GetWalletSettingsParameters, + DeepReadonly, + GetWalletSettingsError + > | void + ): Promise>; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetWalletSettingsSchema, + GetWalletSettingsData, + GetWalletSettingsParameters, + GetWalletSettingsError + > | void + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetWalletSettingsData | undefined]>; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetWalletSettingsData | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetWalletSettingsError> | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetWalletSettingsSchema, + options: { + parameters: GetWalletSettingsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetWalletSettingsData | undefined; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWalletSettings.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetWalletSettingsParameters, + TQueryFnData = GetWalletSettingsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWalletSettingsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWalletSettings.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetWalletSettingsParameters, + TQueryFnData = GetWalletSettingsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWalletSettingsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getWalletSettingsTotal = qraft.v1Service.getWalletSettings.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getWalletSettingsResults = qraft.v1Service.getWalletSettings.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getWalletSettingsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getWalletSettingsCombinedResults = qraft.v1Service.getWalletSettings.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getWalletSettingsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWalletSettings.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetWalletSettingsData, + GetWalletSettingsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWalletSettings.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetWalletSettingsData, + GetWalletSettingsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWalletSettings.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetWalletSettingsData, + GetWalletSettingsError, + OperationInfiniteData, + GetWalletSettingsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetWalletSettingsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getWalletSettingsData = qraft.v1Service.getWalletSettings.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getWalletSettingsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getWalletSettingsCombinedData = qraft.v1Service.getWalletSettings.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getWalletSettingsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getWalletSettings.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetWalletSettingsData, + GetWalletSettingsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetWalletSettingsSchema; + types: { + parameters: GetWalletSettingsParameters; + data: GetWalletSettingsData; + error: GetWalletSettingsError; + }; + }; + /** + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + */ + postWalletSettings: { + /** + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostWalletSettingsSchema, + PostWalletSettingsData, + PostWalletSettingsParameters, + TVariables, + PostWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostWalletSettingsSchema, + PostWalletSettingsData, + PostWalletSettingsParameters, + TVariables, + PostWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postWalletSettingsTotal = qraft.v1Service.postWalletSettings.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postWalletSettingsTotal = qraft.v1Service.postWalletSettings.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostWalletSettingsSchema, + PostWalletSettingsBody, + PostWalletSettingsData, + PostWalletSettingsParameters, + PostWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostWalletSettingsSchema, + PostWalletSettingsBody, + PostWalletSettingsData, + PostWalletSettingsParameters, + PostWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostWalletSettingsSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postWalletSettingsPendingMutationVariables = qraft.v1Service.postWalletSettings.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postWalletSettingsMutationData = qraft.v1Service.postWalletSettings.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostWalletSettingsData, + PostWalletSettingsError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostWalletSettingsSchema, + PostWalletSettingsBody, + PostWalletSettingsData, + PostWalletSettingsParameters, + PostWalletSettingsError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostWalletSettingsData, + PostWalletSettingsError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostWalletSettingsSchema; + types: { + parameters: PostWalletSettingsParameters; + data: PostWalletSettingsData; + error: PostWalletSettingsError; + body: PostWalletSettingsBody; + }; + }; + /** + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + */ + putWalletSettings: { + /** + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PutWalletSettingsSchema, + PutWalletSettingsData, + PutWalletSettingsParameters, + TVariables, + PutWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PutWalletSettingsSchema, + PutWalletSettingsData, + PutWalletSettingsParameters, + TVariables, + PutWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const putWalletSettingsTotal = qraft.v1Service.putWalletSettings.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const putWalletSettingsTotal = qraft.v1Service.putWalletSettings.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutWalletSettingsSchema, + PutWalletSettingsBody, + PutWalletSettingsData, + PutWalletSettingsParameters, + PutWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutWalletSettingsSchema, + PutWalletSettingsBody, + PutWalletSettingsData, + PutWalletSettingsParameters, + PutWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PutWalletSettingsSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const putWalletSettingsPendingMutationVariables = qraft.v1Service.putWalletSettings.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const putWalletSettingsMutationData = qraft.v1Service.putWalletSettings.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PutWalletSettingsData, + PutWalletSettingsError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutWalletSettingsSchema, + PutWalletSettingsBody, + PutWalletSettingsData, + PutWalletSettingsParameters, + PutWalletSettingsError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PutWalletSettingsData, + PutWalletSettingsError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PutWalletSettingsSchema; + types: { + parameters: PutWalletSettingsParameters; + data: PutWalletSettingsData; + error: PutWalletSettingsError; + body: PutWalletSettingsBody; + }; + }; + /** + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ + deleteWalletSettings: { + /** + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + DeleteWalletSettingsSchema, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + TVariables, + DeleteWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteWalletSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteWalletSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + DeleteWalletSettingsSchema, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + TVariables, + DeleteWalletSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteWalletSettingsTotal = qraft.v1Service.deleteWalletSettings.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteWalletSettingsTotal = qraft.v1Service.deleteWalletSettings.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteWalletSettingsSchema, + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ + isMutating( + filters?: + | MutationFiltersByParameters< + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteWalletSettingsSchema, + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + > + ): number; + /** + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteWalletSettingsSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteWalletSettingsPendingMutationVariables = qraft.v1Service.deleteWalletSettings.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteWalletSettingsMutationData = qraft.v1Service.deleteWalletSettings.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + DeleteWalletSettingsData, + DeleteWalletSettingsError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteWalletSettingsSchema, + DeleteWalletSettingsBody, + DeleteWalletSettingsData, + DeleteWalletSettingsParameters, + DeleteWalletSettingsError | Error, + TContext + >; + select?: ( + mutation: Mutation< + DeleteWalletSettingsData, + DeleteWalletSettingsError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: DeleteWalletSettingsSchema; + types: { + parameters: DeleteWalletSettingsParameters; + data: DeleteWalletSettingsData; + error: DeleteWalletSettingsError; + body: DeleteWalletSettingsBody; + }; + }; + /** @summary Signs a transaction via a user managed wallet */ + postTx: { + /** @summary Signs a transaction via a user managed wallet */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Signs a transaction via a user managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postTx.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postTx.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Signs a transaction via a user managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postTx.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postTx.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Signs a transaction via a user managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postTxTotal = qraft.v1Service.postTx.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postTxTotal = qraft.v1Service.postTx.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Signs a transaction via a user managed wallet */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Signs a transaction via a user managed wallet */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostTxSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Signs a transaction via a user managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postTxPendingMutationVariables = qraft.v1Service.postTx.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postTxMutationData = qraft.v1Service.postTx.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: PostTxSchema; + types: { + parameters: PostTxParameters; + data: PostTxData; + error: PostTxError; + body: PostTxBody; + }; + }; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getCheckout: { + /** @summary Creates a stripe checkout session and redirects to checkout */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery({ + * query: { + * amount: amount + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery({ + * query: { + * amount: amount + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Creates a stripe checkout session and redirects to checkout */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetCheckoutSchema, + GetCheckoutData, + GetCheckoutParameters, + DeepReadonly, + GetCheckoutError + > | void + ): Promise>; + /** @summary Creates a stripe checkout session and redirects to checkout */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetCheckoutSchema, + GetCheckoutData, + GetCheckoutParameters, + DeepReadonly, + GetCheckoutError + > | void + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetCheckoutSchema, + GetCheckoutData, + GetCheckoutParameters, + DeepReadonly, + GetCheckoutError + > | void + ): Promise>; + /** @summary Creates a stripe checkout session and redirects to checkout */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetCheckoutData | undefined]>; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetCheckoutData | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetCheckoutError> | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Creates a stripe checkout session and redirects to checkout */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetCheckoutSchema, + options: { + parameters: GetCheckoutParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Creates a stripe checkout session and redirects to checkout */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Creates a stripe checkout session and redirects to checkout */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Creates a stripe checkout session and redirects to checkout */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Creates a stripe checkout session and redirects to checkout */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetCheckoutData | undefined; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getCheckout.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * amount: initialAmount + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetCheckoutParameters, + TQueryFnData = GetCheckoutData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetCheckoutError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getCheckout.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * amount: initialAmount + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetCheckoutParameters, + TQueryFnData = GetCheckoutData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetCheckoutError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getCheckoutTotal = qraft.v1Service.getCheckout.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getCheckoutByParametersTotal = qraft.v1Service.getCheckout.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * amount: amount + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getCheckoutResults = qraft.v1Service.getCheckout.useQueries({ + * queries: [ + * { + * query: { + * amount: amount1 + * } + * }, + * { + * query: { + * amount: amount2 + * } + * } + * ] + * }); + * getCheckoutResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getCheckoutCombinedResults = qraft.v1Service.getCheckout.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * amount: amount1 + * } + * }, + * { + * query: { + * amount: amount2 + * } + * } + * ] + * }); + * getCheckoutCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Creates a stripe checkout session and redirects to checkout */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery({ + * query: { + * amount: amount + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getCheckout.useQuery({ + * query: { + * amount: amount + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getCheckout.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * amount: initialAmount + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetCheckoutData, + GetCheckoutError, + OperationInfiniteData, + GetCheckoutData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetCheckoutError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getCheckoutData = qraft.v1Service.getCheckout.useSuspenseQueries({ + * queries: [ + * { + * query: { + * amount: amount1 + * } + * }, + * { + * query: { + * amount: amount2 + * } + * } + * ] + * }); + * getCheckoutResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getCheckoutCombinedData = qraft.v1Service.getCheckout.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * amount: amount1 + * } + * }, + * { + * query: { + * amount: amount2 + * } + * } + * ] + * }); + * getCheckoutCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Creates a stripe checkout session and redirects to checkout + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getCheckout.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getCheckout.useSuspenseQuery({ + * query: { + * amount: amount + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetCheckoutSchema; + types: { + parameters: GetCheckoutParameters; + data: GetCheckoutData; + error: GetCheckoutError; + }; + }; + /** @summary Stripe Webhook Handler */ + postStripeWebhook: { + /** @summary Stripe Webhook Handler */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Stripe Webhook Handler + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeWebhook.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeWebhook.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripeWebhookSchema, + PostStripeWebhookData, + PostStripeWebhookParameters, + TVariables, + PostStripeWebhookError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Stripe Webhook Handler + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeWebhook.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeWebhook.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripeWebhookSchema, + PostStripeWebhookData, + PostStripeWebhookParameters, + TVariables, + PostStripeWebhookError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Stripe Webhook Handler + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripeWebhookTotal = qraft.v1Service.postStripeWebhook.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripeWebhookTotal = qraft.v1Service.postStripeWebhook.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStripeWebhookSchema, + PostStripeWebhookBody, + PostStripeWebhookData, + PostStripeWebhookParameters, + PostStripeWebhookError | Error, + TContext + > + ): number; + /** @summary Stripe Webhook Handler */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStripeWebhookSchema, + PostStripeWebhookBody, + PostStripeWebhookData, + PostStripeWebhookParameters, + PostStripeWebhookError | Error, + TContext + > + ): number; + /** @summary Stripe Webhook Handler */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripeWebhookSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Stripe Webhook Handler + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripeWebhookPendingMutationVariables = qraft.v1Service.postStripeWebhook.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripeWebhookMutationData = qraft.v1Service.postStripeWebhook.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripeWebhookData, + PostStripeWebhookError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostStripeWebhookSchema, + PostStripeWebhookBody, + PostStripeWebhookData, + PostStripeWebhookParameters, + PostStripeWebhookError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripeWebhookData, + PostStripeWebhookError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripeWebhookSchema; + types: { + parameters: PostStripeWebhookParameters; + data: PostStripeWebhookData; + error: PostStripeWebhookError; + body: PostStripeWebhookBody; + }; + }; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getStripePrices: { + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePricesData, + GetStripePricesError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePricesSchema, + GetStripePricesData, + GetStripePricesParameters, + DeepReadonly, + GetStripePricesError + > | void + ): Promise>; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePricesSchema, + GetStripePricesData, + GetStripePricesParameters, + DeepReadonly, + GetStripePricesError + > | void + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetStripePricesSchema, + GetStripePricesData, + GetStripePricesParameters, + DeepReadonly, + GetStripePricesError + > | void + ): Promise>; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetStripePricesData | undefined]>; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetStripePricesData | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetStripePricesError> | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetStripePricesSchema, + options: { + parameters: GetStripePricesParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetStripePricesData | undefined; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePrices.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePricesParameters, + TQueryFnData = GetStripePricesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePricesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePrices.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePricesParameters, + TQueryFnData = GetStripePricesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePricesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getStripePricesTotal = qraft.v1Service.getStripePrices.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getStripePricesResults = qraft.v1Service.getStripePrices.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePricesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getStripePricesCombinedResults = qraft.v1Service.getStripePrices.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePricesCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePricesData, + GetStripePricesError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePrices.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetStripePricesData, + GetStripePricesError, + OperationInfiniteData, + GetStripePricesData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetStripePricesError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getStripePricesData = qraft.v1Service.getStripePrices.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePricesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getStripePricesCombinedData = qraft.v1Service.getStripePrices.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePricesCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getStripePrices.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetStripePricesSchema; + types: { + parameters: GetStripePricesParameters; + data: GetStripePricesData; + error: GetStripePricesError; + }; + }; + /** @summary Apply a coupon to the current user */ + postStripeCouponsApply: { + /** @summary Apply a coupon to the current user */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Apply a coupon to the current user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeCouponsApply.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeCouponsApply.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripeCouponsApplySchema, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + TVariables, + PostStripeCouponsApplyError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Apply a coupon to the current user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeCouponsApply.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeCouponsApply.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripeCouponsApplySchema, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + TVariables, + PostStripeCouponsApplyError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Apply a coupon to the current user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripeCouponsApplyTotal = qraft.v1Service.postStripeCouponsApply.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripeCouponsApplyTotal = qraft.v1Service.postStripeCouponsApply.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeCouponsApplySchema, + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + > + ): number; + /** @summary Apply a coupon to the current user */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeCouponsApplySchema, + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + > + ): number; + /** @summary Apply a coupon to the current user */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripeCouponsApplySchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Apply a coupon to the current user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripeCouponsApplyPendingMutationVariables = qraft.v1Service.postStripeCouponsApply.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripeCouponsApplyMutationData = qraft.v1Service.postStripeCouponsApply.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripeCouponsApplyData, + PostStripeCouponsApplyError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeCouponsApplySchema, + PostStripeCouponsApplyBody, + PostStripeCouponsApplyData, + PostStripeCouponsApplyParameters, + PostStripeCouponsApplyError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripeCouponsApplyData, + PostStripeCouponsApplyError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripeCouponsApplySchema; + types: { + parameters: PostStripeCouponsApplyParameters; + data: PostStripeCouponsApplyData; + error: PostStripeCouponsApplyError; + body: PostStripeCouponsApplyBody; + }; + }; + /** + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ + putStripeCustomersOrganization: { + /** + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putStripeCustomersOrganization.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putStripeCustomersOrganization.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PutStripeCustomersOrganizationSchema, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + TVariables, + PutStripeCustomersOrganizationError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putStripeCustomersOrganization.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putStripeCustomersOrganization.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PutStripeCustomersOrganizationSchema, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + TVariables, + PutStripeCustomersOrganizationError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const putStripeCustomersOrganizationTotal = qraft.v1Service.putStripeCustomersOrganization.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const putStripeCustomersOrganizationTotal = qraft.v1Service.putStripeCustomersOrganization.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + > + | MutationFiltersByMutationKey< + PutStripeCustomersOrganizationSchema, + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + > + ): number; + /** + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ + isMutating( + filters?: + | MutationFiltersByParameters< + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + > + | MutationFiltersByMutationKey< + PutStripeCustomersOrganizationSchema, + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + > + ): number; + /** + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PutStripeCustomersOrganizationSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const putStripeCustomersOrganizationPendingMutationVariables = qraft.v1Service.putStripeCustomersOrganization.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const putStripeCustomersOrganizationMutationData = qraft.v1Service.putStripeCustomersOrganization.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + > + | MutationFiltersByMutationKey< + PutStripeCustomersOrganizationSchema, + PutStripeCustomersOrganizationBody, + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationParameters, + PutStripeCustomersOrganizationError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PutStripeCustomersOrganizationData, + PutStripeCustomersOrganizationError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PutStripeCustomersOrganizationSchema; + types: { + parameters: PutStripeCustomersOrganizationParameters; + data: PutStripeCustomersOrganizationData; + error: PutStripeCustomersOrganizationError; + body: PutStripeCustomersOrganizationBody; + }; + }; + /** + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ + postStripePaymentMethodsSetup: { + /** + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsSetup.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsSetup.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsSetupSchema, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + TVariables, + PostStripePaymentMethodsSetupError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsSetup.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsSetup.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsSetupSchema, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + TVariables, + PostStripePaymentMethodsSetupError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripePaymentMethodsSetupTotal = qraft.v1Service.postStripePaymentMethodsSetup.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripePaymentMethodsSetupTotal = qraft.v1Service.postStripePaymentMethodsSetup.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsSetupSchema, + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + > + ): number; + /** + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsSetupSchema, + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + > + ): number; + /** + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripePaymentMethodsSetupSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripePaymentMethodsSetupPendingMutationVariables = qraft.v1Service.postStripePaymentMethodsSetup.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripePaymentMethodsSetupMutationData = qraft.v1Service.postStripePaymentMethodsSetup.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsSetupSchema, + PostStripePaymentMethodsSetupBody, + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupParameters, + PostStripePaymentMethodsSetupError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripePaymentMethodsSetupData, + PostStripePaymentMethodsSetupError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripePaymentMethodsSetupSchema; + types: { + parameters: PostStripePaymentMethodsSetupParameters; + data: PostStripePaymentMethodsSetupData; + error: PostStripePaymentMethodsSetupError; + body: PostStripePaymentMethodsSetupBody; + }; + }; + /** @summary Marks a payment method as the default. */ + postStripePaymentMethodsDefault: { + /** @summary Marks a payment method as the default. */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Marks a payment method as the default. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsDefault.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsDefault.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsDefaultSchema, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + TVariables, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Marks a payment method as the default. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsDefault.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsDefault.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsDefaultSchema, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + TVariables, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Marks a payment method as the default. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripePaymentMethodsDefaultTotal = qraft.v1Service.postStripePaymentMethodsDefault.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripePaymentMethodsDefaultTotal = qraft.v1Service.postStripePaymentMethodsDefault.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsDefaultSchema, + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + ): number; + /** @summary Marks a payment method as the default. */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsDefaultSchema, + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + ): number; + /** @summary Marks a payment method as the default. */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripePaymentMethodsDefaultSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Marks a payment method as the default. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripePaymentMethodsDefaultPendingMutationVariables = qraft.v1Service.postStripePaymentMethodsDefault.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripePaymentMethodsDefaultMutationData = qraft.v1Service.postStripePaymentMethodsDefault.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsDefaultSchema, + PostStripePaymentMethodsDefaultBody, + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultParameters, + PostStripePaymentMethodsDefaultError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripePaymentMethodsDefaultData, + PostStripePaymentMethodsDefaultError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripePaymentMethodsDefaultSchema; + types: { + parameters: PostStripePaymentMethodsDefaultParameters; + data: PostStripePaymentMethodsDefaultData; + error: PostStripePaymentMethodsDefaultError; + body: PostStripePaymentMethodsDefaultBody; + }; + }; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getStripePaymentMethodsDefault: { + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + >, + options?: CancelOptions + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethodsDefault.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethodsDefault.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + DeepReadonly, + GetStripePaymentMethodsDefaultError + > | void + ): Promise>; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + DeepReadonly, + GetStripePaymentMethodsDefaultError + > | void + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + DeepReadonly, + GetStripePaymentMethodsDefaultError + > | void + ): Promise>; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > | void + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > | void + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > | void + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetStripePaymentMethodsDefaultData | undefined + ] + >; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetStripePaymentMethodsDefaultData | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): + | QueryState, GetStripePaymentMethodsDefaultError> + | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + >, + options?: InvalidateOptions + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + ): number; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetStripePaymentMethodsDefaultSchema, + options: { + parameters: GetStripePaymentMethodsDefaultParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + >, + options?: RefetchOptions + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + ): void; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + >, + options?: ResetOptions + ): Promise; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetStripePaymentMethodsDefaultData | undefined; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethodsDefault.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePaymentMethodsDefaultParameters, + TQueryFnData = GetStripePaymentMethodsDefaultData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethodsDefault.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePaymentMethodsDefaultParameters, + TQueryFnData = GetStripePaymentMethodsDefaultData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getStripePaymentMethodsDefaultTotal = qraft.v1Service.getStripePaymentMethodsDefault.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultData, + TInfinite, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getStripePaymentMethodsDefaultResults = qraft.v1Service.getStripePaymentMethodsDefault.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsDefaultResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getStripePaymentMethodsDefaultCombinedResults = qraft.v1Service.getStripePaymentMethodsDefault.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsDefaultCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethodsDefault.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethodsDefault.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethodsDefault.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + OperationInfiniteData, + GetStripePaymentMethodsDefaultData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetStripePaymentMethodsDefaultError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getStripePaymentMethodsDefaultData = qraft.v1Service.getStripePaymentMethodsDefault.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsDefaultResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getStripePaymentMethodsDefaultCombinedData = qraft.v1Service.getStripePaymentMethodsDefault.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsDefaultCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetStripePaymentMethodsDefaultSchema, + GetStripePaymentMethodsDefaultParameters, + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getStripePaymentMethodsDefault.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetStripePaymentMethodsDefaultData, + GetStripePaymentMethodsDefaultError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetStripePaymentMethodsDefaultSchema; + types: { + parameters: GetStripePaymentMethodsDefaultParameters; + data: GetStripePaymentMethodsDefaultData; + error: GetStripePaymentMethodsDefaultError; + }; + }; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getStripePaymentMethods: { + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + >, + options?: CancelOptions + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethods.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethods.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + DeepReadonly, + GetStripePaymentMethodsError + > | void + ): Promise>; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + DeepReadonly, + GetStripePaymentMethodsError + > | void + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + DeepReadonly, + GetStripePaymentMethodsError + > | void + ): Promise>; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > | void + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > | void + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > | void + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [queryKey: ServiceOperationQueryKey, data: GetStripePaymentMethodsData | undefined] + >; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetStripePaymentMethodsData | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetStripePaymentMethodsError> | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + >, + options?: InvalidateOptions + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + ): number; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetStripePaymentMethodsSchema, + options: { + parameters: GetStripePaymentMethodsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + >, + options?: RefetchOptions + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + ): void; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + >, + options?: ResetOptions + ): Promise; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetStripePaymentMethodsData | undefined; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethods.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePaymentMethodsParameters, + TQueryFnData = GetStripePaymentMethodsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePaymentMethodsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethods.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripePaymentMethodsParameters, + TQueryFnData = GetStripePaymentMethodsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripePaymentMethodsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getStripePaymentMethodsTotal = qraft.v1Service.getStripePaymentMethods.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + | QueryFiltersByQueryKey< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsData, + TInfinite, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getStripePaymentMethodsResults = qraft.v1Service.getStripePaymentMethods.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getStripePaymentMethodsCombinedResults = qraft.v1Service.getStripePaymentMethods.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsData, + GetStripePaymentMethodsError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethods.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripePaymentMethods.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripePaymentMethods.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + OperationInfiniteData, + GetStripePaymentMethodsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetStripePaymentMethodsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getStripePaymentMethodsData = qraft.v1Service.getStripePaymentMethods.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getStripePaymentMethodsCombinedData = qraft.v1Service.getStripePaymentMethods.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getStripePaymentMethodsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetStripePaymentMethodsSchema, + GetStripePaymentMethodsParameters, + GetStripePaymentMethodsData, + GetStripePaymentMethodsError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getStripePaymentMethods.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetStripePaymentMethodsData, + GetStripePaymentMethodsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetStripePaymentMethodsSchema; + types: { + parameters: GetStripePaymentMethodsParameters; + data: GetStripePaymentMethodsData; + error: GetStripePaymentMethodsError; + }; + }; + /** + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ + deleteStripePaymentMethodsPaymentMethodId: { + /** + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutation({ + * path: { + * paymentMethodId: paymentMethodId + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * paymentMethodId: paymentMethodId + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + DeleteStripePaymentMethodsPaymentMethodIdSchema, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + TVariables, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutation({ + * path: { + * paymentMethodId: paymentMethodId + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * paymentMethodId: paymentMethodId + * } + * }); + * ``` + */ + useMutation< + TVariables extends MutationVariables, + TContext = unknown + >( + parameters: void, + options?: ServiceOperationUseMutationOptions< + DeleteStripePaymentMethodsPaymentMethodIdSchema, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + TVariables, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteStripePaymentMethodsPaymentMethodIdTotal = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteStripePaymentMethodsPaymentMethodIdTotal = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useIsMutating({ + * parameters: { + * path: { + * paymentMethodId: paymentMethodId + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteStripePaymentMethodsPaymentMethodIdSchema, + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + ): number; + /** + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ + isMutating( + filters?: + | MutationFiltersByParameters< + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteStripePaymentMethodsPaymentMethodIdSchema, + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + ): number; + /** + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteStripePaymentMethodsPaymentMethodIdSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteStripePaymentMethodsPaymentMethodIdPendingMutationVariables = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteStripePaymentMethodsPaymentMethodIdMutationData = qraft.v1Service.deleteStripePaymentMethodsPaymentMethodId.useMutationState({ + * filters: { + * parameters: { + * path: { + * paymentMethodId: paymentMethodId + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteStripePaymentMethodsPaymentMethodIdSchema, + DeleteStripePaymentMethodsPaymentMethodIdBody, + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdParameters, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + TContext + >; + select?: ( + mutation: Mutation< + DeleteStripePaymentMethodsPaymentMethodIdData, + DeleteStripePaymentMethodsPaymentMethodIdError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: DeleteStripePaymentMethodsPaymentMethodIdSchema; + types: { + parameters: DeleteStripePaymentMethodsPaymentMethodIdParameters; + data: DeleteStripePaymentMethodsPaymentMethodIdData; + error: DeleteStripePaymentMethodsPaymentMethodIdError; + body: DeleteStripePaymentMethodsPaymentMethodIdBody; + }; + }; + /** + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ + postStripePaymentMethodsValidate: { + /** + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsValidate.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsValidate.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsValidateSchema, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + TVariables, + PostStripePaymentMethodsValidateError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsValidate.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripePaymentMethodsValidate.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripePaymentMethodsValidateSchema, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + TVariables, + PostStripePaymentMethodsValidateError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripePaymentMethodsValidateTotal = qraft.v1Service.postStripePaymentMethodsValidate.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripePaymentMethodsValidateTotal = qraft.v1Service.postStripePaymentMethodsValidate.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsValidateSchema, + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + > + ): number; + /** + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsValidateSchema, + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + > + ): number; + /** + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripePaymentMethodsValidateSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripePaymentMethodsValidatePendingMutationVariables = qraft.v1Service.postStripePaymentMethodsValidate.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripePaymentMethodsValidateMutationData = qraft.v1Service.postStripePaymentMethodsValidate.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripePaymentMethodsValidateSchema, + PostStripePaymentMethodsValidateBody, + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateParameters, + PostStripePaymentMethodsValidateError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripePaymentMethodsValidateData, + PostStripePaymentMethodsValidateError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripePaymentMethodsValidateSchema; + types: { + parameters: PostStripePaymentMethodsValidateParameters; + data: PostStripePaymentMethodsValidateData; + error: PostStripePaymentMethodsValidateError; + body: PostStripePaymentMethodsValidateBody; + }; + }; + /** + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ + postStripeTransactionsConfirm: { + /** + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeTransactionsConfirm.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeTransactionsConfirm.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostStripeTransactionsConfirmSchema, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + TVariables, + PostStripeTransactionsConfirmError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeTransactionsConfirm.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postStripeTransactionsConfirm.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostStripeTransactionsConfirmSchema, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + TVariables, + PostStripeTransactionsConfirmError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postStripeTransactionsConfirmTotal = qraft.v1Service.postStripeTransactionsConfirm.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postStripeTransactionsConfirmTotal = qraft.v1Service.postStripeTransactionsConfirm.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeTransactionsConfirmSchema, + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + > + ): number; + /** + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeTransactionsConfirmSchema, + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + > + ): number; + /** + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostStripeTransactionsConfirmSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postStripeTransactionsConfirmPendingMutationVariables = qraft.v1Service.postStripeTransactionsConfirm.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postStripeTransactionsConfirmMutationData = qraft.v1Service.postStripeTransactionsConfirm.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostStripeTransactionsConfirmSchema, + PostStripeTransactionsConfirmBody, + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmParameters, + PostStripeTransactionsConfirmError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostStripeTransactionsConfirmData, + PostStripeTransactionsConfirmError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostStripeTransactionsConfirmSchema; + types: { + parameters: PostStripeTransactionsConfirmParameters; + data: PostStripeTransactionsConfirmData; + error: PostStripeTransactionsConfirmError; + body: PostStripeTransactionsConfirmBody; + }; + }; + /** @summary Get transaction history for the current customer */ + getStripeTransactions: { + /** @summary Get transaction history for the current customer */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + >, + options?: CancelOptions + ): Promise; + /** @summary Get transaction history for the current customer */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get transaction history for the current customer */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + DeepReadonly, + GetStripeTransactionsError + > | void + ): Promise>; + /** @summary Get transaction history for the current customer */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + DeepReadonly, + GetStripeTransactionsError + > | void + ): Promise; + /** @summary Get transaction history for the current customer */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + DeepReadonly, + GetStripeTransactionsError + > | void + ): Promise>; + /** @summary Get transaction history for the current customer */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > | void + ): Promise; + /** @summary Get transaction history for the current customer */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > | void + ): Promise; + /** @summary Get transaction history for the current customer */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > | void + ): Promise; + /** @summary Get transaction history for the current customer */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get transaction history for the current customer */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetStripeTransactionsData | undefined]>; + /** @summary Get transaction history for the current customer */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetStripeTransactionsData | undefined; + /** @summary Get transaction history for the current customer */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get transaction history for the current customer */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetStripeTransactionsError> | undefined; + /** @summary Get transaction history for the current customer */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get transaction history for the current customer */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey + ): number; + /** @summary Get transaction history for the current customer */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetStripeTransactionsSchema, + options: { + parameters: GetStripeTransactionsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get transaction history for the current customer */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get transaction history for the current customer */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey + ): void; + /** @summary Get transaction history for the current customer */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + >, + options?: ResetOptions + ): Promise; + /** @summary Get transaction history for the current customer */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get transaction history for the current customer */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get transaction history for the current customer */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetStripeTransactionsData | undefined; + /** @summary Get transaction history for the current customer */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactions.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripeTransactionsParameters, + TQueryFnData = GetStripeTransactionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripeTransactionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactions.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripeTransactionsParameters, + TQueryFnData = GetStripeTransactionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripeTransactionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getStripeTransactionsTotal = qraft.v1Service.getStripeTransactions.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getStripeTransactionsByParametersTotal = qraft.v1Service.getStripeTransactions.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * limit: limit + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsSchema, + GetStripeTransactionsData, + TInfinite, + GetStripeTransactionsParameters, + GetStripeTransactionsError + > + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getStripeTransactionsResults = qraft.v1Service.getStripeTransactions.useQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getStripeTransactionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getStripeTransactionsCombinedResults = qraft.v1Service.getStripeTransactions.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getStripeTransactionsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get transaction history for the current customer */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactions.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + OperationInfiniteData, + GetStripeTransactionsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetStripeTransactionsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getStripeTransactionsData = qraft.v1Service.getStripeTransactions.useSuspenseQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getStripeTransactionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getStripeTransactionsCombinedData = qraft.v1Service.getStripeTransactions.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getStripeTransactionsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get transaction history for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getStripeTransactions.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getStripeTransactions.useSuspenseQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetStripeTransactionsData, + GetStripeTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetStripeTransactionsSchema; + types: { + parameters: GetStripeTransactionsParameters; + data: GetStripeTransactionsData; + error: GetStripeTransactionsError; + }; + }; + /** @summary Export transaction history as CSV for the current customer */ + getStripeTransactionsExport: { + /** @summary Export transaction history as CSV for the current customer */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + >, + options?: CancelOptions + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactionsExport.useQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactionsExport.useQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Export transaction history as CSV for the current customer */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + DeepReadonly, + GetStripeTransactionsExportError + > + ): Promise>; + /** @summary Export transaction history as CSV for the current customer */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + DeepReadonly, + GetStripeTransactionsExportError + > + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + DeepReadonly, + GetStripeTransactionsExportError + > + ): Promise>; + /** @summary Export transaction history as CSV for the current customer */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Export transaction history as CSV for the current customer */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetStripeTransactionsExportData | undefined + ] + >; + /** @summary Export transaction history as CSV for the current customer */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetStripeTransactionsExportData | undefined; + /** @summary Export transaction history as CSV for the current customer */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Export transaction history as CSV for the current customer */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetStripeTransactionsExportError> | undefined; + /** @summary Export transaction history as CSV for the current customer */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): number; + /** @summary Export transaction history as CSV for the current customer */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetStripeTransactionsExportSchema, + options: { + parameters: GetStripeTransactionsExportParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Export transaction history as CSV for the current customer */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + >, + options?: RefetchOptions + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): void; + /** @summary Export transaction history as CSV for the current customer */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + >, + options?: ResetOptions + ): Promise; + /** @summary Export transaction history as CSV for the current customer */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Export transaction history as CSV for the current customer */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Export transaction history as CSV for the current customer */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetStripeTransactionsExportData | undefined; + /** @summary Export transaction history as CSV for the current customer */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactionsExport.useInfiniteQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }, { + * initialPageParam: { + * query: { + * timezone: initialTimezone, + * startDate: initialStartDate, + * endDate: initialEndDate + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripeTransactionsExportParameters, + TQueryFnData = GetStripeTransactionsExportData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripeTransactionsExportError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactionsExport.useInfiniteQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }, { + * initialPageParam: { + * query: { + * timezone: initialTimezone, + * startDate: initialStartDate, + * endDate: initialEndDate + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetStripeTransactionsExportParameters, + TQueryFnData = GetStripeTransactionsExportData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetStripeTransactionsExportError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getStripeTransactionsExportTotal = qraft.v1Service.getStripeTransactionsExport.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getStripeTransactionsExportByParametersTotal = qraft.v1Service.getStripeTransactionsExport.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + | QueryFiltersByQueryKey< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportData, + TInfinite, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getStripeTransactionsExportResults = qraft.v1Service.getStripeTransactionsExport.useQueries({ + * queries: [ + * { + * query: { + * timezone: timezone1, + * startDate: startDate1, + * endDate: endDate1 + * } + * }, + * { + * query: { + * timezone: timezone2, + * startDate: startDate2, + * endDate: endDate2 + * } + * } + * ] + * }); + * getStripeTransactionsExportResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getStripeTransactionsExportCombinedResults = qraft.v1Service.getStripeTransactionsExport.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * timezone: timezone1, + * startDate: startDate1, + * endDate: endDate1 + * } + * }, + * { + * query: { + * timezone: timezone2, + * startDate: startDate2, + * endDate: endDate2 + * } + * } + * ] + * }); + * getStripeTransactionsExportCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportData, + GetStripeTransactionsExportError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Export transaction history as CSV for the current customer */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactionsExport.useQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getStripeTransactionsExport.useQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getStripeTransactionsExport.useSuspenseInfiniteQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }, { + * initialPageParam: { + * query: { + * timezone: initialTimezone, + * startDate: initialStartDate, + * endDate: initialEndDate + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + OperationInfiniteData, + GetStripeTransactionsExportData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetStripeTransactionsExportError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getStripeTransactionsExportData = qraft.v1Service.getStripeTransactionsExport.useSuspenseQueries({ + * queries: [ + * { + * query: { + * timezone: timezone1, + * startDate: startDate1, + * endDate: endDate1 + * } + * }, + * { + * query: { + * timezone: timezone2, + * startDate: startDate2, + * endDate: endDate2 + * } + * } + * ] + * }); + * getStripeTransactionsExportResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getStripeTransactionsExportCombinedData = qraft.v1Service.getStripeTransactionsExport.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * timezone: timezone1, + * startDate: startDate1, + * endDate: endDate1 + * } + * }, + * { + * query: { + * timezone: timezone2, + * startDate: startDate2, + * endDate: endDate2 + * } + * } + * ] + * }); + * getStripeTransactionsExportCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetStripeTransactionsExportSchema, + GetStripeTransactionsExportParameters, + GetStripeTransactionsExportData, + GetStripeTransactionsExportError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Export transaction history as CSV for the current customer + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getStripeTransactionsExport.useSuspenseQuery({ + * query: { + * timezone: timezone, + * startDate: startDate, + * endDate: endDate + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetStripeTransactionsExportData, + GetStripeTransactionsExportError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetStripeTransactionsExportSchema; + types: { + parameters: GetStripeTransactionsExportParameters; + data: GetStripeTransactionsExportData; + error: GetStripeTransactionsExportError; + }; + }; + /** @summary Get historical data of billing and usage for a wallet address. */ + getUsageHistory: { + /** @summary Get historical data of billing and usage for a wallet address. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistory.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetUsageHistoryData, + GetUsageHistoryError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistory.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get historical data of billing and usage for a wallet address. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetUsageHistorySchema, + GetUsageHistoryData, + GetUsageHistoryParameters, + DeepReadonly, + GetUsageHistoryError + > + ): Promise>; + /** @summary Get historical data of billing and usage for a wallet address. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetUsageHistorySchema, + GetUsageHistoryData, + GetUsageHistoryParameters, + DeepReadonly, + GetUsageHistoryError + > + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetUsageHistorySchema, + GetUsageHistoryData, + GetUsageHistoryParameters, + DeepReadonly, + GetUsageHistoryError + > + ): Promise>; + /** @summary Get historical data of billing and usage for a wallet address. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetUsageHistoryData | undefined]>; + /** @summary Get historical data of billing and usage for a wallet address. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetUsageHistoryData | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetUsageHistoryError> | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get historical data of billing and usage for a wallet address. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetUsageHistorySchema, + options: { + parameters: GetUsageHistoryParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get historical data of billing and usage for a wallet address. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get historical data of billing and usage for a wallet address. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get historical data of billing and usage for a wallet address. */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get historical data of billing and usage for a wallet address. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetUsageHistoryData | undefined; + /** @summary Get historical data of billing and usage for a wallet address. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistory.useInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetUsageHistoryParameters, + TQueryFnData = GetUsageHistoryData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUsageHistoryError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistory.useInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetUsageHistoryParameters, + TQueryFnData = GetUsageHistoryData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUsageHistoryError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getUsageHistoryTotal = qraft.v1Service.getUsageHistory.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getUsageHistoryByParametersTotal = qraft.v1Service.getUsageHistory.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getUsageHistoryResults = qraft.v1Service.getUsageHistory.useQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getUsageHistoryCombinedResults = qraft.v1Service.getUsageHistory.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get historical data of billing and usage for a wallet address. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistory.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetUsageHistoryData, + GetUsageHistoryError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistory.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistory.useSuspenseInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetUsageHistoryData, + GetUsageHistoryError, + OperationInfiniteData, + GetUsageHistoryData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetUsageHistoryError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getUsageHistoryData = qraft.v1Service.getUsageHistory.useSuspenseQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getUsageHistoryCombinedData = qraft.v1Service.getUsageHistory.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get historical data of billing and usage for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getUsageHistory.useSuspenseQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetUsageHistorySchema; + types: { + parameters: GetUsageHistoryParameters; + data: GetUsageHistoryData; + error: GetUsageHistoryError; + }; + }; + /** @summary Get historical usage stats for a wallet address. */ + getUsageHistoryStats: { + /** @summary Get historical usage stats for a wallet address. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistoryStats.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistoryStats.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get historical usage stats for a wallet address. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + DeepReadonly, + GetUsageHistoryStatsError + > + ): Promise>; + /** @summary Get historical usage stats for a wallet address. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + DeepReadonly, + GetUsageHistoryStatsError + > + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + DeepReadonly, + GetUsageHistoryStatsError + > + ): Promise>; + /** @summary Get historical usage stats for a wallet address. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + GetUsageHistoryStatsError + > + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + GetUsageHistoryStatsError + > + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + GetUsageHistoryStatsParameters, + GetUsageHistoryStatsError + > + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get historical usage stats for a wallet address. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetUsageHistoryStatsData | undefined]>; + /** @summary Get historical usage stats for a wallet address. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetUsageHistoryStatsData | undefined; + /** @summary Get historical usage stats for a wallet address. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get historical usage stats for a wallet address. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetUsageHistoryStatsError> | undefined; + /** @summary Get historical usage stats for a wallet address. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetUsageHistoryStatsSchema, + GetUsageHistoryStatsData, + TInfinite, + GetUsageHistoryStatsParameters, + GetUsageHistoryStatsError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get historical usage stats for a wallet address. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetUsageHistoryStatsSchema, + options: { + parameters: GetUsageHistoryStatsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get historical usage stats for a wallet address. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get historical usage stats for a wallet address. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get historical usage stats for a wallet address. */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get historical usage stats for a wallet address. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get historical usage stats for a wallet address. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetUsageHistoryStatsData | undefined; + /** @summary Get historical usage stats for a wallet address. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistoryStats.useInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetUsageHistoryStatsParameters, + TQueryFnData = GetUsageHistoryStatsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUsageHistoryStatsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistoryStats.useInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetUsageHistoryStatsParameters, + TQueryFnData = GetUsageHistoryStatsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUsageHistoryStatsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getUsageHistoryStatsTotal = qraft.v1Service.getUsageHistoryStats.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getUsageHistoryStatsByParametersTotal = qraft.v1Service.getUsageHistoryStats.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getUsageHistoryStatsResults = qraft.v1Service.getUsageHistoryStats.useQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryStatsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getUsageHistoryStatsCombinedResults = qraft.v1Service.getUsageHistoryStats.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryStatsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get historical usage stats for a wallet address. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistoryStats.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUsageHistoryStats.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUsageHistoryStats.useSuspenseInfiniteQuery({ + * query: { + * address: address + * } + * }, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + OperationInfiniteData, + GetUsageHistoryStatsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetUsageHistoryStatsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getUsageHistoryStatsData = qraft.v1Service.getUsageHistoryStats.useSuspenseQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryStatsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getUsageHistoryStatsCombinedData = qraft.v1Service.getUsageHistoryStats.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getUsageHistoryStatsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get historical usage stats for a wallet address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getUsageHistoryStats.useSuspenseQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetUsageHistoryStatsData, + GetUsageHistoryStatsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetUsageHistoryStatsSchema; + types: { + parameters: GetUsageHistoryStatsParameters; + data: GetUsageHistoryStatsData; + error: GetUsageHistoryStatsError; + }; + }; + /** @summary Creates an anonymous user */ + postAnonymousUsers: { + /** @summary Creates an anonymous user */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Creates an anonymous user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postAnonymousUsers.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postAnonymousUsers.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostAnonymousUsersSchema, + PostAnonymousUsersData, + PostAnonymousUsersParameters, + TVariables, + PostAnonymousUsersError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Creates an anonymous user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postAnonymousUsers.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postAnonymousUsers.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostAnonymousUsersSchema, + PostAnonymousUsersData, + PostAnonymousUsersParameters, + TVariables, + PostAnonymousUsersError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Creates an anonymous user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postAnonymousUsersTotal = qraft.v1Service.postAnonymousUsers.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postAnonymousUsersTotal = qraft.v1Service.postAnonymousUsers.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostAnonymousUsersSchema, + PostAnonymousUsersBody, + PostAnonymousUsersData, + PostAnonymousUsersParameters, + PostAnonymousUsersError | Error, + TContext + > + ): number; + /** @summary Creates an anonymous user */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostAnonymousUsersSchema, + PostAnonymousUsersBody, + PostAnonymousUsersData, + PostAnonymousUsersParameters, + PostAnonymousUsersError | Error, + TContext + > + ): number; + /** @summary Creates an anonymous user */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostAnonymousUsersSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Creates an anonymous user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postAnonymousUsersPendingMutationVariables = qraft.v1Service.postAnonymousUsers.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postAnonymousUsersMutationData = qraft.v1Service.postAnonymousUsers.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostAnonymousUsersData, + PostAnonymousUsersError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostAnonymousUsersSchema, + PostAnonymousUsersBody, + PostAnonymousUsersData, + PostAnonymousUsersParameters, + PostAnonymousUsersError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostAnonymousUsersData, + PostAnonymousUsersError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostAnonymousUsersSchema; + types: { + parameters: PostAnonymousUsersParameters; + data: PostAnonymousUsersData; + error: PostAnonymousUsersError; + body: PostAnonymousUsersBody; + }; + }; + /** @summary Retrieves an anonymous user by id */ + getAnonymousUsersId: { + /** @summary Retrieves an anonymous user by id */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAnonymousUsersId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAnonymousUsersId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Retrieves an anonymous user by id */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAnonymousUsersIdSchema, + GetAnonymousUsersIdData, + GetAnonymousUsersIdParameters, + DeepReadonly, + GetAnonymousUsersIdError + > + ): Promise>; + /** @summary Retrieves an anonymous user by id */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAnonymousUsersIdSchema, + GetAnonymousUsersIdData, + GetAnonymousUsersIdParameters, + DeepReadonly, + GetAnonymousUsersIdError + > + ): Promise; + /** @summary Retrieves an anonymous user by id */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAnonymousUsersIdSchema, + GetAnonymousUsersIdData, + GetAnonymousUsersIdParameters, + DeepReadonly, + GetAnonymousUsersIdError + > + ): Promise>; + /** @summary Retrieves an anonymous user by id */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetAnonymousUsersIdSchema, + GetAnonymousUsersIdData, + GetAnonymousUsersIdParameters, + GetAnonymousUsersIdError + > + ): Promise; + /** @summary Retrieves an anonymous user by id */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Retrieves an anonymous user by id */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetAnonymousUsersIdData | undefined]>; + /** @summary Retrieves an anonymous user by id */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetAnonymousUsersIdData | undefined; + /** @summary Retrieves an anonymous user by id */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Retrieves an anonymous user by id */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetAnonymousUsersIdError> | undefined; + /** @summary Retrieves an anonymous user by id */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Retrieves an anonymous user by id */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetAnonymousUsersIdSchema, + options: { + parameters: GetAnonymousUsersIdParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Retrieves an anonymous user by id */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Retrieves an anonymous user by id */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Retrieves an anonymous user by id */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Retrieves an anonymous user by id */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Retrieves an anonymous user by id */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetAnonymousUsersIdData | undefined; + /** @summary Retrieves an anonymous user by id */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAnonymousUsersId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAnonymousUsersIdParameters, + TQueryFnData = GetAnonymousUsersIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAnonymousUsersIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAnonymousUsersId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAnonymousUsersIdParameters, + TQueryFnData = GetAnonymousUsersIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAnonymousUsersIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAnonymousUsersIdTotal = qraft.v1Service.getAnonymousUsersId.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAnonymousUsersIdByParametersTotal = qraft.v1Service.getAnonymousUsersId.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAnonymousUsersIdResults = qraft.v1Service.getAnonymousUsersId.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getAnonymousUsersIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAnonymousUsersIdCombinedResults = qraft.v1Service.getAnonymousUsersId.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getAnonymousUsersIdCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Retrieves an anonymous user by id */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAnonymousUsersId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAnonymousUsersId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAnonymousUsersId.useSuspenseInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + OperationInfiniteData, + GetAnonymousUsersIdData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetAnonymousUsersIdError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAnonymousUsersIdData = qraft.v1Service.getAnonymousUsersId.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getAnonymousUsersIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAnonymousUsersIdCombinedData = qraft.v1Service.getAnonymousUsersId.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getAnonymousUsersIdCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Retrieves an anonymous user by id + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAnonymousUsersId.useSuspenseQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetAnonymousUsersIdData, + GetAnonymousUsersIdError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetAnonymousUsersIdSchema; + types: { + parameters: GetAnonymousUsersIdParameters; + data: GetAnonymousUsersIdData; + error: GetAnonymousUsersIdError; + }; + }; + /** @summary Registers a new user */ + postRegisterUser: { + /** @summary Registers a new user */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Registers a new user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postRegisterUser.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postRegisterUser.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostRegisterUserSchema, + PostRegisterUserData, + PostRegisterUserParameters, + TVariables, + PostRegisterUserError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Registers a new user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postRegisterUser.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postRegisterUser.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostRegisterUserSchema, + PostRegisterUserData, + PostRegisterUserParameters, + TVariables, + PostRegisterUserError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Registers a new user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postRegisterUserTotal = qraft.v1Service.postRegisterUser.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postRegisterUserTotal = qraft.v1Service.postRegisterUser.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostRegisterUserSchema, + PostRegisterUserBody, + PostRegisterUserData, + PostRegisterUserParameters, + PostRegisterUserError | Error, + TContext + > + ): number; + /** @summary Registers a new user */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostRegisterUserSchema, + PostRegisterUserBody, + PostRegisterUserData, + PostRegisterUserParameters, + PostRegisterUserError | Error, + TContext + > + ): number; + /** @summary Registers a new user */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostRegisterUserSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Registers a new user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postRegisterUserPendingMutationVariables = qraft.v1Service.postRegisterUser.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postRegisterUserMutationData = qraft.v1Service.postRegisterUser.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostRegisterUserData, + PostRegisterUserError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostRegisterUserSchema, + PostRegisterUserBody, + PostRegisterUserData, + PostRegisterUserParameters, + PostRegisterUserError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PostRegisterUserSchema; + types: { + parameters: PostRegisterUserParameters; + data: PostRegisterUserData; + error: PostRegisterUserError; + body: PostRegisterUserBody; + }; + }; + /** @summary Retrieves the logged in user */ + getUserMe: { + /** @summary Retrieves the logged in user */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Retrieves the logged in user */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUserMe.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUserMe.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** @summary Retrieves the logged in user */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetUserMeError> | void + ): Promise>; + /** @summary Retrieves the logged in user */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetUserMeError> | void + ): Promise; + /** @summary Retrieves the logged in user */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetUserMeSchema, + GetUserMeData, + GetUserMeParameters, + DeepReadonly, + GetUserMeError + > | void + ): Promise>; + /** @summary Retrieves the logged in user */ + fetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Retrieves the logged in user */ + prefetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Retrieves the logged in user */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Retrieves the logged in user */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Retrieves the logged in user */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetUserMeData | undefined]>; + /** @summary Retrieves the logged in user */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetUserMeData | undefined; + /** @summary Retrieves the logged in user */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Retrieves the logged in user */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetUserMeError> | undefined; + /** @summary Retrieves the logged in user */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Retrieves the logged in user */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Retrieves the logged in user */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetUserMeSchema, + options: { + parameters: GetUserMeParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Retrieves the logged in user */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Retrieves the logged in user */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Retrieves the logged in user */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Retrieves the logged in user */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Retrieves the logged in user */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Retrieves the logged in user */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetUserMeData | undefined; + /** @summary Retrieves the logged in user */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUserMe.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUserMeError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUserMe.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetUserMeError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getUserMeTotal = qraft.v1Service.getUserMe.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getUserMeResults = qraft.v1Service.getUserMe.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getUserMeResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getUserMeCombinedResults = qraft.v1Service.getUserMe.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getUserMeCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Retrieves the logged in user */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUserMe.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getUserMe.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getUserMe.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetUserMeData, + GetUserMeError, + OperationInfiniteData, + GetUserMeData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetUserMeError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getUserMeData = qraft.v1Service.getUserMe.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getUserMeResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getUserMeCombinedData = qraft.v1Service.getUserMe.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getUserMeCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Retrieves the logged in user + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getUserMe.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetUserMeSchema; + types: { + parameters: GetUserMeParameters; + data: GetUserMeData; + error: GetUserMeError; + }; + }; + /** @summary Resends a verification email */ + postSendVerificationEmail: { + /** @summary Resends a verification email */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Resends a verification email + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postSendVerificationEmail.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postSendVerificationEmail.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostSendVerificationEmailSchema, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + TVariables, + PostSendVerificationEmailError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Resends a verification email + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postSendVerificationEmail.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postSendVerificationEmail.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostSendVerificationEmailSchema, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + TVariables, + PostSendVerificationEmailError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Resends a verification email + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postSendVerificationEmailTotal = qraft.v1Service.postSendVerificationEmail.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postSendVerificationEmailTotal = qraft.v1Service.postSendVerificationEmail.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostSendVerificationEmailSchema, + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + > + ): number; + /** @summary Resends a verification email */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostSendVerificationEmailSchema, + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + > + ): number; + /** @summary Resends a verification email */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostSendVerificationEmailSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Resends a verification email + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postSendVerificationEmailPendingMutationVariables = qraft.v1Service.postSendVerificationEmail.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postSendVerificationEmailMutationData = qraft.v1Service.postSendVerificationEmail.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostSendVerificationEmailData, + PostSendVerificationEmailError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostSendVerificationEmailSchema, + PostSendVerificationEmailBody, + PostSendVerificationEmailData, + PostSendVerificationEmailParameters, + PostSendVerificationEmailError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostSendVerificationEmailData, + PostSendVerificationEmailError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostSendVerificationEmailSchema; + types: { + parameters: PostSendVerificationEmailParameters; + data: PostSendVerificationEmailData; + error: PostSendVerificationEmailError; + body: PostSendVerificationEmailBody; + }; + }; + /** @summary Checks if the email is verified */ + postVerifyEmail: { + /** @summary Checks if the email is verified */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Checks if the email is verified + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postVerifyEmail.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postVerifyEmail.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostVerifyEmailSchema, + PostVerifyEmailData, + PostVerifyEmailParameters, + TVariables, + PostVerifyEmailError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Checks if the email is verified + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postVerifyEmail.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postVerifyEmail.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostVerifyEmailSchema, + PostVerifyEmailData, + PostVerifyEmailParameters, + TVariables, + PostVerifyEmailError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Checks if the email is verified + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postVerifyEmailTotal = qraft.v1Service.postVerifyEmail.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postVerifyEmailTotal = qraft.v1Service.postVerifyEmail.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostVerifyEmailSchema, + PostVerifyEmailBody, + PostVerifyEmailData, + PostVerifyEmailParameters, + PostVerifyEmailError | Error, + TContext + > + ): number; + /** @summary Checks if the email is verified */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostVerifyEmailSchema, + PostVerifyEmailBody, + PostVerifyEmailData, + PostVerifyEmailParameters, + PostVerifyEmailError | Error, + TContext + > + ): number; + /** @summary Checks if the email is verified */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostVerifyEmailSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Checks if the email is verified + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postVerifyEmailPendingMutationVariables = qraft.v1Service.postVerifyEmail.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postVerifyEmailMutationData = qraft.v1Service.postVerifyEmail.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostVerifyEmailSchema, + PostVerifyEmailBody, + PostVerifyEmailData, + PostVerifyEmailParameters, + PostVerifyEmailError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PostVerifyEmailSchema; + types: { + parameters: PostVerifyEmailParameters; + data: PostVerifyEmailData; + error: PostVerifyEmailError; + body: PostVerifyEmailBody; + }; + }; + /** @summary Get deployment settings by user ID and dseq */ + getDeploymentSettingsUserIdDseq: { + /** @summary Get deployment settings by user ID and dseq */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + >, + options?: CancelOptions + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get deployment settings by user ID and dseq */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + DeepReadonly, + GetDeploymentSettingsUserIdDseqError + > + ): Promise>; + /** @summary Get deployment settings by user ID and dseq */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + DeepReadonly, + GetDeploymentSettingsUserIdDseqError + > + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + DeepReadonly, + GetDeploymentSettingsUserIdDseqError + > + ): Promise>; + /** @summary Get deployment settings by user ID and dseq */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get deployment settings by user ID and dseq */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetDeploymentSettingsUserIdDseqData | undefined + ] + >; + /** @summary Get deployment settings by user ID and dseq */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetDeploymentSettingsUserIdDseqData | undefined; + /** @summary Get deployment settings by user ID and dseq */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get deployment settings by user ID and dseq */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState, GetDeploymentSettingsUserIdDseqError> + | undefined; + /** @summary Get deployment settings by user ID and dseq */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): number; + /** @summary Get deployment settings by user ID and dseq */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetDeploymentSettingsUserIdDseqSchema, + options: { + parameters: GetDeploymentSettingsUserIdDseqParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get deployment settings by user ID and dseq */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): void; + /** @summary Get deployment settings by user ID and dseq */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + >, + options?: ResetOptions + ): Promise; + /** @summary Get deployment settings by user ID and dseq */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get deployment settings by user ID and dseq */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get deployment settings by user ID and dseq */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDeploymentSettingsUserIdDseqData | undefined; + /** @summary Get deployment settings by user ID and dseq */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useInfiniteQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentSettingsUserIdDseqParameters, + TQueryFnData = GetDeploymentSettingsUserIdDseqData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useInfiniteQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentSettingsUserIdDseqParameters, + TQueryFnData = GetDeploymentSettingsUserIdDseqData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentSettingsUserIdDseqTotal = qraft.v1Service.getDeploymentSettingsUserIdDseq.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentSettingsUserIdDseqByParametersTotal = qraft.v1Service.getDeploymentSettingsUserIdDseq.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * userId: userId, + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqData, + TInfinite, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentSettingsUserIdDseqResults = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQueries({ + * queries: [ + * { + * path: { + * userId: userId1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * userId: userId2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentSettingsUserIdDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentSettingsUserIdDseqCombinedResults = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * userId: userId1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * userId: userId2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentSettingsUserIdDseqCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get deployment settings by user ID and dseq */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentSettingsUserIdDseq.useSuspenseInfiniteQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + OperationInfiniteData, + GetDeploymentSettingsUserIdDseqData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDeploymentSettingsUserIdDseqError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentSettingsUserIdDseqData = qraft.v1Service.getDeploymentSettingsUserIdDseq.useSuspenseQueries({ + * queries: [ + * { + * path: { + * userId: userId1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * userId: userId2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentSettingsUserIdDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentSettingsUserIdDseqCombinedData = qraft.v1Service.getDeploymentSettingsUserIdDseq.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * userId: userId1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * userId: userId2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentSettingsUserIdDseqCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetDeploymentSettingsUserIdDseqSchema, + GetDeploymentSettingsUserIdDseqParameters, + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get deployment settings by user ID and dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getDeploymentSettingsUserIdDseq.useSuspenseQuery({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentSettingsUserIdDseqData, + GetDeploymentSettingsUserIdDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentSettingsUserIdDseqSchema; + types: { + parameters: GetDeploymentSettingsUserIdDseqParameters; + data: GetDeploymentSettingsUserIdDseqData; + error: GetDeploymentSettingsUserIdDseqError; + }; + }; + /** @summary Update deployment settings */ + patchDeploymentSettingsUserIdDseq: { + /** @summary Update deployment settings */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutation({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * userId: userId, + * dseq: dseq + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PatchDeploymentSettingsUserIdDseqSchema, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + TVariables, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutation({ + * path: { + * userId: userId, + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * userId: userId, + * dseq: dseq + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PatchDeploymentSettingsUserIdDseqSchema, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + TVariables, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Update deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const patchDeploymentSettingsUserIdDseqTotal = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const patchDeploymentSettingsUserIdDseqTotal = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useIsMutating({ + * parameters: { + * path: { + * userId: userId, + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchDeploymentSettingsUserIdDseqSchema, + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + ): number; + /** @summary Update deployment settings */ + isMutating( + filters?: + | MutationFiltersByParameters< + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchDeploymentSettingsUserIdDseqSchema, + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + ): number; + /** @summary Update deployment settings */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PatchDeploymentSettingsUserIdDseqSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Update deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const patchDeploymentSettingsUserIdDseqPendingMutationVariables = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const patchDeploymentSettingsUserIdDseqMutationData = qraft.v1Service.patchDeploymentSettingsUserIdDseq.useMutationState({ + * filters: { + * parameters: { + * path: { + * userId: userId, + * dseq: dseq + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchDeploymentSettingsUserIdDseqSchema, + PatchDeploymentSettingsUserIdDseqBody, + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqParameters, + PatchDeploymentSettingsUserIdDseqError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PatchDeploymentSettingsUserIdDseqData, + PatchDeploymentSettingsUserIdDseqError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PatchDeploymentSettingsUserIdDseqSchema; + types: { + parameters: PatchDeploymentSettingsUserIdDseqParameters; + data: PatchDeploymentSettingsUserIdDseqData; + error: PatchDeploymentSettingsUserIdDseqError; + body: PatchDeploymentSettingsUserIdDseqBody; + }; + }; + /** @summary Create deployment settings */ + postDeploymentSettings: { + /** @summary Create deployment settings */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeploymentSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeploymentSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostDeploymentSettingsSchema, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + TVariables, + PostDeploymentSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeploymentSettings.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeploymentSettings.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostDeploymentSettingsSchema, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + TVariables, + PostDeploymentSettingsError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postDeploymentSettingsTotal = qraft.v1Service.postDeploymentSettings.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postDeploymentSettingsTotal = qraft.v1Service.postDeploymentSettings.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDeploymentSettingsSchema, + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + > + ): number; + /** @summary Create deployment settings */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDeploymentSettingsSchema, + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + > + ): number; + /** @summary Create deployment settings */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostDeploymentSettingsSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create deployment settings + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postDeploymentSettingsPendingMutationVariables = qraft.v1Service.postDeploymentSettings.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postDeploymentSettingsMutationData = qraft.v1Service.postDeploymentSettings.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostDeploymentSettingsData, + PostDeploymentSettingsError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDeploymentSettingsSchema, + PostDeploymentSettingsBody, + PostDeploymentSettingsData, + PostDeploymentSettingsParameters, + PostDeploymentSettingsError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostDeploymentSettingsData, + PostDeploymentSettingsError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostDeploymentSettingsSchema; + types: { + parameters: PostDeploymentSettingsParameters; + data: PostDeploymentSettingsData; + error: PostDeploymentSettingsError; + body: PostDeploymentSettingsBody; + }; + }; + /** @summary Get a deployment */ + getDeploymentsDseq: { + /** @summary Get a deployment */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a deployment */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a deployment */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentsDseqSchema, + GetDeploymentsDseqData, + GetDeploymentsDseqParameters, + DeepReadonly, + GetDeploymentsDseqError + > + ): Promise>; + /** @summary Get a deployment */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentsDseqSchema, + GetDeploymentsDseqData, + GetDeploymentsDseqParameters, + DeepReadonly, + GetDeploymentsDseqError + > + ): Promise; + /** @summary Get a deployment */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentsDseqSchema, + GetDeploymentsDseqData, + GetDeploymentsDseqParameters, + DeepReadonly, + GetDeploymentsDseqError + > + ): Promise>; + /** @summary Get a deployment */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a deployment */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a deployment */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary Get a deployment */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a deployment */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetDeploymentsDseqData | undefined]>; + /** @summary Get a deployment */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetDeploymentsDseqData | undefined; + /** @summary Get a deployment */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get a deployment */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetDeploymentsDseqError> | undefined; + /** @summary Get a deployment */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a deployment */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a deployment */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetDeploymentsDseqSchema, + options: { + parameters: GetDeploymentsDseqParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a deployment */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a deployment */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a deployment */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a deployment */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a deployment */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a deployment */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDeploymentsDseqData | undefined; + /** @summary Get a deployment */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentsDseq.useInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentsDseqParameters, + TQueryFnData = GetDeploymentsDseqData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentsDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentsDseq.useInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentsDseqParameters, + TQueryFnData = GetDeploymentsDseqData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentsDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentsDseqTotal = qraft.v1Service.getDeploymentsDseq.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentsDseqByParametersTotal = qraft.v1Service.getDeploymentsDseq.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentsDseqResults = qraft.v1Service.getDeploymentsDseq.useQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentsDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentsDseqCombinedResults = qraft.v1Service.getDeploymentsDseq.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentsDseqCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a deployment */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentsDseq.useSuspenseInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + OperationInfiniteData, + GetDeploymentsDseqData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDeploymentsDseqError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentsDseqData = qraft.v1Service.getDeploymentsDseq.useSuspenseQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentsDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentsDseqCombinedData = qraft.v1Service.getDeploymentsDseq.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentsDseqCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getDeploymentsDseq.useSuspenseQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentsDseqData, + GetDeploymentsDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentsDseqSchema; + types: { + parameters: GetDeploymentsDseqParameters; + data: GetDeploymentsDseqData; + error: GetDeploymentsDseqError; + }; + }; + /** @summary Close a deployment */ + deleteDeploymentsDseq: { + /** @summary Close a deployment */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Close a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteDeploymentsDseq.useMutation({ + * path: { + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteDeploymentsDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + DeleteDeploymentsDseqSchema, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + TVariables, + DeleteDeploymentsDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Close a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteDeploymentsDseq.useMutation({ + * path: { + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteDeploymentsDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + DeleteDeploymentsDseqSchema, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + TVariables, + DeleteDeploymentsDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Close a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteDeploymentsDseqTotal = qraft.v1Service.deleteDeploymentsDseq.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteDeploymentsDseqTotal = qraft.v1Service.deleteDeploymentsDseq.useIsMutating({ + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteDeploymentsDseqSchema, + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + > + ): number; + /** @summary Close a deployment */ + isMutating( + filters?: + | MutationFiltersByParameters< + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteDeploymentsDseqSchema, + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + > + ): number; + /** @summary Close a deployment */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteDeploymentsDseqSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Close a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteDeploymentsDseqPendingMutationVariables = qraft.v1Service.deleteDeploymentsDseq.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteDeploymentsDseqMutationData = qraft.v1Service.deleteDeploymentsDseq.useMutationState({ + * filters: { + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteDeploymentsDseqSchema, + DeleteDeploymentsDseqBody, + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqParameters, + DeleteDeploymentsDseqError | Error, + TContext + >; + select?: ( + mutation: Mutation< + DeleteDeploymentsDseqData, + DeleteDeploymentsDseqError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: DeleteDeploymentsDseqSchema; + types: { + parameters: DeleteDeploymentsDseqParameters; + data: DeleteDeploymentsDseqData; + error: DeleteDeploymentsDseqError; + body: DeleteDeploymentsDseqBody; + }; + }; + /** @summary Update a deployment */ + putDeploymentsDseq: { + /** @summary Update a deployment */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putDeploymentsDseq.useMutation({ + * path: { + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putDeploymentsDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PutDeploymentsDseqSchema, + PutDeploymentsDseqData, + PutDeploymentsDseqParameters, + TVariables, + PutDeploymentsDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putDeploymentsDseq.useMutation({ + * path: { + * dseq: dseq + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.putDeploymentsDseq.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PutDeploymentsDseqSchema, + PutDeploymentsDseqData, + PutDeploymentsDseqParameters, + TVariables, + PutDeploymentsDseqError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Update a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const putDeploymentsDseqTotal = qraft.v1Service.putDeploymentsDseq.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const putDeploymentsDseqTotal = qraft.v1Service.putDeploymentsDseq.useIsMutating({ + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutDeploymentsDseqSchema, + PutDeploymentsDseqBody, + PutDeploymentsDseqData, + PutDeploymentsDseqParameters, + PutDeploymentsDseqError | Error, + TContext + > + ): number; + /** @summary Update a deployment */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutDeploymentsDseqSchema, + PutDeploymentsDseqBody, + PutDeploymentsDseqData, + PutDeploymentsDseqParameters, + PutDeploymentsDseqError | Error, + TContext + > + ): number; + /** @summary Update a deployment */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PutDeploymentsDseqSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Update a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const putDeploymentsDseqPendingMutationVariables = qraft.v1Service.putDeploymentsDseq.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const putDeploymentsDseqMutationData = qraft.v1Service.putDeploymentsDseq.useMutationState({ + * filters: { + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PutDeploymentsDseqData, + PutDeploymentsDseqError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PutDeploymentsDseqSchema, + PutDeploymentsDseqBody, + PutDeploymentsDseqData, + PutDeploymentsDseqParameters, + PutDeploymentsDseqError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PutDeploymentsDseqData, + PutDeploymentsDseqError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PutDeploymentsDseqSchema; + types: { + parameters: PutDeploymentsDseqParameters; + data: PutDeploymentsDseqData; + error: PutDeploymentsDseqError; + body: PutDeploymentsDseqBody; + }; + }; + /** @summary Create new deployment */ + postDeployments: { + /** @summary Create new deployment */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeployments.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeployments.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostDeploymentsSchema, + PostDeploymentsData, + PostDeploymentsParameters, + TVariables, + PostDeploymentsError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeployments.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDeployments.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostDeploymentsSchema, + PostDeploymentsData, + PostDeploymentsParameters, + TVariables, + PostDeploymentsError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create new deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postDeploymentsTotal = qraft.v1Service.postDeployments.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postDeploymentsTotal = qraft.v1Service.postDeployments.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostDeploymentsSchema, + PostDeploymentsBody, + PostDeploymentsData, + PostDeploymentsParameters, + PostDeploymentsError | Error, + TContext + > + ): number; + /** @summary Create new deployment */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostDeploymentsSchema, + PostDeploymentsBody, + PostDeploymentsData, + PostDeploymentsParameters, + PostDeploymentsError | Error, + TContext + > + ): number; + /** @summary Create new deployment */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostDeploymentsSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create new deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postDeploymentsPendingMutationVariables = qraft.v1Service.postDeployments.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postDeploymentsMutationData = qraft.v1Service.postDeployments.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostDeploymentsSchema, + PostDeploymentsBody, + PostDeploymentsData, + PostDeploymentsParameters, + PostDeploymentsError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PostDeploymentsSchema; + types: { + parameters: PostDeploymentsParameters; + data: PostDeploymentsData; + error: PostDeploymentsError; + body: PostDeploymentsBody; + }; + }; + /** @summary List deployments with pagination and filtering */ + getDeployments: { + /** @summary List deployments with pagination and filtering */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary List deployments with pagination and filtering */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery({ + * query: { + * skip: skip + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery({ + * query: { + * skip: skip + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary List deployments with pagination and filtering */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentsSchema, + GetDeploymentsData, + GetDeploymentsParameters, + DeepReadonly, + GetDeploymentsError + > | void + ): Promise>; + /** @summary List deployments with pagination and filtering */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentsSchema, + GetDeploymentsData, + GetDeploymentsParameters, + DeepReadonly, + GetDeploymentsError + > | void + ): Promise; + /** @summary List deployments with pagination and filtering */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentsSchema, + GetDeploymentsData, + GetDeploymentsParameters, + DeepReadonly, + GetDeploymentsError + > | void + ): Promise>; + /** @summary List deployments with pagination and filtering */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary List deployments with pagination and filtering */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary List deployments with pagination and filtering */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary List deployments with pagination and filtering */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary List deployments with pagination and filtering */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetDeploymentsData | undefined]>; + /** @summary List deployments with pagination and filtering */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetDeploymentsData | undefined; + /** @summary List deployments with pagination and filtering */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary List deployments with pagination and filtering */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetDeploymentsError> | undefined; + /** @summary List deployments with pagination and filtering */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary List deployments with pagination and filtering */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary List deployments with pagination and filtering */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetDeploymentsSchema, + options: { + parameters: GetDeploymentsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List deployments with pagination and filtering */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary List deployments with pagination and filtering */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary List deployments with pagination and filtering */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary List deployments with pagination and filtering */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List deployments with pagination and filtering */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List deployments with pagination and filtering */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDeploymentsData | undefined; + /** @summary List deployments with pagination and filtering */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeployments.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * skip: initialSkip + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentsParameters, + TQueryFnData = GetDeploymentsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeployments.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * skip: initialSkip + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentsParameters, + TQueryFnData = GetDeploymentsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentsTotal = qraft.v1Service.getDeployments.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentsByParametersTotal = qraft.v1Service.getDeployments.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * skip: skip + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentsResults = qraft.v1Service.getDeployments.useQueries({ + * queries: [ + * { + * query: { + * skip: skip1 + * } + * }, + * { + * query: { + * skip: skip2 + * } + * } + * ] + * }); + * getDeploymentsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentsCombinedResults = qraft.v1Service.getDeployments.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * skip: skip1 + * } + * }, + * { + * query: { + * skip: skip2 + * } + * } + * ] + * }); + * getDeploymentsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List deployments with pagination and filtering */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery({ + * query: { + * skip: skip + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeployments.useQuery({ + * query: { + * skip: skip + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeployments.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * skip: initialSkip + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentsData, + GetDeploymentsError, + OperationInfiniteData, + GetDeploymentsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDeploymentsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentsData = qraft.v1Service.getDeployments.useSuspenseQueries({ + * queries: [ + * { + * query: { + * skip: skip1 + * } + * }, + * { + * query: { + * skip: skip2 + * } + * } + * ] + * }); + * getDeploymentsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentsCombinedData = qraft.v1Service.getDeployments.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * skip: skip1 + * } + * }, + * { + * query: { + * skip: skip2 + * } + * } + * ] + * }); + * getDeploymentsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List deployments with pagination and filtering + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getDeployments.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getDeployments.useSuspenseQuery({ + * query: { + * skip: skip + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentsSchema; + types: { + parameters: GetDeploymentsParameters; + data: GetDeploymentsData; + error: GetDeploymentsError; + }; + }; + /** @summary Deposit into a deployment */ + postDepositDeployment: { + /** @summary Deposit into a deployment */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Deposit into a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDepositDeployment.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDepositDeployment.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostDepositDeploymentSchema, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + TVariables, + PostDepositDeploymentError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Deposit into a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDepositDeployment.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postDepositDeployment.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostDepositDeploymentSchema, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + TVariables, + PostDepositDeploymentError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Deposit into a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postDepositDeploymentTotal = qraft.v1Service.postDepositDeployment.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postDepositDeploymentTotal = qraft.v1Service.postDepositDeployment.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDepositDeploymentSchema, + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + > + ): number; + /** @summary Deposit into a deployment */ + isMutating( + filters?: + | MutationFiltersByParameters< + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDepositDeploymentSchema, + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + > + ): number; + /** @summary Deposit into a deployment */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostDepositDeploymentSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Deposit into a deployment + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postDepositDeploymentPendingMutationVariables = qraft.v1Service.postDepositDeployment.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postDepositDeploymentMutationData = qraft.v1Service.postDepositDeployment.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostDepositDeploymentData, + PostDepositDeploymentError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + > + | MutationFiltersByMutationKey< + PostDepositDeploymentSchema, + PostDepositDeploymentBody, + PostDepositDeploymentData, + PostDepositDeploymentParameters, + PostDepositDeploymentError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostDepositDeploymentData, + PostDepositDeploymentError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostDepositDeploymentSchema; + types: { + parameters: PostDepositDeploymentParameters; + data: PostDepositDeploymentData; + error: PostDepositDeploymentError; + body: PostDepositDeploymentBody; + }; + }; + /** @summary Get a list of deployments by owner address. */ + getAddressesAddressDeploymentsSkipLimit: { + /** @summary Get a list of deployments by owner address. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + >, + options?: CancelOptions + ): Promise; + /** @summary Get a list of deployments by owner address. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of deployments by owner address. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise>; + /** @summary Get a list of deployments by owner address. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments by owner address. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise>; + /** @summary Get a list of deployments by owner address. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments by owner address. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments by owner address. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments by owner address. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a list of deployments by owner address. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetAddressesAddressDeploymentsSkipLimitData | undefined + ] + >; + /** @summary Get a list of deployments by owner address. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetAddressesAddressDeploymentsSkipLimitData | undefined; + /** @summary Get a list of deployments by owner address. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get a list of deployments by owner address. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState< + OperationInfiniteData, + GetAddressesAddressDeploymentsSkipLimitError + > + | undefined; + /** @summary Get a list of deployments by owner address. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of deployments by owner address. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): number; + /** @summary Get a list of deployments by owner address. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetAddressesAddressDeploymentsSkipLimitSchema, + options: { + parameters: GetAddressesAddressDeploymentsSkipLimitParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of deployments by owner address. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of deployments by owner address. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): void; + /** @summary Get a list of deployments by owner address. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + >, + options?: ResetOptions + ): Promise; + /** @summary Get a list of deployments by owner address. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of deployments by owner address. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of deployments by owner address. */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetAddressesAddressDeploymentsSkipLimitData | undefined; + /** @summary Get a list of deployments by owner address. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressDeploymentsSkipLimitParameters, + TQueryFnData = GetAddressesAddressDeploymentsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressDeploymentsSkipLimitParameters, + TQueryFnData = GetAddressesAddressDeploymentsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAddressesAddressDeploymentsSkipLimitTotal = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAddressesAddressDeploymentsSkipLimitByParametersTotal = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitData, + TInfinite, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAddressesAddressDeploymentsSkipLimitResults = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQueries({ + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getAddressesAddressDeploymentsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAddressesAddressDeploymentsSkipLimitCombinedResults = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getAddressesAddressDeploymentsSkipLimitCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of deployments by owner address. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useSuspenseInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + OperationInfiniteData, + GetAddressesAddressDeploymentsSkipLimitData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetAddressesAddressDeploymentsSkipLimitError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAddressesAddressDeploymentsSkipLimitData = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useSuspenseQueries({ + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getAddressesAddressDeploymentsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAddressesAddressDeploymentsSkipLimitCombinedData = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getAddressesAddressDeploymentsSkipLimitCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetAddressesAddressDeploymentsSkipLimitSchema, + GetAddressesAddressDeploymentsSkipLimitParameters, + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of deployments by owner address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAddressesAddressDeploymentsSkipLimit.useSuspenseQuery({ + * path: { + * address: address, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetAddressesAddressDeploymentsSkipLimitData, + GetAddressesAddressDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetAddressesAddressDeploymentsSkipLimitSchema; + types: { + parameters: GetAddressesAddressDeploymentsSkipLimitParameters; + data: GetAddressesAddressDeploymentsSkipLimitData; + error: GetAddressesAddressDeploymentsSkipLimitError; + }; + }; + /** @summary Get deployment details */ + getDeploymentOwnerDseq: { + /** @summary Get deployment details */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + >, + options?: CancelOptions + ): Promise; + /** @summary Get deployment details */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentOwnerDseq.useQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentOwnerDseq.useQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get deployment details */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + DeepReadonly, + GetDeploymentOwnerDseqError + > + ): Promise>; + /** @summary Get deployment details */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + DeepReadonly, + GetDeploymentOwnerDseqError + > + ): Promise; + /** @summary Get deployment details */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + DeepReadonly, + GetDeploymentOwnerDseqError + > + ): Promise>; + /** @summary Get deployment details */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): Promise; + /** @summary Get deployment details */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): Promise; + /** @summary Get deployment details */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): Promise; + /** @summary Get deployment details */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get deployment details */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [queryKey: ServiceOperationQueryKey, data: GetDeploymentOwnerDseqData | undefined] + >; + /** @summary Get deployment details */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetDeploymentOwnerDseqData | undefined; + /** @summary Get deployment details */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get deployment details */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetDeploymentOwnerDseqError> | undefined; + /** @summary Get deployment details */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get deployment details */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): number; + /** @summary Get deployment details */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetDeploymentOwnerDseqSchema, + options: { + parameters: GetDeploymentOwnerDseqParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get deployment details */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get deployment details */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): void; + /** @summary Get deployment details */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + >, + options?: ResetOptions + ): Promise; + /** @summary Get deployment details */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get deployment details */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get deployment details */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDeploymentOwnerDseqData | undefined; + /** @summary Get deployment details */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentOwnerDseq.useInfiniteQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentOwnerDseqParameters, + TQueryFnData = GetDeploymentOwnerDseqData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentOwnerDseq.useInfiniteQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentOwnerDseqParameters, + TQueryFnData = GetDeploymentOwnerDseqData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentOwnerDseqTotal = qraft.v1Service.getDeploymentOwnerDseq.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentOwnerDseqByParametersTotal = qraft.v1Service.getDeploymentOwnerDseq.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * owner: owner, + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + | QueryFiltersByQueryKey< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqData, + TInfinite, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentOwnerDseqResults = qraft.v1Service.getDeploymentOwnerDseq.useQueries({ + * queries: [ + * { + * path: { + * owner: owner1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentOwnerDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentOwnerDseqCombinedResults = qraft.v1Service.getDeploymentOwnerDseq.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentOwnerDseqCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get deployment details */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentOwnerDseq.useQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentOwnerDseq.useQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentOwnerDseq.useSuspenseInfiniteQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + OperationInfiniteData, + GetDeploymentOwnerDseqData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDeploymentOwnerDseqError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentOwnerDseqData = qraft.v1Service.getDeploymentOwnerDseq.useSuspenseQueries({ + * queries: [ + * { + * path: { + * owner: owner1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentOwnerDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentOwnerDseqCombinedData = qraft.v1Service.getDeploymentOwnerDseq.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1, + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2, + * dseq: dseq2 + * } + * } + * ] + * }); + * getDeploymentOwnerDseqCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetDeploymentOwnerDseqSchema, + GetDeploymentOwnerDseqParameters, + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get deployment details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getDeploymentOwnerDseq.useSuspenseQuery({ + * path: { + * owner: owner, + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentOwnerDseqData, + GetDeploymentOwnerDseqError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentOwnerDseqSchema; + types: { + parameters: GetDeploymentOwnerDseqParameters; + data: GetDeploymentOwnerDseqData; + error: GetDeploymentOwnerDseqError; + }; + }; + /** @summary Get weekly deployment cost */ + getWeeklyCost: { + /** @summary Get weekly deployment cost */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get weekly deployment cost */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWeeklyCost.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWeeklyCost.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get weekly deployment cost */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetWeeklyCostSchema, + GetWeeklyCostData, + GetWeeklyCostParameters, + DeepReadonly, + GetWeeklyCostError + > | void + ): Promise>; + /** @summary Get weekly deployment cost */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetWeeklyCostSchema, + GetWeeklyCostData, + GetWeeklyCostParameters, + DeepReadonly, + GetWeeklyCostError + > | void + ): Promise; + /** @summary Get weekly deployment cost */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetWeeklyCostSchema, + GetWeeklyCostData, + GetWeeklyCostParameters, + DeepReadonly, + GetWeeklyCostError + > | void + ): Promise>; + /** @summary Get weekly deployment cost */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get weekly deployment cost */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get weekly deployment cost */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get weekly deployment cost */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get weekly deployment cost */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetWeeklyCostData | undefined]>; + /** @summary Get weekly deployment cost */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetWeeklyCostData | undefined; + /** @summary Get weekly deployment cost */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get weekly deployment cost */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetWeeklyCostError> | undefined; + /** @summary Get weekly deployment cost */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get weekly deployment cost */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get weekly deployment cost */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetWeeklyCostSchema, + options: { + parameters: GetWeeklyCostParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get weekly deployment cost */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get weekly deployment cost */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get weekly deployment cost */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get weekly deployment cost */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get weekly deployment cost */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get weekly deployment cost */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetWeeklyCostData | undefined; + /** @summary Get weekly deployment cost */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWeeklyCost.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetWeeklyCostParameters, + TQueryFnData = GetWeeklyCostData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWeeklyCostError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWeeklyCost.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetWeeklyCostParameters, + TQueryFnData = GetWeeklyCostData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetWeeklyCostError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getWeeklyCostTotal = qraft.v1Service.getWeeklyCost.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getWeeklyCostResults = qraft.v1Service.getWeeklyCost.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getWeeklyCostResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getWeeklyCostCombinedResults = qraft.v1Service.getWeeklyCost.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getWeeklyCostCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get weekly deployment cost */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWeeklyCost.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getWeeklyCost.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getWeeklyCost.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetWeeklyCostData, + GetWeeklyCostError, + OperationInfiniteData, + GetWeeklyCostData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetWeeklyCostError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getWeeklyCostData = qraft.v1Service.getWeeklyCost.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getWeeklyCostResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getWeeklyCostCombinedData = qraft.v1Service.getWeeklyCost.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getWeeklyCostCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get weekly deployment cost + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getWeeklyCost.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetWeeklyCostSchema; + types: { + parameters: GetWeeklyCostParameters; + data: GetWeeklyCostData; + error: GetWeeklyCostError; + }; + }; + /** @summary Create leases and send manifest */ + postLeases: { + /** @summary Create leases and send manifest */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create leases and send manifest + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postLeases.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postLeases.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create leases and send manifest + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postLeases.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postLeases.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create leases and send manifest + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postLeasesTotal = qraft.v1Service.postLeases.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postLeasesTotal = qraft.v1Service.postLeases.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Create leases and send manifest */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Create leases and send manifest */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostLeasesSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create leases and send manifest + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postLeasesPendingMutationVariables = qraft.v1Service.postLeases.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postLeasesMutationData = qraft.v1Service.postLeases.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: PostLeasesSchema; + types: { + parameters: PostLeasesParameters; + data: PostLeasesData; + error: PostLeasesError; + body: PostLeasesBody; + }; + }; + /** @summary List all API keys */ + getApiKeys: { + /** @summary List all API keys */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary List all API keys */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeys.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeys.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary List all API keys */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetApiKeysSchema, + GetApiKeysData, + GetApiKeysParameters, + DeepReadonly, + GetApiKeysError + > | void + ): Promise>; + /** @summary List all API keys */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetApiKeysSchema, + GetApiKeysData, + GetApiKeysParameters, + DeepReadonly, + GetApiKeysError + > | void + ): Promise; + /** @summary List all API keys */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetApiKeysSchema, + GetApiKeysData, + GetApiKeysParameters, + DeepReadonly, + GetApiKeysError + > | void + ): Promise>; + /** @summary List all API keys */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary List all API keys */ + prefetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary List all API keys */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary List all API keys */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary List all API keys */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetApiKeysData | undefined]>; + /** @summary List all API keys */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetApiKeysData | undefined; + /** @summary List all API keys */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary List all API keys */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetApiKeysError> | undefined; + /** @summary List all API keys */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary List all API keys */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary List all API keys */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetApiKeysSchema, + options: { + parameters: GetApiKeysParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List all API keys */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary List all API keys */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary List all API keys */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary List all API keys */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List all API keys */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List all API keys */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetApiKeysData | undefined; + /** @summary List all API keys */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeys.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetApiKeysError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeys.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetApiKeysError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getApiKeysTotal = qraft.v1Service.getApiKeys.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getApiKeysResults = qraft.v1Service.getApiKeys.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getApiKeysResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getApiKeysCombinedResults = qraft.v1Service.getApiKeys.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getApiKeysCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List all API keys */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeys.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeys.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeys.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetApiKeysData, + GetApiKeysError, + OperationInfiniteData, + GetApiKeysData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetApiKeysError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getApiKeysData = qraft.v1Service.getApiKeys.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getApiKeysResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getApiKeysCombinedData = qraft.v1Service.getApiKeys.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getApiKeysCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List all API keys + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getApiKeys.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetApiKeysSchema; + types: { + parameters: GetApiKeysParameters; + data: GetApiKeysData; + error: GetApiKeysError; + }; + }; + /** @summary Create new API key */ + postApiKeys: { + /** @summary Create new API key */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postApiKeys.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postApiKeys.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postApiKeys.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postApiKeys.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create new API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postApiKeysTotal = qraft.v1Service.postApiKeys.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postApiKeysTotal = qraft.v1Service.postApiKeys.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Create new API key */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Create new API key */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostApiKeysSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create new API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postApiKeysPendingMutationVariables = qraft.v1Service.postApiKeys.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postApiKeysMutationData = qraft.v1Service.postApiKeys.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: PostApiKeysSchema; + types: { + parameters: PostApiKeysParameters; + data: PostApiKeysData; + error: PostApiKeysError; + body: PostApiKeysBody; + }; + }; + /** @summary Get API key by ID */ + getApiKeysId: { + /** @summary Get API key by ID */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get API key by ID */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeysId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeysId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get API key by ID */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetApiKeysIdSchema, + GetApiKeysIdData, + GetApiKeysIdParameters, + DeepReadonly, + GetApiKeysIdError + > + ): Promise>; + /** @summary Get API key by ID */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetApiKeysIdSchema, + GetApiKeysIdData, + GetApiKeysIdParameters, + DeepReadonly, + GetApiKeysIdError + > + ): Promise; + /** @summary Get API key by ID */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetApiKeysIdSchema, + GetApiKeysIdData, + GetApiKeysIdParameters, + DeepReadonly, + GetApiKeysIdError + > + ): Promise>; + /** @summary Get API key by ID */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get API key by ID */ + prefetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary Get API key by ID */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary Get API key by ID */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get API key by ID */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetApiKeysIdData | undefined]>; + /** @summary Get API key by ID */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetApiKeysIdData | undefined; + /** @summary Get API key by ID */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get API key by ID */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetApiKeysIdError> | undefined; + /** @summary Get API key by ID */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get API key by ID */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get API key by ID */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetApiKeysIdSchema, + options: { + parameters: GetApiKeysIdParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get API key by ID */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get API key by ID */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get API key by ID */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get API key by ID */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get API key by ID */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get API key by ID */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetApiKeysIdData | undefined; + /** @summary Get API key by ID */ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeysId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetApiKeysIdParameters, + TQueryFnData = GetApiKeysIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetApiKeysIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeysId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetApiKeysIdParameters, + TQueryFnData = GetApiKeysIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetApiKeysIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getApiKeysIdTotal = qraft.v1Service.getApiKeysId.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getApiKeysIdByParametersTotal = qraft.v1Service.getApiKeysId.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getApiKeysIdResults = qraft.v1Service.getApiKeysId.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getApiKeysIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getApiKeysIdCombinedResults = qraft.v1Service.getApiKeysId.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getApiKeysIdCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get API key by ID */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeysId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getApiKeysId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getApiKeysId.useSuspenseInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetApiKeysIdData, + GetApiKeysIdError, + OperationInfiniteData, + GetApiKeysIdData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetApiKeysIdError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getApiKeysIdData = qraft.v1Service.getApiKeysId.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getApiKeysIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getApiKeysIdCombinedData = qraft.v1Service.getApiKeysId.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getApiKeysIdCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get API key by ID + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getApiKeysId.useSuspenseQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetApiKeysIdSchema; + types: { + parameters: GetApiKeysIdParameters; + data: GetApiKeysIdData; + error: GetApiKeysIdError; + }; + }; + /** @summary Update API key */ + patchApiKeysId: { + /** @summary Update API key */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchApiKeysId.useMutation({ + * path: { + * id: id + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchApiKeysId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PatchApiKeysIdSchema, + PatchApiKeysIdData, + PatchApiKeysIdParameters, + TVariables, + PatchApiKeysIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Update API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchApiKeysId.useMutation({ + * path: { + * id: id + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchApiKeysId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PatchApiKeysIdSchema, + PatchApiKeysIdData, + PatchApiKeysIdParameters, + TVariables, + PatchApiKeysIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Update API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const patchApiKeysIdTotal = qraft.v1Service.patchApiKeysId.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const patchApiKeysIdTotal = qraft.v1Service.patchApiKeysId.useIsMutating({ + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PatchApiKeysIdSchema, + PatchApiKeysIdBody, + PatchApiKeysIdData, + PatchApiKeysIdParameters, + PatchApiKeysIdError | Error, + TContext + > + ): number; + /** @summary Update API key */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PatchApiKeysIdSchema, + PatchApiKeysIdBody, + PatchApiKeysIdData, + PatchApiKeysIdParameters, + PatchApiKeysIdError | Error, + TContext + > + ): number; + /** @summary Update API key */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PatchApiKeysIdSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Update API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const patchApiKeysIdPendingMutationVariables = qraft.v1Service.patchApiKeysId.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const patchApiKeysIdMutationData = qraft.v1Service.patchApiKeysId.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PatchApiKeysIdSchema, + PatchApiKeysIdBody, + PatchApiKeysIdData, + PatchApiKeysIdParameters, + PatchApiKeysIdError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PatchApiKeysIdSchema; + types: { + parameters: PatchApiKeysIdParameters; + data: PatchApiKeysIdData; + error: PatchApiKeysIdError; + body: PatchApiKeysIdBody; + }; + }; + /** @summary Delete API key */ + deleteApiKeysId: { + /** @summary Delete API key */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Delete API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteApiKeysId.useMutation({ + * path: { + * id: id + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteApiKeysId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + DeleteApiKeysIdSchema, + DeleteApiKeysIdData, + DeleteApiKeysIdParameters, + TVariables, + DeleteApiKeysIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Delete API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteApiKeysId.useMutation({ + * path: { + * id: id + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteApiKeysId.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + DeleteApiKeysIdSchema, + DeleteApiKeysIdData, + DeleteApiKeysIdParameters, + TVariables, + DeleteApiKeysIdError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Delete API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteApiKeysIdTotal = qraft.v1Service.deleteApiKeysId.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteApiKeysIdTotal = qraft.v1Service.deleteApiKeysId.useIsMutating({ + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + DeleteApiKeysIdSchema, + DeleteApiKeysIdBody, + DeleteApiKeysIdData, + DeleteApiKeysIdParameters, + DeleteApiKeysIdError | Error, + TContext + > + ): number; + /** @summary Delete API key */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + DeleteApiKeysIdSchema, + DeleteApiKeysIdBody, + DeleteApiKeysIdData, + DeleteApiKeysIdParameters, + DeleteApiKeysIdError | Error, + TContext + > + ): number; + /** @summary Delete API key */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteApiKeysIdSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Delete API key + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteApiKeysIdPendingMutationVariables = qraft.v1Service.deleteApiKeysId.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteApiKeysIdMutationData = qraft.v1Service.deleteApiKeysId.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + DeleteApiKeysIdSchema, + DeleteApiKeysIdBody, + DeleteApiKeysIdData, + DeleteApiKeysIdParameters, + DeleteApiKeysIdError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: DeleteApiKeysIdSchema; + types: { + parameters: DeleteApiKeysIdParameters; + data: DeleteApiKeysIdData; + error: DeleteApiKeysIdError; + body: DeleteApiKeysIdBody; + }; + }; + /** @summary List bids */ + getBids: { + /** @summary List bids */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary List bids */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBids.useQuery({ + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBids.useQuery({ + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** @summary List bids */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBidsError> + ): Promise>; + /** @summary List bids */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBidsError> + ): Promise; + /** @summary List bids */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions, GetBidsError> + ): Promise>; + /** @summary List bids */ + fetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary List bids */ + prefetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary List bids */ + ensureQueryData(options: ServiceOperationEnsureQueryDataOptions): Promise; + /** @summary List bids */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary List bids */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetBidsData | undefined]>; + /** @summary List bids */ + getQueryData(parameters: ServiceOperationQueryKey | DeepReadonly): GetBidsData | undefined; + /** @summary List bids */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary List bids */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetBidsError> | undefined; + /** @summary List bids */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary List bids */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary List bids */ + , TSignal extends AbortSignal = AbortSignal>( + options: QueryFnOptionsByQueryKey | QueryFnOptionsByParameters, + client?: ( + schema: GetBidsSchema, + options: { + parameters: GetBidsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List bids */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary List bids */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary List bids */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary List bids */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List bids */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List bids */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetBidsData | undefined; + /** @summary List bids */ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBids.useInfiniteQuery({ + * query: { + * dseq: dseq + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBidsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBids.useInfiniteQuery({ + * query: { + * dseq: dseq + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBidsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getBidsTotal = qraft.v1Service.getBids.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getBidsByParametersTotal = qraft.v1Service.getBids.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getBidsResults = qraft.v1Service.getBids.useQueries({ + * queries: [ + * { + * query: { + * dseq: dseq1 + * } + * }, + * { + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getBidsCombinedResults = qraft.v1Service.getBids.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * dseq: dseq1 + * } + * }, + * { + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List bids */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBids.useQuery({ + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBids.useQuery({ + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBids.useSuspenseInfiniteQuery({ + * query: { + * dseq: dseq + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetBidsData, + GetBidsError, + OperationInfiniteData, + GetBidsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetBidsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getBidsData = qraft.v1Service.getBids.useSuspenseQueries({ + * queries: [ + * { + * query: { + * dseq: dseq1 + * } + * }, + * { + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getBidsCombinedData = qraft.v1Service.getBids.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * dseq: dseq1 + * } + * }, + * { + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List bids + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getBids.useSuspenseQuery({ + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetBidsSchema; + types: { + parameters: GetBidsParameters; + data: GetBidsData; + error: GetBidsError; + }; + }; + /** @summary List bids by dseq */ + getBidsDseq: { + /** @summary List bids by dseq */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary List bids by dseq */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBidsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBidsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary List bids by dseq */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBidsDseqError> + ): Promise>; + /** @summary List bids by dseq */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBidsDseqError> + ): Promise; + /** @summary List bids by dseq */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetBidsDseqSchema, + GetBidsDseqData, + GetBidsDseqParameters, + DeepReadonly, + GetBidsDseqError + > + ): Promise>; + /** @summary List bids by dseq */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary List bids by dseq */ + prefetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /** @summary List bids by dseq */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary List bids by dseq */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary List bids by dseq */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetBidsDseqData | undefined]>; + /** @summary List bids by dseq */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetBidsDseqData | undefined; + /** @summary List bids by dseq */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary List bids by dseq */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetBidsDseqError> | undefined; + /** @summary List bids by dseq */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary List bids by dseq */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary List bids by dseq */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetBidsDseqSchema, + options: { + parameters: GetBidsDseqParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary List bids by dseq */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary List bids by dseq */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary List bids by dseq */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary List bids by dseq */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary List bids by dseq */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary List bids by dseq */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetBidsDseqData | undefined; + /** @summary List bids by dseq */ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBidsDseq.useInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBidsDseqParameters, + TQueryFnData = GetBidsDseqData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBidsDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBidsDseq.useInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBidsDseqParameters, + TQueryFnData = GetBidsDseqData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBidsDseqError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getBidsDseqTotal = qraft.v1Service.getBidsDseq.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getBidsDseqByParametersTotal = qraft.v1Service.getBidsDseq.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getBidsDseqResults = qraft.v1Service.getBidsDseq.useQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getBidsDseqCombinedResults = qraft.v1Service.getBidsDseq.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsDseqCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary List bids by dseq */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBidsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBidsDseq.useQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBidsDseq.useSuspenseInfiniteQuery({ + * path: { + * dseq: dseq + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetBidsDseqData, + GetBidsDseqError, + OperationInfiniteData, + GetBidsDseqData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetBidsDseqError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getBidsDseqData = qraft.v1Service.getBidsDseq.useSuspenseQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsDseqResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getBidsDseqCombinedData = qraft.v1Service.getBidsDseq.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getBidsDseqCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary List bids by dseq + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getBidsDseq.useSuspenseQuery({ + * path: { + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetBidsDseqSchema; + types: { + parameters: GetBidsDseqParameters; + data: GetBidsDseqData; + error: GetBidsDseqError; + }; + }; + /** @summary Create certificate */ + postCertificates: { + /** @summary Create certificate */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create certificate + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCertificates.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCertificates.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostCertificatesSchema, + PostCertificatesData, + PostCertificatesParameters, + TVariables, + PostCertificatesError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create certificate + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCertificates.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCertificates.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostCertificatesSchema, + PostCertificatesData, + PostCertificatesParameters, + TVariables, + PostCertificatesError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create certificate + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postCertificatesTotal = qraft.v1Service.postCertificates.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postCertificatesTotal = qraft.v1Service.postCertificates.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCertificatesSchema, + PostCertificatesBody, + PostCertificatesData, + PostCertificatesParameters, + PostCertificatesError | Error, + TContext + > + ): number; + /** @summary Create certificate */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCertificatesSchema, + PostCertificatesBody, + PostCertificatesData, + PostCertificatesParameters, + PostCertificatesError | Error, + TContext + > + ): number; + /** @summary Create certificate */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostCertificatesSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create certificate + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postCertificatesPendingMutationVariables = qraft.v1Service.postCertificates.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postCertificatesMutationData = qraft.v1Service.postCertificates.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostCertificatesData, + PostCertificatesError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCertificatesSchema, + PostCertificatesBody, + PostCertificatesData, + PostCertificatesParameters, + PostCertificatesError | Error, + TContext + >; + select?: ( + mutation: Mutation, TContext> + ) => TResult; + }): Array; + schema: PostCertificatesSchema; + types: { + parameters: PostCertificatesParameters; + data: PostCertificatesData; + error: PostCertificatesError; + body: PostCertificatesBody; + }; + }; + /** @summary Get user balances */ + getBalances: { + /** @summary Get user balances */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get user balances */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get user balances */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetBalancesSchema, + GetBalancesData, + GetBalancesParameters, + DeepReadonly, + GetBalancesError + > | void + ): Promise>; + /** @summary Get user balances */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetBalancesSchema, + GetBalancesData, + GetBalancesParameters, + DeepReadonly, + GetBalancesError + > | void + ): Promise; + /** @summary Get user balances */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetBalancesSchema, + GetBalancesData, + GetBalancesParameters, + DeepReadonly, + GetBalancesError + > | void + ): Promise>; + /** @summary Get user balances */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get user balances */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get user balances */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get user balances */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get user balances */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetBalancesData | undefined]>; + /** @summary Get user balances */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetBalancesData | undefined; + /** @summary Get user balances */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get user balances */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetBalancesError> | undefined; + /** @summary Get user balances */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get user balances */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get user balances */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetBalancesSchema, + options: { + parameters: GetBalancesParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get user balances */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get user balances */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get user balances */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get user balances */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get user balances */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get user balances */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetBalancesData | undefined; + /** @summary Get user balances */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBalances.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBalancesParameters, + TQueryFnData = GetBalancesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBalancesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBalances.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBalancesParameters, + TQueryFnData = GetBalancesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBalancesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getBalancesTotal = qraft.v1Service.getBalances.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getBalancesByParametersTotal = qraft.v1Service.getBalances.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getBalancesResults = qraft.v1Service.getBalances.useQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getBalancesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getBalancesCombinedResults = qraft.v1Service.getBalances.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getBalancesCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get user balances */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBalances.useQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBalances.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * address: initialAddress + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetBalancesData, + GetBalancesError, + OperationInfiniteData, + GetBalancesData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetBalancesError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getBalancesData = qraft.v1Service.getBalances.useSuspenseQueries({ + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getBalancesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getBalancesCombinedData = qraft.v1Service.getBalances.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * address: address1 + * } + * }, + * { + * query: { + * address: address2 + * } + * } + * ] + * }); + * getBalancesCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get user balances + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getBalances.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getBalances.useSuspenseQuery({ + * query: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetBalancesSchema; + types: { + parameters: GetBalancesParameters; + data: GetBalancesData; + error: GetBalancesError; + }; + }; + /** @summary Get a list of providers. */ + getProviders: { + /** @summary Get a list of providers. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of providers. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery({ + * query: { + * scope: scope + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery({ + * query: { + * scope: scope + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of providers. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersSchema, + GetProvidersData, + GetProvidersParameters, + DeepReadonly, + GetProvidersError + > | void + ): Promise>; + /** @summary Get a list of providers. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersSchema, + GetProvidersData, + GetProvidersParameters, + DeepReadonly, + GetProvidersError + > | void + ): Promise; + /** @summary Get a list of providers. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProvidersSchema, + GetProvidersData, + GetProvidersParameters, + DeepReadonly, + GetProvidersError + > | void + ): Promise>; + /** @summary Get a list of providers. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of providers. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of providers. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of providers. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of providers. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProvidersData | undefined]>; + /** @summary Get a list of providers. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetProvidersData | undefined; + /** @summary Get a list of providers. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of providers. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetProvidersError> | undefined; + /** @summary Get a list of providers. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of providers. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of providers. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProvidersSchema, + options: { + parameters: GetProvidersParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of providers. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of providers. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of providers. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of providers. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of providers. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of providers. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProvidersData | undefined; + /** @summary Get a list of providers. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviders.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * scope: initialScope + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersParameters, + TQueryFnData = GetProvidersData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviders.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * scope: initialScope + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersParameters, + TQueryFnData = GetProvidersData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProvidersTotal = qraft.v1Service.getProviders.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProvidersByParametersTotal = qraft.v1Service.getProviders.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * scope: scope + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProvidersResults = qraft.v1Service.getProviders.useQueries({ + * queries: [ + * { + * query: { + * scope: scope1 + * } + * }, + * { + * query: { + * scope: scope2 + * } + * } + * ] + * }); + * getProvidersResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProvidersCombinedResults = qraft.v1Service.getProviders.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * scope: scope1 + * } + * }, + * { + * query: { + * scope: scope2 + * } + * } + * ] + * }); + * getProvidersCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of providers. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery({ + * query: { + * scope: scope + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviders.useQuery({ + * query: { + * scope: scope + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviders.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * scope: initialScope + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProvidersData, + GetProvidersError, + OperationInfiniteData, + GetProvidersData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProvidersError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProvidersData = qraft.v1Service.getProviders.useSuspenseQueries({ + * queries: [ + * { + * query: { + * scope: scope1 + * } + * }, + * { + * query: { + * scope: scope2 + * } + * } + * ] + * }); + * getProvidersResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProvidersCombinedData = qraft.v1Service.getProviders.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * scope: scope1 + * } + * }, + * { + * query: { + * scope: scope2 + * } + * } + * ] + * }); + * getProvidersCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProviders.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProviders.useSuspenseQuery({ + * query: { + * scope: scope + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProvidersSchema; + types: { + parameters: GetProvidersParameters; + data: GetProvidersData; + error: GetProvidersError; + }; + }; + /** @summary Get a provider details. */ + getProvidersAddress: { + /** @summary Get a provider details. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a provider details. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersAddressData, + GetProvidersAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersAddressData, + GetProvidersAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a provider details. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersAddressSchema, + GetProvidersAddressData, + GetProvidersAddressParameters, + DeepReadonly, + GetProvidersAddressError + > + ): Promise>; + /** @summary Get a provider details. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersAddressSchema, + GetProvidersAddressData, + GetProvidersAddressParameters, + DeepReadonly, + GetProvidersAddressError + > + ): Promise; + /** @summary Get a provider details. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProvidersAddressSchema, + GetProvidersAddressData, + GetProvidersAddressParameters, + DeepReadonly, + GetProvidersAddressError + > + ): Promise>; + /** @summary Get a provider details. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a provider details. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a provider details. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProvidersAddressSchema, + GetProvidersAddressData, + GetProvidersAddressParameters, + GetProvidersAddressError + > + ): Promise; + /** @summary Get a provider details. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a provider details. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProvidersAddressData | undefined]>; + /** @summary Get a provider details. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetProvidersAddressData | undefined; + /** @summary Get a provider details. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get a provider details. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetProvidersAddressError> | undefined; + /** @summary Get a provider details. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a provider details. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a provider details. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetProvidersAddressSchema, + options: { + parameters: GetProvidersAddressParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a provider details. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a provider details. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a provider details. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a provider details. */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a provider details. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a provider details. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProvidersAddressData | undefined; + /** @summary Get a provider details. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersAddressParameters, + TQueryFnData = GetProvidersAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersAddressParameters, + TQueryFnData = GetProvidersAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProvidersAddressTotal = qraft.v1Service.getProvidersAddress.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProvidersAddressByParametersTotal = qraft.v1Service.getProvidersAddress.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProvidersAddressResults = qraft.v1Service.getProvidersAddress.useQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getProvidersAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProvidersAddressCombinedResults = qraft.v1Service.getProvidersAddress.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getProvidersAddressCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a provider details. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersAddressData, + GetProvidersAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersAddressData, + GetProvidersAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersAddress.useSuspenseInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProvidersAddressData, + GetProvidersAddressError, + OperationInfiniteData, + GetProvidersAddressData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProvidersAddressError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProvidersAddressData = qraft.v1Service.getProvidersAddress.useSuspenseQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getProvidersAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProvidersAddressCombinedData = qraft.v1Service.getProvidersAddress.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getProvidersAddressCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a provider details. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProvidersAddress.useSuspenseQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProvidersAddressData, + GetProvidersAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProvidersAddressSchema; + types: { + parameters: GetProvidersAddressParameters; + data: GetProvidersAddressData; + error: GetProvidersAddressError; + }; + }; + getProvidersProviderAddressActiveLeasesGraphData: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + >, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQuery({ + * path: { + * providerAddress: providerAddress + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQuery({ + * path: { + * providerAddress: providerAddress + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + DeepReadonly, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + DeepReadonly, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + DeepReadonly, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataParameters + >, + data: + | NoInfer> + | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataParameters + >, + data: GetProvidersProviderAddressActiveLeasesGraphDataData | undefined + ] + >; + /**/ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetProvidersProviderAddressActiveLeasesGraphDataData | undefined; + /**/ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState< + OperationInfiniteData, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + TMeta, + TSignal + > + | QueryFnOptionsByParameters, + client?: ( + schema: GetProvidersProviderAddressActiveLeasesGraphDataSchema, + options: { + parameters: GetProvidersProviderAddressActiveLeasesGraphDataParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + >, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + >, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + | NoInfer> + | undefined, + | NoInfer< + DeepReadonly< + OperationInfiniteData + > + > + | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + >, + updater: Updater< + NoInfer | undefined, + NoInfer | undefined + >, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetProvidersProviderAddressActiveLeasesGraphDataData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useInfiniteQuery({ + * path: { + * providerAddress: providerAddress + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersProviderAddressActiveLeasesGraphDataParameters, + TQueryFnData = GetProvidersProviderAddressActiveLeasesGraphDataData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useInfiniteQuery({ + * path: { + * providerAddress: providerAddress + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersProviderAddressActiveLeasesGraphDataParameters, + TQueryFnData = GetProvidersProviderAddressActiveLeasesGraphDataData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataTotal = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataByParametersTotal = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * providerAddress: providerAddress + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + | QueryFiltersByQueryKey< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataData, + TInfinite, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataResults = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQueries({ + * queries: [ + * { + * path: { + * providerAddress: providerAddress1 + * } + * }, + * { + * path: { + * providerAddress: providerAddress2 + * } + * } + * ] + * }); + * getProvidersProviderAddressActiveLeasesGraphDataResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataCombinedResults = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * providerAddress: providerAddress1 + * } + * }, + * { + * path: { + * providerAddress: providerAddress2 + * } + * } + * ] + * }); + * getProvidersProviderAddressActiveLeasesGraphDataCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array> + ) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQuery({ + * path: { + * providerAddress: providerAddress + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useQuery({ + * path: { + * providerAddress: providerAddress + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useSuspenseInfiniteQuery({ + * path: { + * providerAddress: providerAddress + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery< + TPageParam extends GetProvidersProviderAddressActiveLeasesGraphDataParameters, + TData = GetProvidersProviderAddressActiveLeasesGraphDataData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + OperationInfiniteData, + GetProvidersProviderAddressActiveLeasesGraphDataData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetProvidersProviderAddressActiveLeasesGraphDataError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataData = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useSuspenseQueries({ + * queries: [ + * { + * path: { + * providerAddress: providerAddress1 + * } + * }, + * { + * path: { + * providerAddress: providerAddress2 + * } + * } + * ] + * }); + * getProvidersProviderAddressActiveLeasesGraphDataResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProvidersProviderAddressActiveLeasesGraphDataCombinedData = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * providerAddress: providerAddress1 + * } + * }, + * { + * path: { + * providerAddress: providerAddress2 + * } + * } + * ] + * }); + * getProvidersProviderAddressActiveLeasesGraphDataCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProvidersProviderAddressActiveLeasesGraphDataSchema, + GetProvidersProviderAddressActiveLeasesGraphDataParameters, + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError + > + >, + TCombinedResult = Array< + UseSuspenseQueryResult + > + >(options: { + queries: T; + combine?: ( + results: Array< + WithOptional< + UseSuspenseQueryResult, + "data" + > + > + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProvidersProviderAddressActiveLeasesGraphData.useSuspenseQuery({ + * path: { + * providerAddress: providerAddress + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProvidersProviderAddressActiveLeasesGraphDataData, + GetProvidersProviderAddressActiveLeasesGraphDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProvidersProviderAddressActiveLeasesGraphDataSchema; + types: { + parameters: GetProvidersProviderAddressActiveLeasesGraphDataParameters; + data: GetProvidersProviderAddressActiveLeasesGraphDataData; + error: GetProvidersProviderAddressActiveLeasesGraphDataError; + }; + }; + /** @summary Get a list of auditors. */ + getAuditors: { + /** @summary Get a list of auditors. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of auditors. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAuditors.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAuditors.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of auditors. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAuditorsSchema, + GetAuditorsData, + GetAuditorsParameters, + DeepReadonly, + GetAuditorsError + > | void + ): Promise>; + /** @summary Get a list of auditors. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAuditorsSchema, + GetAuditorsData, + GetAuditorsParameters, + DeepReadonly, + GetAuditorsError + > | void + ): Promise; + /** @summary Get a list of auditors. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAuditorsSchema, + GetAuditorsData, + GetAuditorsParameters, + DeepReadonly, + GetAuditorsError + > | void + ): Promise>; + /** @summary Get a list of auditors. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of auditors. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of auditors. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of auditors. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of auditors. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetAuditorsData | undefined]>; + /** @summary Get a list of auditors. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetAuditorsData | undefined; + /** @summary Get a list of auditors. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of auditors. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetAuditorsError> | undefined; + /** @summary Get a list of auditors. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of auditors. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of auditors. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetAuditorsSchema, + options: { + parameters: GetAuditorsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of auditors. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of auditors. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of auditors. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of auditors. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of auditors. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of auditors. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetAuditorsData | undefined; + /** @summary Get a list of auditors. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAuditors.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAuditorsParameters, + TQueryFnData = GetAuditorsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAuditorsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAuditors.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAuditorsParameters, + TQueryFnData = GetAuditorsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAuditorsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAuditorsTotal = qraft.v1Service.getAuditors.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAuditorsResults = qraft.v1Service.getAuditors.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getAuditorsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAuditorsCombinedResults = qraft.v1Service.getAuditors.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getAuditorsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of auditors. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAuditors.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAuditors.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAuditors.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAuditorsData, + GetAuditorsError, + OperationInfiniteData, + GetAuditorsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetAuditorsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAuditorsData = qraft.v1Service.getAuditors.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getAuditorsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAuditorsCombinedData = qraft.v1Service.getAuditors.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getAuditorsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of auditors. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getAuditors.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetAuditorsSchema; + types: { + parameters: GetAuditorsParameters; + data: GetAuditorsData; + error: GetAuditorsError; + }; + }; + /** @summary Get the provider attributes schema */ + getProviderAttributesSchema: { + /** @summary Get the provider attributes schema */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + >, + options?: CancelOptions + ): Promise; + /** @summary Get the provider attributes schema */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderAttributesSchema.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderAttributesSchema.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get the provider attributes schema */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + DeepReadonly, + GetProviderAttributesSchemaError + > | void + ): Promise>; + /** @summary Get the provider attributes schema */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + DeepReadonly, + GetProviderAttributesSchemaError + > | void + ): Promise; + /** @summary Get the provider attributes schema */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + DeepReadonly, + GetProviderAttributesSchemaError + > | void + ): Promise>; + /** @summary Get the provider attributes schema */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > | void + ): Promise; + /** @summary Get the provider attributes schema */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > | void + ): Promise; + /** @summary Get the provider attributes schema */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > | void + ): Promise; + /** @summary Get the provider attributes schema */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get the provider attributes schema */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetProviderAttributesSchemaData | undefined + ] + >; + /** @summary Get the provider attributes schema */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetProviderAttributesSchemaData | undefined; + /** @summary Get the provider attributes schema */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get the provider attributes schema */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetProviderAttributesSchemaError> | undefined; + /** @summary Get the provider attributes schema */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get the provider attributes schema */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + ): number; + /** @summary Get the provider attributes schema */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProviderAttributesSchemaSchema, + options: { + parameters: GetProviderAttributesSchemaParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get the provider attributes schema */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get the provider attributes schema */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + ): void; + /** @summary Get the provider attributes schema */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + >, + options?: ResetOptions + ): Promise; + /** @summary Get the provider attributes schema */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get the provider attributes schema */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get the provider attributes schema */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderAttributesSchemaData | undefined; + /** @summary Get the provider attributes schema */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderAttributesSchema.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderAttributesSchemaParameters, + TQueryFnData = GetProviderAttributesSchemaData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderAttributesSchema.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderAttributesSchemaParameters, + TQueryFnData = GetProviderAttributesSchemaData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderAttributesSchemaTotal = qraft.v1Service.getProviderAttributesSchema.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + | QueryFiltersByQueryKey< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaData, + TInfinite, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderAttributesSchemaResults = qraft.v1Service.getProviderAttributesSchema.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderAttributesSchemaResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderAttributesSchemaCombinedResults = qraft.v1Service.getProviderAttributesSchema.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderAttributesSchemaCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get the provider attributes schema */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderAttributesSchema.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderAttributesSchema.useQuery() + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderAttributesSchema.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + OperationInfiniteData, + GetProviderAttributesSchemaData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderAttributesSchemaError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderAttributesSchemaData = qraft.v1Service.getProviderAttributesSchema.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderAttributesSchemaResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderAttributesSchemaCombinedData = qraft.v1Service.getProviderAttributesSchema.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderAttributesSchemaCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProviderAttributesSchemaSchema, + GetProviderAttributesSchemaParameters, + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get the provider attributes schema + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProviderAttributesSchema.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetProviderAttributesSchemaData, + GetProviderAttributesSchemaError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderAttributesSchemaSchema; + types: { + parameters: GetProviderAttributesSchemaParameters; + data: GetProviderAttributesSchemaData; + error: GetProviderAttributesSchemaError; + }; + }; + /** @summary Get a list of provider regions */ + getProviderRegions: { + /** @summary Get a list of provider regions */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of provider regions */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderRegions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderRegionsData, + GetProviderRegionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderRegions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderRegionsData, + GetProviderRegionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of provider regions */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderRegionsSchema, + GetProviderRegionsData, + GetProviderRegionsParameters, + DeepReadonly, + GetProviderRegionsError + > | void + ): Promise>; + /** @summary Get a list of provider regions */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderRegionsSchema, + GetProviderRegionsData, + GetProviderRegionsParameters, + DeepReadonly, + GetProviderRegionsError + > | void + ): Promise; + /** @summary Get a list of provider regions */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderRegionsSchema, + GetProviderRegionsData, + GetProviderRegionsParameters, + DeepReadonly, + GetProviderRegionsError + > | void + ): Promise>; + /** @summary Get a list of provider regions */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of provider regions */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of provider regions */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderRegionsSchema, + GetProviderRegionsData, + GetProviderRegionsParameters, + GetProviderRegionsError + > | void + ): Promise; + /** @summary Get a list of provider regions */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of provider regions */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProviderRegionsData | undefined]>; + /** @summary Get a list of provider regions */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetProviderRegionsData | undefined; + /** @summary Get a list of provider regions */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of provider regions */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetProviderRegionsError> | undefined; + /** @summary Get a list of provider regions */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of provider regions */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of provider regions */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProviderRegionsSchema, + options: { + parameters: GetProviderRegionsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of provider regions */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of provider regions */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of provider regions */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of provider regions */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of provider regions */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of provider regions */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderRegionsData | undefined; + /** @summary Get a list of provider regions */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderRegions.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderRegionsParameters, + TQueryFnData = GetProviderRegionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderRegionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderRegions.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderRegionsParameters, + TQueryFnData = GetProviderRegionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderRegionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderRegionsTotal = qraft.v1Service.getProviderRegions.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderRegionsResults = qraft.v1Service.getProviderRegions.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderRegionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderRegionsCombinedResults = qraft.v1Service.getProviderRegions.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderRegionsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of provider regions */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderRegions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderRegionsData, + GetProviderRegionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderRegions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderRegionsData, + GetProviderRegionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderRegions.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderRegionsData, + GetProviderRegionsError, + OperationInfiniteData, + GetProviderRegionsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderRegionsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderRegionsData = qraft.v1Service.getProviderRegions.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderRegionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderRegionsCombinedData = qraft.v1Service.getProviderRegions.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderRegionsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of provider regions + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProviderRegions.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetProviderRegionsData, + GetProviderRegionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderRegionsSchema; + types: { + parameters: GetProviderRegionsParameters; + data: GetProviderRegionsData; + error: GetProviderRegionsError; + }; + }; + /** @summary Get dashboard data for provider console. */ + getProviderDashboardOwner: { + /** @summary Get dashboard data for provider console. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + >, + options?: CancelOptions + ): Promise; + /** @summary Get dashboard data for provider console. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderDashboardOwner.useQuery({ + * path: { + * owner: owner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderDashboardOwner.useQuery({ + * path: { + * owner: owner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get dashboard data for provider console. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + DeepReadonly, + GetProviderDashboardOwnerError + > + ): Promise>; + /** @summary Get dashboard data for provider console. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + DeepReadonly, + GetProviderDashboardOwnerError + > + ): Promise; + /** @summary Get dashboard data for provider console. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + DeepReadonly, + GetProviderDashboardOwnerError + > + ): Promise>; + /** @summary Get dashboard data for provider console. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): Promise; + /** @summary Get dashboard data for provider console. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): Promise; + /** @summary Get dashboard data for provider console. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): Promise; + /** @summary Get dashboard data for provider console. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get dashboard data for provider console. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetProviderDashboardOwnerData | undefined + ] + >; + /** @summary Get dashboard data for provider console. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetProviderDashboardOwnerData | undefined; + /** @summary Get dashboard data for provider console. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get dashboard data for provider console. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetProviderDashboardOwnerError> | undefined; + /** @summary Get dashboard data for provider console. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get dashboard data for provider console. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): number; + /** @summary Get dashboard data for provider console. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetProviderDashboardOwnerSchema, + options: { + parameters: GetProviderDashboardOwnerParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get dashboard data for provider console. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get dashboard data for provider console. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): void; + /** @summary Get dashboard data for provider console. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + >, + options?: ResetOptions + ): Promise; + /** @summary Get dashboard data for provider console. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get dashboard data for provider console. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get dashboard data for provider console. */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderDashboardOwnerData | undefined; + /** @summary Get dashboard data for provider console. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderDashboardOwner.useInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderDashboardOwnerParameters, + TQueryFnData = GetProviderDashboardOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderDashboardOwner.useInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderDashboardOwnerParameters, + TQueryFnData = GetProviderDashboardOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderDashboardOwnerTotal = qraft.v1Service.getProviderDashboardOwner.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProviderDashboardOwnerByParametersTotal = qraft.v1Service.getProviderDashboardOwner.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * owner: owner + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + | QueryFiltersByQueryKey< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerData, + TInfinite, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderDashboardOwnerResults = qraft.v1Service.getProviderDashboardOwner.useQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * } + * }, + * { + * path: { + * owner: owner2 + * } + * } + * ] + * }); + * getProviderDashboardOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderDashboardOwnerCombinedResults = qraft.v1Service.getProviderDashboardOwner.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * } + * }, + * { + * path: { + * owner: owner2 + * } + * } + * ] + * }); + * getProviderDashboardOwnerCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get dashboard data for provider console. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderDashboardOwner.useQuery({ + * path: { + * owner: owner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderDashboardOwner.useQuery({ + * path: { + * owner: owner + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderDashboardOwner.useSuspenseInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + OperationInfiniteData, + GetProviderDashboardOwnerData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderDashboardOwnerError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderDashboardOwnerData = qraft.v1Service.getProviderDashboardOwner.useSuspenseQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * } + * }, + * { + * path: { + * owner: owner2 + * } + * } + * ] + * }); + * getProviderDashboardOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderDashboardOwnerCombinedData = qraft.v1Service.getProviderDashboardOwner.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * } + * }, + * { + * path: { + * owner: owner2 + * } + * } + * ] + * }); + * getProviderDashboardOwnerCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProviderDashboardOwnerSchema, + GetProviderDashboardOwnerParameters, + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get dashboard data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProviderDashboardOwner.useSuspenseQuery({ + * path: { + * owner: owner + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProviderDashboardOwnerData, + GetProviderDashboardOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderDashboardOwnerSchema; + types: { + parameters: GetProviderDashboardOwnerParameters; + data: GetProviderDashboardOwnerData; + error: GetProviderDashboardOwnerError; + }; + }; + /** @summary Get earnings data for provider console. */ + getProviderEarningsOwner: { + /** @summary Get earnings data for provider console. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + >, + options?: CancelOptions + ): Promise; + /** @summary Get earnings data for provider console. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderEarningsOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderEarningsOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get earnings data for provider console. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + DeepReadonly, + GetProviderEarningsOwnerError + > + ): Promise>; + /** @summary Get earnings data for provider console. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + DeepReadonly, + GetProviderEarningsOwnerError + > + ): Promise; + /** @summary Get earnings data for provider console. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + DeepReadonly, + GetProviderEarningsOwnerError + > + ): Promise>; + /** @summary Get earnings data for provider console. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): Promise; + /** @summary Get earnings data for provider console. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): Promise; + /** @summary Get earnings data for provider console. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): Promise; + /** @summary Get earnings data for provider console. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get earnings data for provider console. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetProviderEarningsOwnerData | undefined + ] + >; + /** @summary Get earnings data for provider console. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetProviderEarningsOwnerData | undefined; + /** @summary Get earnings data for provider console. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get earnings data for provider console. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetProviderEarningsOwnerError> | undefined; + /** @summary Get earnings data for provider console. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get earnings data for provider console. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): number; + /** @summary Get earnings data for provider console. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetProviderEarningsOwnerSchema, + options: { + parameters: GetProviderEarningsOwnerParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get earnings data for provider console. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get earnings data for provider console. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): void; + /** @summary Get earnings data for provider console. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + >, + options?: ResetOptions + ): Promise; + /** @summary Get earnings data for provider console. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get earnings data for provider console. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get earnings data for provider console. */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderEarningsOwnerData | undefined; + /** @summary Get earnings data for provider console. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderEarningsOwner.useInfiniteQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }, { + * initialPageParam: { + * query: { + * from: initialFrom, + * to: initialTo + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderEarningsOwnerParameters, + TQueryFnData = GetProviderEarningsOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderEarningsOwner.useInfiniteQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }, { + * initialPageParam: { + * query: { + * from: initialFrom, + * to: initialTo + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderEarningsOwnerParameters, + TQueryFnData = GetProviderEarningsOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderEarningsOwnerTotal = qraft.v1Service.getProviderEarningsOwner.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProviderEarningsOwnerByParametersTotal = qraft.v1Service.getProviderEarningsOwner.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + | QueryFiltersByQueryKey< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerData, + TInfinite, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderEarningsOwnerResults = qraft.v1Service.getProviderEarningsOwner.useQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * from: from1, + * to: to1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * from: from2, + * to: to2 + * } + * } + * ] + * }); + * getProviderEarningsOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderEarningsOwnerCombinedResults = qraft.v1Service.getProviderEarningsOwner.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * from: from1, + * to: to1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * from: from2, + * to: to2 + * } + * } + * ] + * }); + * getProviderEarningsOwnerCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get earnings data for provider console. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderEarningsOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderEarningsOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderEarningsOwner.useSuspenseInfiniteQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }, { + * initialPageParam: { + * query: { + * from: initialFrom, + * to: initialTo + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + OperationInfiniteData, + GetProviderEarningsOwnerData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderEarningsOwnerError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderEarningsOwnerData = qraft.v1Service.getProviderEarningsOwner.useSuspenseQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * from: from1, + * to: to1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * from: from2, + * to: to2 + * } + * } + * ] + * }); + * getProviderEarningsOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderEarningsOwnerCombinedData = qraft.v1Service.getProviderEarningsOwner.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * from: from1, + * to: to1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * from: from2, + * to: to2 + * } + * } + * ] + * }); + * getProviderEarningsOwnerCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProviderEarningsOwnerSchema, + GetProviderEarningsOwnerParameters, + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get earnings data for provider console. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProviderEarningsOwner.useSuspenseQuery({ + * path: { + * owner: owner + * }, + * query: { + * from: from, + * to: to + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProviderEarningsOwnerData, + GetProviderEarningsOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderEarningsOwnerSchema; + types: { + parameters: GetProviderEarningsOwnerParameters; + data: GetProviderEarningsOwnerData; + error: GetProviderEarningsOwnerError; + }; + }; + /** @summary Get providers grouped by version. */ + getProviderVersions: { + /** @summary Get providers grouped by version. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get providers grouped by version. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderVersions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderVersionsData, + GetProviderVersionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderVersions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderVersionsData, + GetProviderVersionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get providers grouped by version. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + DeepReadonly, + GetProviderVersionsError + > | void + ): Promise>; + /** @summary Get providers grouped by version. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + DeepReadonly, + GetProviderVersionsError + > | void + ): Promise; + /** @summary Get providers grouped by version. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + DeepReadonly, + GetProviderVersionsError + > | void + ): Promise>; + /** @summary Get providers grouped by version. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + GetProviderVersionsError + > | void + ): Promise; + /** @summary Get providers grouped by version. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + GetProviderVersionsError + > | void + ): Promise; + /** @summary Get providers grouped by version. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderVersionsSchema, + GetProviderVersionsData, + GetProviderVersionsParameters, + GetProviderVersionsError + > | void + ): Promise; + /** @summary Get providers grouped by version. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get providers grouped by version. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProviderVersionsData | undefined]>; + /** @summary Get providers grouped by version. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetProviderVersionsData | undefined; + /** @summary Get providers grouped by version. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get providers grouped by version. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetProviderVersionsError> | undefined; + /** @summary Get providers grouped by version. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get providers grouped by version. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get providers grouped by version. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProviderVersionsSchema, + options: { + parameters: GetProviderVersionsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get providers grouped by version. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get providers grouped by version. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get providers grouped by version. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get providers grouped by version. */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get providers grouped by version. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get providers grouped by version. */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderVersionsData | undefined; + /** @summary Get providers grouped by version. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderVersions.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderVersionsParameters, + TQueryFnData = GetProviderVersionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderVersionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderVersions.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderVersionsParameters, + TQueryFnData = GetProviderVersionsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderVersionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderVersionsTotal = qraft.v1Service.getProviderVersions.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderVersionsResults = qraft.v1Service.getProviderVersions.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderVersionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderVersionsCombinedResults = qraft.v1Service.getProviderVersions.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderVersionsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get providers grouped by version. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderVersions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetProviderVersionsData, + GetProviderVersionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderVersions.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetProviderVersionsData, + GetProviderVersionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderVersions.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderVersionsData, + GetProviderVersionsError, + OperationInfiniteData, + GetProviderVersionsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderVersionsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderVersionsData = qraft.v1Service.getProviderVersions.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderVersionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderVersionsCombinedData = qraft.v1Service.getProviderVersions.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProviderVersionsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get providers grouped by version. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProviderVersions.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetProviderVersionsData, + GetProviderVersionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderVersionsSchema; + types: { + parameters: GetProviderVersionsParameters; + data: GetProviderVersionsData; + error: GetProviderVersionsError; + }; + }; + getProviderGraphDataDataName: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + >, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + DeepReadonly, + GetProviderGraphDataDataNameError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + DeepReadonly, + GetProviderGraphDataDataNameError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + DeepReadonly, + GetProviderGraphDataDataNameError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetProviderGraphDataDataNameData | undefined + ] + >; + /**/ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetProviderGraphDataDataNameData | undefined; + /**/ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState, GetProviderGraphDataDataNameError> + | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetProviderGraphDataDataNameSchema, + options: { + parameters: GetProviderGraphDataDataNameParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + >, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + >, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProviderGraphDataDataNameData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderGraphDataDataName.useInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderGraphDataDataNameParameters, + TQueryFnData = GetProviderGraphDataDataNameData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderGraphDataDataName.useInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProviderGraphDataDataNameParameters, + TQueryFnData = GetProviderGraphDataDataNameData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProviderGraphDataDataNameTotal = qraft.v1Service.getProviderGraphDataDataName.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProviderGraphDataDataNameByParametersTotal = qraft.v1Service.getProviderGraphDataDataName.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * dataName: dataName + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + | QueryFiltersByQueryKey< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameData, + TInfinite, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProviderGraphDataDataNameResults = qraft.v1Service.getProviderGraphDataDataName.useQueries({ + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getProviderGraphDataDataNameResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProviderGraphDataDataNameCombinedResults = qraft.v1Service.getProviderGraphDataDataName.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getProviderGraphDataDataNameCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProviderGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProviderGraphDataDataName.useSuspenseInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + OperationInfiniteData, + GetProviderGraphDataDataNameData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProviderGraphDataDataNameError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProviderGraphDataDataNameData = qraft.v1Service.getProviderGraphDataDataName.useSuspenseQueries({ + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getProviderGraphDataDataNameResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProviderGraphDataDataNameCombinedData = qraft.v1Service.getProviderGraphDataDataName.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getProviderGraphDataDataNameCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProviderGraphDataDataNameSchema, + GetProviderGraphDataDataNameParameters, + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProviderGraphDataDataName.useSuspenseQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProviderGraphDataDataNameData, + GetProviderGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProviderGraphDataDataNameSchema; + types: { + parameters: GetProviderGraphDataDataNameParameters; + data: GetProviderGraphDataDataNameData; + error: GetProviderGraphDataDataNameError; + }; + }; + /** @summary Get a list of deployments for a provider. */ + getProvidersProviderDeploymentsSkipLimit: { + /** @summary Get a list of deployments for a provider. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + >, + options?: CancelOptions + ): Promise; + /** @summary Get a list of deployments for a provider. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQuery({ + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQuery({ + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of deployments for a provider. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + DeepReadonly, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise>; + /** @summary Get a list of deployments for a provider. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + DeepReadonly, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments for a provider. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + DeepReadonly, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise>; + /** @summary Get a list of deployments for a provider. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments for a provider. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments for a provider. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): Promise; + /** @summary Get a list of deployments for a provider. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a list of deployments for a provider. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetProvidersProviderDeploymentsSkipLimitData | undefined + ] + >; + /** @summary Get a list of deployments for a provider. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetProvidersProviderDeploymentsSkipLimitData | undefined; + /** @summary Get a list of deployments for a provider. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get a list of deployments for a provider. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState< + OperationInfiniteData, + GetProvidersProviderDeploymentsSkipLimitError + > + | undefined; + /** @summary Get a list of deployments for a provider. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of deployments for a provider. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): number; + /** @summary Get a list of deployments for a provider. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetProvidersProviderDeploymentsSkipLimitSchema, + options: { + parameters: GetProvidersProviderDeploymentsSkipLimitParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of deployments for a provider. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of deployments for a provider. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): void; + /** @summary Get a list of deployments for a provider. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + >, + options?: ResetOptions + ): Promise; + /** @summary Get a list of deployments for a provider. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + | NoInfer>> + | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of deployments for a provider. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of deployments for a provider. */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetProvidersProviderDeploymentsSkipLimitData | undefined; + /** @summary Get a list of deployments for a provider. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useInfiniteQuery({ + * path: { + * provider: provider, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersProviderDeploymentsSkipLimitParameters, + TQueryFnData = GetProvidersProviderDeploymentsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useInfiniteQuery({ + * path: { + * provider: provider, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProvidersProviderDeploymentsSkipLimitParameters, + TQueryFnData = GetProvidersProviderDeploymentsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProvidersProviderDeploymentsSkipLimitTotal = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProvidersProviderDeploymentsSkipLimitByParametersTotal = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + | QueryFiltersByQueryKey< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitData, + TInfinite, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProvidersProviderDeploymentsSkipLimitResults = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQueries({ + * queries: [ + * { + * path: { + * provider: provider1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * provider: provider2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getProvidersProviderDeploymentsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProvidersProviderDeploymentsSkipLimitCombinedResults = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * provider: provider1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * provider: provider2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getProvidersProviderDeploymentsSkipLimitCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array> + ) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of deployments for a provider. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQuery({ + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useQuery({ + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useSuspenseInfiniteQuery({ + * path: { + * provider: provider, + * limit: limit + * } + * }, { + * initialPageParam: { + * query: { + * status: initialStatus + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + OperationInfiniteData, + GetProvidersProviderDeploymentsSkipLimitData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetProvidersProviderDeploymentsSkipLimitError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProvidersProviderDeploymentsSkipLimitData = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useSuspenseQueries({ + * queries: [ + * { + * path: { + * provider: provider1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * provider: provider2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getProvidersProviderDeploymentsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProvidersProviderDeploymentsSkipLimitCombinedData = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * provider: provider1, + * limit: limit1 + * }, + * query: { + * status: status1 + * } + * }, + * { + * path: { + * provider: provider2, + * limit: limit2 + * }, + * query: { + * status: status2 + * } + * } + * ] + * }); + * getProvidersProviderDeploymentsSkipLimitCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetProvidersProviderDeploymentsSkipLimitSchema, + GetProvidersProviderDeploymentsSkipLimitParameters, + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array< + WithOptional, "data"> + > + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of deployments for a provider. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProvidersProviderDeploymentsSkipLimit.useSuspenseQuery({ + * path: { + * provider: provider, + * limit: limit + * }, + * query: { + * status: status + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetProvidersProviderDeploymentsSkipLimitData, + GetProvidersProviderDeploymentsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProvidersProviderDeploymentsSkipLimitSchema; + types: { + parameters: GetProvidersProviderDeploymentsSkipLimitParameters; + data: GetProvidersProviderDeploymentsSkipLimitData; + error: GetProvidersProviderDeploymentsSkipLimitError; + }; + }; + /** @summary Create new JWT token for managed wallet */ + postCreateJwtToken: { + /** @summary Create new JWT token for managed wallet */ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new JWT token for managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCreateJwtToken.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCreateJwtToken.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PostCreateJwtTokenSchema, + PostCreateJwtTokenData, + PostCreateJwtTokenParameters, + TVariables, + PostCreateJwtTokenError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Create new JWT token for managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCreateJwtToken.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postCreateJwtToken.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PostCreateJwtTokenSchema, + PostCreateJwtTokenData, + PostCreateJwtTokenParameters, + TVariables, + PostCreateJwtTokenError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Create new JWT token for managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postCreateJwtTokenTotal = qraft.v1Service.postCreateJwtToken.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postCreateJwtTokenTotal = qraft.v1Service.postCreateJwtToken.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCreateJwtTokenSchema, + PostCreateJwtTokenBody, + PostCreateJwtTokenData, + PostCreateJwtTokenParameters, + PostCreateJwtTokenError | Error, + TContext + > + ): number; + /** @summary Create new JWT token for managed wallet */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCreateJwtTokenSchema, + PostCreateJwtTokenBody, + PostCreateJwtTokenData, + PostCreateJwtTokenParameters, + PostCreateJwtTokenError | Error, + TContext + > + ): number; + /** @summary Create new JWT token for managed wallet */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostCreateJwtTokenSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Create new JWT token for managed wallet + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postCreateJwtTokenPendingMutationVariables = qraft.v1Service.postCreateJwtToken.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postCreateJwtTokenMutationData = qraft.v1Service.postCreateJwtToken.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PostCreateJwtTokenData, + PostCreateJwtTokenError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey< + PostCreateJwtTokenSchema, + PostCreateJwtTokenBody, + PostCreateJwtTokenData, + PostCreateJwtTokenParameters, + PostCreateJwtTokenError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PostCreateJwtTokenData, + PostCreateJwtTokenError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PostCreateJwtTokenSchema; + types: { + parameters: PostCreateJwtTokenParameters; + data: PostCreateJwtTokenData; + error: PostCreateJwtTokenError; + body: PostCreateJwtTokenBody; + }; + }; + getGraphDataDataName: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + DeepReadonly, + GetGraphDataDataNameError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + DeepReadonly, + GetGraphDataDataNameError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + DeepReadonly, + GetGraphDataDataNameError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + GetGraphDataDataNameError + > + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + GetGraphDataDataNameError + > + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + GetGraphDataDataNameParameters, + GetGraphDataDataNameError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetGraphDataDataNameData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetGraphDataDataNameData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetGraphDataDataNameError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetGraphDataDataNameSchema, + GetGraphDataDataNameData, + TInfinite, + GetGraphDataDataNameParameters, + GetGraphDataDataNameError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetGraphDataDataNameSchema, + options: { + parameters: GetGraphDataDataNameParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetGraphDataDataNameData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGraphDataDataName.useInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGraphDataDataNameParameters, + TQueryFnData = GetGraphDataDataNameData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGraphDataDataNameError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGraphDataDataName.useInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGraphDataDataNameParameters, + TQueryFnData = GetGraphDataDataNameData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGraphDataDataNameError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getGraphDataDataNameTotal = qraft.v1Service.getGraphDataDataName.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getGraphDataDataNameByParametersTotal = qraft.v1Service.getGraphDataDataName.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * dataName: dataName + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getGraphDataDataNameResults = qraft.v1Service.getGraphDataDataName.useQueries({ + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getGraphDataDataNameResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getGraphDataDataNameCombinedResults = qraft.v1Service.getGraphDataDataName.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getGraphDataDataNameCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGraphDataDataName.useQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGraphDataDataName.useSuspenseInfiniteQuery({ + * path: { + * dataName: dataName + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + OperationInfiniteData, + GetGraphDataDataNameData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetGraphDataDataNameError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getGraphDataDataNameData = qraft.v1Service.getGraphDataDataName.useSuspenseQueries({ + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getGraphDataDataNameResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getGraphDataDataNameCombinedData = qraft.v1Service.getGraphDataDataName.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dataName: dataName1 + * } + * }, + * { + * path: { + * dataName: dataName2 + * } + * } + * ] + * }); + * getGraphDataDataNameCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getGraphDataDataName.useSuspenseQuery({ + * path: { + * dataName: dataName + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetGraphDataDataNameData, + GetGraphDataDataNameError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetGraphDataDataNameSchema; + types: { + parameters: GetGraphDataDataNameParameters; + data: GetGraphDataDataNameData; + error: GetGraphDataDataNameError; + }; + }; + getDashboardData: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDashboardData.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetDashboardDataData, + GetDashboardDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDashboardData.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetDashboardDataData, + GetDashboardDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDashboardDataSchema, + GetDashboardDataData, + GetDashboardDataParameters, + DeepReadonly, + GetDashboardDataError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDashboardDataSchema, + GetDashboardDataData, + GetDashboardDataParameters, + DeepReadonly, + GetDashboardDataError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDashboardDataSchema, + GetDashboardDataData, + GetDashboardDataParameters, + DeepReadonly, + GetDashboardDataError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetDashboardDataData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetDashboardDataData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetDashboardDataError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetDashboardDataSchema, + options: { + parameters: GetDashboardDataParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDashboardDataData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDashboardData.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDashboardDataParameters, + TQueryFnData = GetDashboardDataData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDashboardDataError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDashboardData.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDashboardDataParameters, + TQueryFnData = GetDashboardDataData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDashboardDataError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDashboardDataTotal = qraft.v1Service.getDashboardData.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDashboardDataResults = qraft.v1Service.getDashboardData.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getDashboardDataResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDashboardDataCombinedResults = qraft.v1Service.getDashboardData.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getDashboardDataCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDashboardData.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetDashboardDataData, + GetDashboardDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDashboardData.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetDashboardDataData, + GetDashboardDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDashboardData.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDashboardDataData, + GetDashboardDataError, + OperationInfiniteData, + GetDashboardDataData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDashboardDataError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDashboardDataData = qraft.v1Service.getDashboardData.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getDashboardDataResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDashboardDataCombinedData = qraft.v1Service.getDashboardData.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getDashboardDataCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getDashboardData.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetDashboardDataData, + GetDashboardDataError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDashboardDataSchema; + types: { + parameters: GetDashboardDataParameters; + data: GetDashboardDataData; + error: GetDashboardDataError; + }; + }; + getNetworkCapacity: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNetworkCapacity.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNetworkCapacity.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNetworkCapacitySchema, + GetNetworkCapacityData, + GetNetworkCapacityParameters, + DeepReadonly, + GetNetworkCapacityError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNetworkCapacitySchema, + GetNetworkCapacityData, + GetNetworkCapacityParameters, + DeepReadonly, + GetNetworkCapacityError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetNetworkCapacitySchema, + GetNetworkCapacityData, + GetNetworkCapacityParameters, + DeepReadonly, + GetNetworkCapacityError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetNetworkCapacitySchema, + GetNetworkCapacityData, + GetNetworkCapacityParameters, + GetNetworkCapacityError + > | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetNetworkCapacityData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetNetworkCapacityData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetNetworkCapacityError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetNetworkCapacitySchema, + options: { + parameters: GetNetworkCapacityParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetNetworkCapacityData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNetworkCapacity.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNetworkCapacityParameters, + TQueryFnData = GetNetworkCapacityData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNetworkCapacityError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNetworkCapacity.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNetworkCapacityParameters, + TQueryFnData = GetNetworkCapacityData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNetworkCapacityError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getNetworkCapacityTotal = qraft.v1Service.getNetworkCapacity.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getNetworkCapacityResults = qraft.v1Service.getNetworkCapacity.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getNetworkCapacityResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getNetworkCapacityCombinedResults = qraft.v1Service.getNetworkCapacity.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getNetworkCapacityCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNetworkCapacity.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNetworkCapacity.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNetworkCapacity.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + OperationInfiniteData, + GetNetworkCapacityData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetNetworkCapacityError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getNetworkCapacityData = qraft.v1Service.getNetworkCapacity.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getNetworkCapacityResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getNetworkCapacityCombinedData = qraft.v1Service.getNetworkCapacity.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getNetworkCapacityCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getNetworkCapacity.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetNetworkCapacityData, + GetNetworkCapacityError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetNetworkCapacitySchema; + types: { + parameters: GetNetworkCapacityParameters; + data: GetNetworkCapacityData; + error: GetNetworkCapacityError; + }; + }; + /** @summary Get a list of recent blocks. */ + getBlocks: { + /** @summary Get a list of recent blocks. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of recent blocks. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** @summary Get a list of recent blocks. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBlocksError> | void + ): Promise>; + /** @summary Get a list of recent blocks. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetBlocksError> | void + ): Promise; + /** @summary Get a list of recent blocks. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetBlocksSchema, + GetBlocksData, + GetBlocksParameters, + DeepReadonly, + GetBlocksError + > | void + ): Promise>; + /** @summary Get a list of recent blocks. */ + fetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Get a list of recent blocks. */ + prefetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Get a list of recent blocks. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of recent blocks. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of recent blocks. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetBlocksData | undefined]>; + /** @summary Get a list of recent blocks. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetBlocksData | undefined; + /** @summary Get a list of recent blocks. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of recent blocks. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetBlocksError> | undefined; + /** @summary Get a list of recent blocks. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of recent blocks. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of recent blocks. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetBlocksSchema, + options: { + parameters: GetBlocksParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of recent blocks. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of recent blocks. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of recent blocks. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of recent blocks. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of recent blocks. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of recent blocks. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetBlocksData | undefined; + /** @summary Get a list of recent blocks. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocks.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBlocksError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocks.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBlocksError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getBlocksTotal = qraft.v1Service.getBlocks.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getBlocksByParametersTotal = qraft.v1Service.getBlocks.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * limit: limit + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getBlocksResults = qraft.v1Service.getBlocks.useQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getBlocksResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getBlocksCombinedResults = qraft.v1Service.getBlocks.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getBlocksCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of recent blocks. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocks.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocks.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetBlocksData, + GetBlocksError, + OperationInfiniteData, + GetBlocksData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetBlocksError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getBlocksData = qraft.v1Service.getBlocks.useSuspenseQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getBlocksResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getBlocksCombinedData = qraft.v1Service.getBlocks.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getBlocksCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of recent blocks. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getBlocks.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getBlocks.useSuspenseQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetBlocksSchema; + types: { + parameters: GetBlocksParameters; + data: GetBlocksData; + error: GetBlocksError; + }; + }; + /** @summary Get a block by height. */ + getBlocksHeight: { + /** @summary Get a block by height. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a block by height. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery({ + * path: { + * height: height + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetBlocksHeightData, + GetBlocksHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery({ + * path: { + * height: height + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a block by height. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetBlocksHeightSchema, + GetBlocksHeightData, + GetBlocksHeightParameters, + DeepReadonly, + GetBlocksHeightError + > | void + ): Promise>; + /** @summary Get a block by height. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetBlocksHeightSchema, + GetBlocksHeightData, + GetBlocksHeightParameters, + DeepReadonly, + GetBlocksHeightError + > | void + ): Promise; + /** @summary Get a block by height. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetBlocksHeightSchema, + GetBlocksHeightData, + GetBlocksHeightParameters, + DeepReadonly, + GetBlocksHeightError + > | void + ): Promise>; + /** @summary Get a block by height. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a block by height. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a block by height. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a block by height. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a block by height. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetBlocksHeightData | undefined]>; + /** @summary Get a block by height. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetBlocksHeightData | undefined; + /** @summary Get a block by height. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a block by height. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetBlocksHeightError> | undefined; + /** @summary Get a block by height. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a block by height. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a block by height. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetBlocksHeightSchema, + options: { + parameters: GetBlocksHeightParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a block by height. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a block by height. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a block by height. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a block by height. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a block by height. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a block by height. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetBlocksHeightData | undefined; + /** @summary Get a block by height. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocksHeight.useInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBlocksHeightParameters, + TQueryFnData = GetBlocksHeightData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBlocksHeightError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocksHeight.useInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetBlocksHeightParameters, + TQueryFnData = GetBlocksHeightData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetBlocksHeightError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getBlocksHeightTotal = qraft.v1Service.getBlocksHeight.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getBlocksHeightByParametersTotal = qraft.v1Service.getBlocksHeight.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * height: height + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getBlocksHeightResults = qraft.v1Service.getBlocksHeight.useQueries({ + * queries: [ + * { + * path: { + * height: height1 + * } + * }, + * { + * path: { + * height: height2 + * } + * } + * ] + * }); + * getBlocksHeightResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getBlocksHeightCombinedResults = qraft.v1Service.getBlocksHeight.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * height: height1 + * } + * }, + * { + * path: { + * height: height2 + * } + * } + * ] + * }); + * getBlocksHeightCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a block by height. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery({ + * path: { + * height: height + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetBlocksHeightData, + GetBlocksHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getBlocksHeight.useQuery({ + * path: { + * height: height + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getBlocksHeight.useSuspenseInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetBlocksHeightData, + GetBlocksHeightError, + OperationInfiniteData, + GetBlocksHeightData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetBlocksHeightError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getBlocksHeightData = qraft.v1Service.getBlocksHeight.useSuspenseQueries({ + * queries: [ + * { + * path: { + * height: height1 + * } + * }, + * { + * path: { + * height: height2 + * } + * } + * ] + * }); + * getBlocksHeightResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getBlocksHeightCombinedData = qraft.v1Service.getBlocksHeight.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * height: height1 + * } + * }, + * { + * path: { + * height: height2 + * } + * } + * ] + * }); + * getBlocksHeightCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a block by height. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getBlocksHeight.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getBlocksHeight.useSuspenseQuery({ + * path: { + * height: height + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetBlocksHeightSchema; + types: { + parameters: GetBlocksHeightParameters; + data: GetBlocksHeightData; + error: GetBlocksHeightError; + }; + }; + /** @summary Get the estimated date of a future block. */ + getPredictedBlockDateHeight: { + /** @summary Get the estimated date of a future block. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + >, + options?: CancelOptions + ): Promise; + /** @summary Get the estimated date of a future block. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery({ + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery({ + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get the estimated date of a future block. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + DeepReadonly, + GetPredictedBlockDateHeightError + > | void + ): Promise>; + /** @summary Get the estimated date of a future block. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + DeepReadonly, + GetPredictedBlockDateHeightError + > | void + ): Promise; + /** @summary Get the estimated date of a future block. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + DeepReadonly, + GetPredictedBlockDateHeightError + > | void + ): Promise>; + /** @summary Get the estimated date of a future block. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > | void + ): Promise; + /** @summary Get the estimated date of a future block. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > | void + ): Promise; + /** @summary Get the estimated date of a future block. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > | void + ): Promise; + /** @summary Get the estimated date of a future block. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get the estimated date of a future block. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetPredictedBlockDateHeightData | undefined + ] + >; + /** @summary Get the estimated date of a future block. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetPredictedBlockDateHeightData | undefined; + /** @summary Get the estimated date of a future block. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get the estimated date of a future block. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetPredictedBlockDateHeightError> | undefined; + /** @summary Get the estimated date of a future block. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get the estimated date of a future block. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + ): number; + /** @summary Get the estimated date of a future block. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetPredictedBlockDateHeightSchema, + options: { + parameters: GetPredictedBlockDateHeightParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get the estimated date of a future block. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get the estimated date of a future block. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + ): void; + /** @summary Get the estimated date of a future block. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + >, + options?: ResetOptions + ): Promise; + /** @summary Get the estimated date of a future block. */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get the estimated date of a future block. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get the estimated date of a future block. */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetPredictedBlockDateHeightData | undefined; + /** @summary Get the estimated date of a future block. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedBlockDateHeight.useInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetPredictedBlockDateHeightParameters, + TQueryFnData = GetPredictedBlockDateHeightData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedBlockDateHeight.useInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetPredictedBlockDateHeightParameters, + TQueryFnData = GetPredictedBlockDateHeightData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getPredictedBlockDateHeightTotal = qraft.v1Service.getPredictedBlockDateHeight.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getPredictedBlockDateHeightByParametersTotal = qraft.v1Service.getPredictedBlockDateHeight.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + | QueryFiltersByQueryKey< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightData, + TInfinite, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getPredictedBlockDateHeightResults = qraft.v1Service.getPredictedBlockDateHeight.useQueries({ + * queries: [ + * { + * path: { + * height: height1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * height: height2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedBlockDateHeightResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getPredictedBlockDateHeightCombinedResults = qraft.v1Service.getPredictedBlockDateHeight.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * height: height1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * height: height2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedBlockDateHeightCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get the estimated date of a future block. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery({ + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedBlockDateHeight.useQuery({ + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedBlockDateHeight.useSuspenseInfiniteQuery({ + * path: { + * height: height + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + OperationInfiniteData, + GetPredictedBlockDateHeightData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetPredictedBlockDateHeightError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getPredictedBlockDateHeightData = qraft.v1Service.getPredictedBlockDateHeight.useSuspenseQueries({ + * queries: [ + * { + * path: { + * height: height1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * height: height2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedBlockDateHeightResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getPredictedBlockDateHeightCombinedData = qraft.v1Service.getPredictedBlockDateHeight.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * height: height1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * height: height2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedBlockDateHeightCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetPredictedBlockDateHeightSchema, + GetPredictedBlockDateHeightParameters, + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get the estimated date of a future block. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getPredictedBlockDateHeight.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getPredictedBlockDateHeight.useSuspenseQuery({ + * path: { + * height: height + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetPredictedBlockDateHeightData, + GetPredictedBlockDateHeightError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetPredictedBlockDateHeightSchema; + types: { + parameters: GetPredictedBlockDateHeightParameters; + data: GetPredictedBlockDateHeightData; + error: GetPredictedBlockDateHeightError; + }; + }; + /** @summary Get the estimated height of a future date and time. */ + getPredictedDateHeightTimestamp: { + /** @summary Get the estimated height of a future date and time. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + >, + options?: CancelOptions + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery({ + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery({ + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get the estimated height of a future date and time. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + DeepReadonly, + GetPredictedDateHeightTimestampError + > | void + ): Promise>; + /** @summary Get the estimated height of a future date and time. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + DeepReadonly, + GetPredictedDateHeightTimestampError + > | void + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + DeepReadonly, + GetPredictedDateHeightTimestampError + > | void + ): Promise>; + /** @summary Get the estimated height of a future date and time. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > | void + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > | void + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > | void + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get the estimated height of a future date and time. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetPredictedDateHeightTimestampData | undefined + ] + >; + /** @summary Get the estimated height of a future date and time. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetPredictedDateHeightTimestampData | undefined; + /** @summary Get the estimated height of a future date and time. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get the estimated height of a future date and time. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): + | QueryState, GetPredictedDateHeightTimestampError> + | undefined; + /** @summary Get the estimated height of a future date and time. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + ): number; + /** @summary Get the estimated height of a future date and time. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetPredictedDateHeightTimestampSchema, + options: { + parameters: GetPredictedDateHeightTimestampParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get the estimated height of a future date and time. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + ): void; + /** @summary Get the estimated height of a future date and time. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + >, + options?: ResetOptions + ): Promise; + /** @summary Get the estimated height of a future date and time. */ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get the estimated height of a future date and time. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get the estimated height of a future date and time. */ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetPredictedDateHeightTimestampData | undefined; + /** @summary Get the estimated height of a future date and time. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedDateHeightTimestamp.useInfiniteQuery({ + * path: { + * timestamp: timestamp + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetPredictedDateHeightTimestampParameters, + TQueryFnData = GetPredictedDateHeightTimestampData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedDateHeightTimestamp.useInfiniteQuery({ + * path: { + * timestamp: timestamp + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetPredictedDateHeightTimestampParameters, + TQueryFnData = GetPredictedDateHeightTimestampData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getPredictedDateHeightTimestampTotal = qraft.v1Service.getPredictedDateHeightTimestamp.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getPredictedDateHeightTimestampByParametersTotal = qraft.v1Service.getPredictedDateHeightTimestamp.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + | QueryFiltersByQueryKey< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampData, + TInfinite, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getPredictedDateHeightTimestampResults = qraft.v1Service.getPredictedDateHeightTimestamp.useQueries({ + * queries: [ + * { + * path: { + * timestamp: timestamp1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * timestamp: timestamp2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedDateHeightTimestampResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getPredictedDateHeightTimestampCombinedResults = qraft.v1Service.getPredictedDateHeightTimestamp.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * timestamp: timestamp1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * timestamp: timestamp2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedDateHeightTimestampCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get the estimated height of a future date and time. */ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery({ + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getPredictedDateHeightTimestamp.useQuery({ + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getPredictedDateHeightTimestamp.useSuspenseInfiniteQuery({ + * path: { + * timestamp: timestamp + * } + * }, { + * initialPageParam: { + * query: { + * blockWindow: initialBlockWindow + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + OperationInfiniteData, + GetPredictedDateHeightTimestampData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetPredictedDateHeightTimestampError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getPredictedDateHeightTimestampData = qraft.v1Service.getPredictedDateHeightTimestamp.useSuspenseQueries({ + * queries: [ + * { + * path: { + * timestamp: timestamp1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * timestamp: timestamp2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedDateHeightTimestampResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getPredictedDateHeightTimestampCombinedData = qraft.v1Service.getPredictedDateHeightTimestamp.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * timestamp: timestamp1 + * }, + * query: { + * blockWindow: blockWindow1 + * } + * }, + * { + * path: { + * timestamp: timestamp2 + * }, + * query: { + * blockWindow: blockWindow2 + * } + * } + * ] + * }); + * getPredictedDateHeightTimestampCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetPredictedDateHeightTimestampSchema, + GetPredictedDateHeightTimestampParameters, + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array, "data">> + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get the estimated height of a future date and time. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getPredictedDateHeightTimestamp.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getPredictedDateHeightTimestamp.useSuspenseQuery({ + * path: { + * timestamp: timestamp + * }, + * query: { + * blockWindow: blockWindow + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetPredictedDateHeightTimestampData, + GetPredictedDateHeightTimestampError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetPredictedDateHeightTimestampSchema; + types: { + parameters: GetPredictedDateHeightTimestampParameters; + data: GetPredictedDateHeightTimestampData; + error: GetPredictedDateHeightTimestampError; + }; + }; + /** @summary Get a list of transactions. */ + getTransactions: { + /** @summary Get a list of transactions. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of transactions. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetTransactionsData, + GetTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of transactions. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTransactionsSchema, + GetTransactionsData, + GetTransactionsParameters, + DeepReadonly, + GetTransactionsError + > | void + ): Promise>; + /** @summary Get a list of transactions. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTransactionsSchema, + GetTransactionsData, + GetTransactionsParameters, + DeepReadonly, + GetTransactionsError + > | void + ): Promise; + /** @summary Get a list of transactions. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetTransactionsSchema, + GetTransactionsData, + GetTransactionsParameters, + DeepReadonly, + GetTransactionsError + > | void + ): Promise>; + /** @summary Get a list of transactions. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of transactions. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of transactions. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of transactions. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of transactions. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetTransactionsData | undefined]>; + /** @summary Get a list of transactions. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetTransactionsData | undefined; + /** @summary Get a list of transactions. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of transactions. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetTransactionsError> | undefined; + /** @summary Get a list of transactions. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of transactions. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of transactions. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetTransactionsSchema, + options: { + parameters: GetTransactionsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of transactions. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of transactions. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of transactions. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of transactions. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of transactions. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of transactions. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetTransactionsData | undefined; + /** @summary Get a list of transactions. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactions.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTransactionsParameters, + TQueryFnData = GetTransactionsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTransactionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactions.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTransactionsParameters, + TQueryFnData = GetTransactionsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTransactionsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getTransactionsTotal = qraft.v1Service.getTransactions.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getTransactionsByParametersTotal = qraft.v1Service.getTransactions.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * limit: limit + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getTransactionsResults = qraft.v1Service.getTransactions.useQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getTransactionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getTransactionsCombinedResults = qraft.v1Service.getTransactions.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getTransactionsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of transactions. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetTransactionsData, + GetTransactionsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactions.useQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactions.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetTransactionsData, + GetTransactionsError, + OperationInfiniteData, + GetTransactionsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetTransactionsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getTransactionsData = qraft.v1Service.getTransactions.useSuspenseQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getTransactionsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getTransactionsCombinedData = qraft.v1Service.getTransactions.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * } + * }, + * { + * query: { + * limit: limit2 + * } + * } + * ] + * }); + * getTransactionsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of transactions. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getTransactions.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getTransactions.useSuspenseQuery({ + * query: { + * limit: limit + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetTransactionsSchema; + types: { + parameters: GetTransactionsParameters; + data: GetTransactionsData; + error: GetTransactionsError; + }; + }; + /** @summary Get a transaction by hash. */ + getTransactionsHash: { + /** @summary Get a transaction by hash. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a transaction by hash. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactionsHash.useQuery({ + * path: { + * hash: hash + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetTransactionsHashData, + GetTransactionsHashError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactionsHash.useQuery({ + * path: { + * hash: hash + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetTransactionsHashData, + GetTransactionsHashError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a transaction by hash. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTransactionsHashSchema, + GetTransactionsHashData, + GetTransactionsHashParameters, + DeepReadonly, + GetTransactionsHashError + > + ): Promise>; + /** @summary Get a transaction by hash. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTransactionsHashSchema, + GetTransactionsHashData, + GetTransactionsHashParameters, + DeepReadonly, + GetTransactionsHashError + > + ): Promise; + /** @summary Get a transaction by hash. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetTransactionsHashSchema, + GetTransactionsHashData, + GetTransactionsHashParameters, + DeepReadonly, + GetTransactionsHashError + > + ): Promise>; + /** @summary Get a transaction by hash. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a transaction by hash. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a transaction by hash. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetTransactionsHashSchema, + GetTransactionsHashData, + GetTransactionsHashParameters, + GetTransactionsHashError + > + ): Promise; + /** @summary Get a transaction by hash. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a transaction by hash. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetTransactionsHashData | undefined]>; + /** @summary Get a transaction by hash. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetTransactionsHashData | undefined; + /** @summary Get a transaction by hash. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get a transaction by hash. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetTransactionsHashError> | undefined; + /** @summary Get a transaction by hash. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a transaction by hash. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a transaction by hash. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetTransactionsHashSchema, + options: { + parameters: GetTransactionsHashParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a transaction by hash. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a transaction by hash. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a transaction by hash. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a transaction by hash. */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a transaction by hash. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a transaction by hash. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetTransactionsHashData | undefined; + /** @summary Get a transaction by hash. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactionsHash.useInfiniteQuery({ + * path: { + * hash: hash + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTransactionsHashParameters, + TQueryFnData = GetTransactionsHashData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTransactionsHashError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactionsHash.useInfiniteQuery({ + * path: { + * hash: hash + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTransactionsHashParameters, + TQueryFnData = GetTransactionsHashData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTransactionsHashError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getTransactionsHashTotal = qraft.v1Service.getTransactionsHash.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getTransactionsHashByParametersTotal = qraft.v1Service.getTransactionsHash.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * hash: hash + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getTransactionsHashResults = qraft.v1Service.getTransactionsHash.useQueries({ + * queries: [ + * { + * path: { + * hash: hash1 + * } + * }, + * { + * path: { + * hash: hash2 + * } + * } + * ] + * }); + * getTransactionsHashResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getTransactionsHashCombinedResults = qraft.v1Service.getTransactionsHash.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * hash: hash1 + * } + * }, + * { + * path: { + * hash: hash2 + * } + * } + * ] + * }); + * getTransactionsHashCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a transaction by hash. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactionsHash.useQuery({ + * path: { + * hash: hash + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetTransactionsHashData, + GetTransactionsHashError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTransactionsHash.useQuery({ + * path: { + * hash: hash + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetTransactionsHashData, + GetTransactionsHashError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTransactionsHash.useSuspenseInfiniteQuery({ + * path: { + * hash: hash + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetTransactionsHashData, + GetTransactionsHashError, + OperationInfiniteData, + GetTransactionsHashData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetTransactionsHashError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getTransactionsHashData = qraft.v1Service.getTransactionsHash.useSuspenseQueries({ + * queries: [ + * { + * path: { + * hash: hash1 + * } + * }, + * { + * path: { + * hash: hash2 + * } + * } + * ] + * }); + * getTransactionsHashResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getTransactionsHashCombinedData = qraft.v1Service.getTransactionsHash.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * hash: hash1 + * } + * }, + * { + * path: { + * hash: hash2 + * } + * } + * ] + * }); + * getTransactionsHashCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a transaction by hash. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getTransactionsHash.useSuspenseQuery({ + * path: { + * hash: hash + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetTransactionsHashData, + GetTransactionsHashError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetTransactionsHashSchema; + types: { + parameters: GetTransactionsHashParameters; + data: GetTransactionsHashData; + error: GetTransactionsHashError; + }; + }; + getMarketDataCoin: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery({ + * path: { + * coin: coin + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery({ + * path: { + * coin: coin + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetMarketDataCoinSchema, + GetMarketDataCoinData, + GetMarketDataCoinParameters, + DeepReadonly, + GetMarketDataCoinError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetMarketDataCoinSchema, + GetMarketDataCoinData, + GetMarketDataCoinParameters, + DeepReadonly, + GetMarketDataCoinError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetMarketDataCoinSchema, + GetMarketDataCoinData, + GetMarketDataCoinParameters, + DeepReadonly, + GetMarketDataCoinError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetMarketDataCoinSchema, + GetMarketDataCoinData, + GetMarketDataCoinParameters, + GetMarketDataCoinError + > | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetMarketDataCoinData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetMarketDataCoinData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetMarketDataCoinError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetMarketDataCoinSchema, + options: { + parameters: GetMarketDataCoinParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetMarketDataCoinData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getMarketDataCoin.useInfiniteQuery({ + * path: { + * coin: coin + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetMarketDataCoinParameters, + TQueryFnData = GetMarketDataCoinData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetMarketDataCoinError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getMarketDataCoin.useInfiniteQuery({ + * path: { + * coin: coin + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetMarketDataCoinParameters, + TQueryFnData = GetMarketDataCoinData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetMarketDataCoinError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getMarketDataCoinTotal = qraft.v1Service.getMarketDataCoin.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getMarketDataCoinByParametersTotal = qraft.v1Service.getMarketDataCoin.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * coin: coin + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getMarketDataCoinResults = qraft.v1Service.getMarketDataCoin.useQueries({ + * queries: [ + * { + * path: { + * coin: coin1 + * } + * }, + * { + * path: { + * coin: coin2 + * } + * } + * ] + * }); + * getMarketDataCoinResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getMarketDataCoinCombinedResults = qraft.v1Service.getMarketDataCoin.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * coin: coin1 + * } + * }, + * { + * path: { + * coin: coin2 + * } + * } + * ] + * }); + * getMarketDataCoinCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery({ + * path: { + * coin: coin + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getMarketDataCoin.useQuery({ + * path: { + * coin: coin + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getMarketDataCoin.useSuspenseInfiniteQuery({ + * path: { + * coin: coin + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + OperationInfiniteData, + GetMarketDataCoinData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetMarketDataCoinError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getMarketDataCoinData = qraft.v1Service.getMarketDataCoin.useSuspenseQueries({ + * queries: [ + * { + * path: { + * coin: coin1 + * } + * }, + * { + * path: { + * coin: coin2 + * } + * } + * ] + * }); + * getMarketDataCoinResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getMarketDataCoinCombinedData = qraft.v1Service.getMarketDataCoin.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * coin: coin1 + * } + * }, + * { + * path: { + * coin: coin2 + * } + * } + * ] + * }); + * getMarketDataCoinCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getMarketDataCoin.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getMarketDataCoin.useSuspenseQuery({ + * path: { + * coin: coin + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetMarketDataCoinData, + GetMarketDataCoinError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetMarketDataCoinSchema; + types: { + parameters: GetMarketDataCoinParameters; + data: GetMarketDataCoinData; + error: GetMarketDataCoinError; + }; + }; + getValidators: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidators.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidators.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetValidatorsSchema, + GetValidatorsData, + GetValidatorsParameters, + DeepReadonly, + GetValidatorsError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetValidatorsSchema, + GetValidatorsData, + GetValidatorsParameters, + DeepReadonly, + GetValidatorsError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetValidatorsSchema, + GetValidatorsData, + GetValidatorsParameters, + DeepReadonly, + GetValidatorsError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetValidatorsData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetValidatorsData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetValidatorsError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetValidatorsSchema, + options: { + parameters: GetValidatorsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetValidatorsData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidators.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetValidatorsParameters, + TQueryFnData = GetValidatorsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetValidatorsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidators.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetValidatorsParameters, + TQueryFnData = GetValidatorsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetValidatorsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getValidatorsTotal = qraft.v1Service.getValidators.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getValidatorsResults = qraft.v1Service.getValidators.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getValidatorsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getValidatorsCombinedResults = qraft.v1Service.getValidators.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getValidatorsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidators.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidators.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidators.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetValidatorsData, + GetValidatorsError, + OperationInfiniteData, + GetValidatorsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetValidatorsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getValidatorsData = qraft.v1Service.getValidators.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getValidatorsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getValidatorsCombinedData = qraft.v1Service.getValidators.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getValidatorsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getValidators.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetValidatorsSchema; + types: { + parameters: GetValidatorsParameters; + data: GetValidatorsData; + error: GetValidatorsError; + }; + }; + getValidatorsAddress: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidatorsAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidatorsAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + DeepReadonly, + GetValidatorsAddressError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + DeepReadonly, + GetValidatorsAddressError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + DeepReadonly, + GetValidatorsAddressError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + GetValidatorsAddressError + > + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + GetValidatorsAddressError + > + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + GetValidatorsAddressParameters, + GetValidatorsAddressError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetValidatorsAddressData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetValidatorsAddressData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetValidatorsAddressError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetValidatorsAddressSchema, + GetValidatorsAddressData, + TInfinite, + GetValidatorsAddressParameters, + GetValidatorsAddressError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetValidatorsAddressSchema, + options: { + parameters: GetValidatorsAddressParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetValidatorsAddressData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidatorsAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetValidatorsAddressParameters, + TQueryFnData = GetValidatorsAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetValidatorsAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidatorsAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetValidatorsAddressParameters, + TQueryFnData = GetValidatorsAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetValidatorsAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getValidatorsAddressTotal = qraft.v1Service.getValidatorsAddress.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getValidatorsAddressByParametersTotal = qraft.v1Service.getValidatorsAddress.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getValidatorsAddressResults = qraft.v1Service.getValidatorsAddress.useQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getValidatorsAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getValidatorsAddressCombinedResults = qraft.v1Service.getValidatorsAddress.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getValidatorsAddressCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidatorsAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getValidatorsAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getValidatorsAddress.useSuspenseInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + OperationInfiniteData, + GetValidatorsAddressData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetValidatorsAddressError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getValidatorsAddressData = qraft.v1Service.getValidatorsAddress.useSuspenseQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getValidatorsAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getValidatorsAddressCombinedData = qraft.v1Service.getValidatorsAddress.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getValidatorsAddressCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getValidatorsAddress.useSuspenseQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetValidatorsAddressData, + GetValidatorsAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetValidatorsAddressSchema; + types: { + parameters: GetValidatorsAddressParameters; + data: GetValidatorsAddressData; + error: GetValidatorsAddressError; + }; + }; + /** @summary Estimate the price of a deployment on akash and other cloud providers. */ + postPricing: { + /** @summary Estimate the price of a deployment on akash and other cloud providers. */ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Estimate the price of a deployment on akash and other cloud providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postPricing.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postPricing.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @summary Estimate the price of a deployment on akash and other cloud providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postPricing.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.postPricing.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @summary Estimate the price of a deployment on akash and other cloud providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const postPricingTotal = qraft.v1Service.postPricing.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const postPricingTotal = qraft.v1Service.postPricing.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Estimate the price of a deployment on akash and other cloud providers. */ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /** @summary Estimate the price of a deployment on akash and other cloud providers. */ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PostPricingSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @summary Estimate the price of a deployment on akash and other cloud providers. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const postPricingPendingMutationVariables = qraft.v1Service.postPricing.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const postPricingMutationData = qraft.v1Service.postPricing.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: PostPricingSchema; + types: { + parameters: PostPricingParameters; + data: PostPricingData; + error: PostPricingError; + body: PostPricingBody; + }; + }; + /** @summary Get a list of gpu models and their availability. */ + getGpu: { + /** @summary Get a list of gpu models and their availability. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of gpu models and their availability. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery({ + * query: { + * provider: provider + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery({ + * query: { + * provider: provider + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** @summary Get a list of gpu models and their availability. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetGpuError> | void + ): Promise>; + /** @summary Get a list of gpu models and their availability. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetGpuError> | void + ): Promise; + /** @summary Get a list of gpu models and their availability. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions, GetGpuError> | void + ): Promise>; + /** @summary Get a list of gpu models and their availability. */ + fetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Get a list of gpu models and their availability. */ + prefetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /** @summary Get a list of gpu models and their availability. */ + ensureQueryData(options: ServiceOperationEnsureQueryDataOptions | void): Promise; + /** @summary Get a list of gpu models and their availability. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models and their availability. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetGpuData | undefined]>; + /** @summary Get a list of gpu models and their availability. */ + getQueryData(parameters: ServiceOperationQueryKey | (DeepReadonly | void)): GetGpuData | undefined; + /** @summary Get a list of gpu models and their availability. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of gpu models and their availability. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetGpuError> | undefined; + /** @summary Get a list of gpu models and their availability. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of gpu models and their availability. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of gpu models and their availability. */ + , TSignal extends AbortSignal = AbortSignal>( + options: QueryFnOptionsByQueryKey | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetGpuSchema, + options: { + parameters: GetGpuParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of gpu models and their availability. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of gpu models and their availability. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of gpu models and their availability. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of gpu models and their availability. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models and their availability. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of gpu models and their availability. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetGpuData | undefined; + /** @summary Get a list of gpu models and their availability. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpu.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * provider: initialProvider + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpu.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * provider: initialProvider + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getGpuTotal = qraft.v1Service.getGpu.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getGpuByParametersTotal = qraft.v1Service.getGpu.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * provider: provider + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getGpuResults = qraft.v1Service.getGpu.useQueries({ + * queries: [ + * { + * query: { + * provider: provider1 + * } + * }, + * { + * query: { + * provider: provider2 + * } + * } + * ] + * }); + * getGpuResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getGpuCombinedResults = qraft.v1Service.getGpu.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * provider: provider1 + * } + * }, + * { + * query: { + * provider: provider2 + * } + * } + * ] + * }); + * getGpuCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of gpu models and their availability. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery({ + * query: { + * provider: provider + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpu.useQuery({ + * query: { + * provider: provider + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpu.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * provider: initialProvider + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetGpuData, + GetGpuError, + OperationInfiniteData, + GetGpuData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetGpuError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getGpuData = qraft.v1Service.getGpu.useSuspenseQueries({ + * queries: [ + * { + * query: { + * provider: provider1 + * } + * }, + * { + * query: { + * provider: provider2 + * } + * } + * ] + * }); + * getGpuResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getGpuCombinedData = qraft.v1Service.getGpu.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * provider: provider1 + * } + * }, + * { + * query: { + * provider: provider2 + * } + * } + * ] + * }); + * getGpuCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models and their availability. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getGpu.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getGpu.useSuspenseQuery({ + * query: { + * provider: provider + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetGpuSchema; + types: { + parameters: GetGpuParameters; + data: GetGpuData; + error: GetGpuError; + }; + }; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getGpuModels: { + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuModels.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuModels.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuModelsSchema, + GetGpuModelsData, + GetGpuModelsParameters, + DeepReadonly, + GetGpuModelsError + > | void + ): Promise>; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuModelsSchema, + GetGpuModelsData, + GetGpuModelsParameters, + DeepReadonly, + GetGpuModelsError + > | void + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetGpuModelsSchema, + GetGpuModelsData, + GetGpuModelsParameters, + DeepReadonly, + GetGpuModelsError + > | void + ): Promise>; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetGpuModelsData | undefined]>; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetGpuModelsData | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetGpuModelsError> | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetGpuModelsSchema, + options: { + parameters: GetGpuModelsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetGpuModelsData | undefined; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuModels.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuModelsParameters, + TQueryFnData = GetGpuModelsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuModelsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuModels.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuModelsParameters, + TQueryFnData = GetGpuModelsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuModelsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getGpuModelsTotal = qraft.v1Service.getGpuModels.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getGpuModelsResults = qraft.v1Service.getGpuModels.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuModelsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getGpuModelsCombinedResults = qraft.v1Service.getGpuModels.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuModelsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuModels.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuModels.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuModels.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetGpuModelsData, + GetGpuModelsError, + OperationInfiniteData, + GetGpuModelsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetGpuModelsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getGpuModelsData = qraft.v1Service.getGpuModels.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuModelsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getGpuModelsCombinedData = qraft.v1Service.getGpuModels.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuModelsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getGpuModels.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetGpuModelsSchema; + types: { + parameters: GetGpuModelsParameters; + data: GetGpuModelsData; + error: GetGpuModelsError; + }; + }; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getGpuBreakdown: { + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery({ + * query: { + * vendor: vendor + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetGpuBreakdownData, + GetGpuBreakdownError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery({ + * query: { + * vendor: vendor + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuBreakdownSchema, + GetGpuBreakdownData, + GetGpuBreakdownParameters, + DeepReadonly, + GetGpuBreakdownError + > | void + ): Promise>; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuBreakdownSchema, + GetGpuBreakdownData, + GetGpuBreakdownParameters, + DeepReadonly, + GetGpuBreakdownError + > | void + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetGpuBreakdownSchema, + GetGpuBreakdownData, + GetGpuBreakdownParameters, + DeepReadonly, + GetGpuBreakdownError + > | void + ): Promise>; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetGpuBreakdownData | undefined]>; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetGpuBreakdownData | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetGpuBreakdownError> | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetGpuBreakdownSchema, + options: { + parameters: GetGpuBreakdownParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetGpuBreakdownData | undefined; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuBreakdown.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * vendor: initialVendor + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuBreakdownParameters, + TQueryFnData = GetGpuBreakdownData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuBreakdownError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuBreakdown.useInfiniteQuery({}, { + * initialPageParam: { + * query: { + * vendor: initialVendor + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuBreakdownParameters, + TQueryFnData = GetGpuBreakdownData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuBreakdownError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getGpuBreakdownTotal = qraft.v1Service.getGpuBreakdown.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getGpuBreakdownByParametersTotal = qraft.v1Service.getGpuBreakdown.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * vendor: vendor + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getGpuBreakdownResults = qraft.v1Service.getGpuBreakdown.useQueries({ + * queries: [ + * { + * query: { + * vendor: vendor1 + * } + * }, + * { + * query: { + * vendor: vendor2 + * } + * } + * ] + * }); + * getGpuBreakdownResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getGpuBreakdownCombinedResults = qraft.v1Service.getGpuBreakdown.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * vendor: vendor1 + * } + * }, + * { + * query: { + * vendor: vendor2 + * } + * } + * ] + * }); + * getGpuBreakdownCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery({ + * query: { + * vendor: vendor + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetGpuBreakdownData, + GetGpuBreakdownError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuBreakdown.useQuery({ + * query: { + * vendor: vendor + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuBreakdown.useSuspenseInfiniteQuery({}, { + * initialPageParam: { + * query: { + * vendor: initialVendor + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetGpuBreakdownData, + GetGpuBreakdownError, + OperationInfiniteData, + GetGpuBreakdownData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetGpuBreakdownError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getGpuBreakdownData = qraft.v1Service.getGpuBreakdown.useSuspenseQueries({ + * queries: [ + * { + * query: { + * vendor: vendor1 + * } + * }, + * { + * query: { + * vendor: vendor2 + * } + * } + * ] + * }); + * getGpuBreakdownResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getGpuBreakdownCombinedData = qraft.v1Service.getGpuBreakdown.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * vendor: vendor1 + * } + * }, + * { + * query: { + * vendor: vendor2 + * } + * } + * ] + * }); + * getGpuBreakdownCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getGpuBreakdown.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getGpuBreakdown.useSuspenseQuery({ + * query: { + * vendor: vendor + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetGpuBreakdownSchema; + types: { + parameters: GetGpuBreakdownParameters; + data: GetGpuBreakdownData; + error: GetGpuBreakdownError; + }; + }; + /** @summary Get a list of gpu models with their availability and pricing. */ + getGpuPrices: { + /** @summary Get a list of gpu models with their availability and pricing. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuPrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuPrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of gpu models with their availability and pricing. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuPricesSchema, + GetGpuPricesData, + GetGpuPricesParameters, + DeepReadonly, + GetGpuPricesError + > | void + ): Promise>; + /** @summary Get a list of gpu models with their availability and pricing. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetGpuPricesSchema, + GetGpuPricesData, + GetGpuPricesParameters, + DeepReadonly, + GetGpuPricesError + > | void + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetGpuPricesSchema, + GetGpuPricesData, + GetGpuPricesParameters, + DeepReadonly, + GetGpuPricesError + > | void + ): Promise>; + /** @summary Get a list of gpu models with their availability and pricing. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetGpuPricesData | undefined]>; + /** @summary Get a list of gpu models with their availability and pricing. */ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetGpuPricesData | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetGpuPricesError> | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of gpu models with their availability and pricing. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetGpuPricesSchema, + options: { + parameters: GetGpuPricesParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of gpu models with their availability and pricing. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of gpu models with their availability and pricing. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of gpu models with their availability and pricing. */ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of gpu models with their availability and pricing. */ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetGpuPricesData | undefined; + /** @summary Get a list of gpu models with their availability and pricing. */ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuPrices.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuPricesParameters, + TQueryFnData = GetGpuPricesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuPricesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuPrices.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetGpuPricesParameters, + TQueryFnData = GetGpuPricesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetGpuPricesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getGpuPricesTotal = qraft.v1Service.getGpuPrices.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getGpuPricesResults = qraft.v1Service.getGpuPrices.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuPricesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getGpuPricesCombinedResults = qraft.v1Service.getGpuPrices.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuPricesCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of gpu models with their availability and pricing. */ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuPrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getGpuPrices.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getGpuPrices.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetGpuPricesData, + GetGpuPricesError, + OperationInfiniteData, + GetGpuPricesData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetGpuPricesError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getGpuPricesData = qraft.v1Service.getGpuPrices.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuPricesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getGpuPricesCombinedData = qraft.v1Service.getGpuPrices.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getGpuPricesCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of gpu models with their availability and pricing. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getGpuPrices.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetGpuPricesSchema; + types: { + parameters: GetGpuPricesParameters; + data: GetGpuPricesData; + error: GetGpuPricesError; + }; + }; + getProposals: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposals.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposals.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProposalsSchema, + GetProposalsData, + GetProposalsParameters, + DeepReadonly, + GetProposalsError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProposalsSchema, + GetProposalsData, + GetProposalsParameters, + DeepReadonly, + GetProposalsError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProposalsSchema, + GetProposalsData, + GetProposalsParameters, + DeepReadonly, + GetProposalsError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProposalsData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetProposalsData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetProposalsError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProposalsSchema, + options: { + parameters: GetProposalsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProposalsData | undefined; + /**/ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposals.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProposalsParameters, + TQueryFnData = GetProposalsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProposalsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposals.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProposalsParameters, + TQueryFnData = GetProposalsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProposalsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProposalsTotal = qraft.v1Service.getProposals.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProposalsResults = qraft.v1Service.getProposals.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProposalsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProposalsCombinedResults = qraft.v1Service.getProposals.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProposalsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposals.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposals.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposals.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProposalsData, + GetProposalsError, + OperationInfiniteData, + GetProposalsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProposalsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProposalsData = qraft.v1Service.getProposals.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getProposalsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProposalsCombinedData = qraft.v1Service.getProposals.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getProposalsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProposals.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProposalsSchema; + types: { + parameters: GetProposalsParameters; + data: GetProposalsData; + error: GetProposalsError; + }; + }; + getProposalsId: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProposalsIdSchema, + GetProposalsIdData, + GetProposalsIdParameters, + DeepReadonly, + GetProposalsIdError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetProposalsIdSchema, + GetProposalsIdData, + GetProposalsIdParameters, + DeepReadonly, + GetProposalsIdError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetProposalsIdSchema, + GetProposalsIdData, + GetProposalsIdParameters, + DeepReadonly, + GetProposalsIdError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetProposalsIdData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetProposalsIdData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetProposalsIdError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetProposalsIdSchema, + options: { + parameters: GetProposalsIdParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetProposalsIdData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposalsId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProposalsIdParameters, + TQueryFnData = GetProposalsIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProposalsIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposalsId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetProposalsIdParameters, + TQueryFnData = GetProposalsIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetProposalsIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getProposalsIdTotal = qraft.v1Service.getProposalsId.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getProposalsIdByParametersTotal = qraft.v1Service.getProposalsId.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getProposalsIdResults = qraft.v1Service.getProposalsId.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getProposalsIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getProposalsIdCombinedResults = qraft.v1Service.getProposalsId.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getProposalsIdCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getProposalsId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getProposalsId.useSuspenseInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetProposalsIdData, + GetProposalsIdError, + OperationInfiniteData, + GetProposalsIdData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetProposalsIdError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getProposalsIdData = qraft.v1Service.getProposalsId.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getProposalsIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getProposalsIdCombinedData = qraft.v1Service.getProposalsId.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getProposalsIdCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getProposalsId.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getProposalsId.useSuspenseQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetProposalsIdSchema; + types: { + parameters: GetProposalsIdParameters; + data: GetProposalsIdData; + error: GetProposalsIdError; + }; + }; + getTemplates: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplates.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplates.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesSchema, + GetTemplatesData, + GetTemplatesParameters, + DeepReadonly, + GetTemplatesError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesSchema, + GetTemplatesData, + GetTemplatesParameters, + DeepReadonly, + GetTemplatesError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetTemplatesSchema, + GetTemplatesData, + GetTemplatesParameters, + DeepReadonly, + GetTemplatesError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetTemplatesData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetTemplatesData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetTemplatesError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetTemplatesSchema, + options: { + parameters: GetTemplatesParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetTemplatesData | undefined; + /**/ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplates.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesParameters, + TQueryFnData = GetTemplatesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplates.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesParameters, + TQueryFnData = GetTemplatesData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getTemplatesTotal = qraft.v1Service.getTemplates.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getTemplatesResults = qraft.v1Service.getTemplates.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getTemplatesCombinedResults = qraft.v1Service.getTemplates.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplates.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplates.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplates.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetTemplatesData, + GetTemplatesError, + OperationInfiniteData, + GetTemplatesData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetTemplatesError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getTemplatesData = qraft.v1Service.getTemplates.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getTemplatesCombinedData = qraft.v1Service.getTemplates.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getTemplates.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetTemplatesSchema; + types: { + parameters: GetTemplatesParameters; + data: GetTemplatesData; + error: GetTemplatesError; + }; + }; + getTemplatesList: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesList.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetTemplatesListData, + GetTemplatesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesList.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetTemplatesListData, + GetTemplatesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesListSchema, + GetTemplatesListData, + GetTemplatesListParameters, + DeepReadonly, + GetTemplatesListError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesListSchema, + GetTemplatesListData, + GetTemplatesListParameters, + DeepReadonly, + GetTemplatesListError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetTemplatesListSchema, + GetTemplatesListData, + GetTemplatesListParameters, + DeepReadonly, + GetTemplatesListError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetTemplatesListData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetTemplatesListData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetTemplatesListError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetTemplatesListSchema, + options: { + parameters: GetTemplatesListParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetTemplatesListData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesList.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesListParameters, + TQueryFnData = GetTemplatesListData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesList.useInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesListParameters, + TQueryFnData = GetTemplatesListData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesListError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getTemplatesListTotal = qraft.v1Service.getTemplatesList.useIsFetching() + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getTemplatesListResults = qraft.v1Service.getTemplatesList.useQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getTemplatesListCombinedResults = qraft.v1Service.getTemplatesList.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesListCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesList.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetTemplatesListData, + GetTemplatesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesList.useQuery() + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetTemplatesListData, + GetTemplatesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesList.useSuspenseInfiniteQuery({}, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetTemplatesListData, + GetTemplatesListError, + OperationInfiniteData, + GetTemplatesListData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetTemplatesListError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getTemplatesListData = qraft.v1Service.getTemplatesList.useSuspenseQueries({ + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesListResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getTemplatesListCombinedData = qraft.v1Service.getTemplatesList.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * {}, + * {} + * ] + * }); + * getTemplatesListCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getTemplatesList.useSuspenseQuery() + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetTemplatesListData, + GetTemplatesListError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetTemplatesListSchema; + types: { + parameters: GetTemplatesListParameters; + data: GetTemplatesListData; + error: GetTemplatesListError; + }; + }; + getTemplatesId: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesIdSchema, + GetTemplatesIdData, + GetTemplatesIdParameters, + DeepReadonly, + GetTemplatesIdError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetTemplatesIdSchema, + GetTemplatesIdData, + GetTemplatesIdParameters, + DeepReadonly, + GetTemplatesIdError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetTemplatesIdSchema, + GetTemplatesIdData, + GetTemplatesIdParameters, + DeepReadonly, + GetTemplatesIdError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetTemplatesIdData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetTemplatesIdData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetTemplatesIdError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetTemplatesIdSchema, + options: { + parameters: GetTemplatesIdParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetTemplatesIdData | undefined; + /**/ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesIdParameters, + TQueryFnData = GetTemplatesIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesId.useInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetTemplatesIdParameters, + TQueryFnData = GetTemplatesIdData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetTemplatesIdError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getTemplatesIdTotal = qraft.v1Service.getTemplatesId.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getTemplatesIdByParametersTotal = qraft.v1Service.getTemplatesId.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getTemplatesIdResults = qraft.v1Service.getTemplatesId.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getTemplatesIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getTemplatesIdCombinedResults = qraft.v1Service.getTemplatesId.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getTemplatesIdCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getTemplatesId.useQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getTemplatesId.useSuspenseInfiniteQuery({ + * path: { + * id: id + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetTemplatesIdData, + GetTemplatesIdError, + OperationInfiniteData, + GetTemplatesIdData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetTemplatesIdError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getTemplatesIdData = qraft.v1Service.getTemplatesId.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getTemplatesIdResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getTemplatesIdCombinedData = qraft.v1Service.getTemplatesId.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * } + * }, + * { + * path: { + * id: id2 + * } + * } + * ] + * }); + * getTemplatesIdCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getTemplatesId.useSuspenseQuery({ + * path: { + * id: id + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetTemplatesIdSchema; + types: { + parameters: GetTemplatesIdParameters; + data: GetTemplatesIdData; + error: GetTemplatesIdError; + }; + }; + /** @summary Get leases durations. */ + getLeasesDurationOwner: { + /** @summary Get leases durations. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + >, + options?: CancelOptions + ): Promise; + /** @summary Get leases durations. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getLeasesDurationOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getLeasesDurationOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get leases durations. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + DeepReadonly, + GetLeasesDurationOwnerError + > + ): Promise>; + /** @summary Get leases durations. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + DeepReadonly, + GetLeasesDurationOwnerError + > + ): Promise; + /** @summary Get leases durations. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + DeepReadonly, + GetLeasesDurationOwnerError + > + ): Promise>; + /** @summary Get leases durations. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): Promise; + /** @summary Get leases durations. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): Promise; + /** @summary Get leases durations. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): Promise; + /** @summary Get leases durations. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get leases durations. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [queryKey: ServiceOperationQueryKey, data: GetLeasesDurationOwnerData | undefined] + >; + /** @summary Get leases durations. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetLeasesDurationOwnerData | undefined; + /** @summary Get leases durations. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get leases durations. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetLeasesDurationOwnerError> | undefined; + /** @summary Get leases durations. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get leases durations. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): number; + /** @summary Get leases durations. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetLeasesDurationOwnerSchema, + options: { + parameters: GetLeasesDurationOwnerParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get leases durations. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get leases durations. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): void; + /** @summary Get leases durations. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + >, + options?: ResetOptions + ): Promise; + /** @summary Get leases durations. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get leases durations. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get leases durations. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetLeasesDurationOwnerData | undefined; + /** @summary Get leases durations. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getLeasesDurationOwner.useInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetLeasesDurationOwnerParameters, + TQueryFnData = GetLeasesDurationOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getLeasesDurationOwner.useInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetLeasesDurationOwnerParameters, + TQueryFnData = GetLeasesDurationOwnerData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getLeasesDurationOwnerTotal = qraft.v1Service.getLeasesDurationOwner.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getLeasesDurationOwnerByParametersTotal = qraft.v1Service.getLeasesDurationOwner.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + | QueryFiltersByQueryKey< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerData, + TInfinite, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getLeasesDurationOwnerResults = qraft.v1Service.getLeasesDurationOwner.useQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getLeasesDurationOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getLeasesDurationOwnerCombinedResults = qraft.v1Service.getLeasesDurationOwner.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getLeasesDurationOwnerCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get leases durations. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getLeasesDurationOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getLeasesDurationOwner.useQuery({ + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getLeasesDurationOwner.useSuspenseInfiniteQuery({ + * path: { + * owner: owner + * } + * }, { + * initialPageParam: { + * query: { + * dseq: initialDseq + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + OperationInfiniteData, + GetLeasesDurationOwnerData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetLeasesDurationOwnerError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getLeasesDurationOwnerData = qraft.v1Service.getLeasesDurationOwner.useSuspenseQueries({ + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getLeasesDurationOwnerResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getLeasesDurationOwnerCombinedData = qraft.v1Service.getLeasesDurationOwner.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * owner: owner1 + * }, + * query: { + * dseq: dseq1 + * } + * }, + * { + * path: { + * owner: owner2 + * }, + * query: { + * dseq: dseq2 + * } + * } + * ] + * }); + * getLeasesDurationOwnerCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetLeasesDurationOwnerSchema, + GetLeasesDurationOwnerParameters, + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get leases durations. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getLeasesDurationOwner.useSuspenseQuery({ + * path: { + * owner: owner + * }, + * query: { + * dseq: dseq + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetLeasesDurationOwnerData, + GetLeasesDurationOwnerError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetLeasesDurationOwnerSchema; + types: { + parameters: GetLeasesDurationOwnerParameters; + data: GetLeasesDurationOwnerData; + error: GetLeasesDurationOwnerError; + }; + }; + /** @summary Get address details */ + getAddressesAddress: { + /** @summary Get address details */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get address details */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressData, + GetAddressesAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressData, + GetAddressesAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get address details */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressSchema, + GetAddressesAddressData, + GetAddressesAddressParameters, + DeepReadonly, + GetAddressesAddressError + > + ): Promise>; + /** @summary Get address details */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressSchema, + GetAddressesAddressData, + GetAddressesAddressParameters, + DeepReadonly, + GetAddressesAddressError + > + ): Promise; + /** @summary Get address details */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAddressesAddressSchema, + GetAddressesAddressData, + GetAddressesAddressParameters, + DeepReadonly, + GetAddressesAddressError + > + ): Promise>; + /** @summary Get address details */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get address details */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get address details */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetAddressesAddressSchema, + GetAddressesAddressData, + GetAddressesAddressParameters, + GetAddressesAddressError + > + ): Promise; + /** @summary Get address details */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get address details */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetAddressesAddressData | undefined]>; + /** @summary Get address details */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetAddressesAddressData | undefined; + /** @summary Get address details */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get address details */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetAddressesAddressError> | undefined; + /** @summary Get address details */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get address details */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get address details */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetAddressesAddressSchema, + options: { + parameters: GetAddressesAddressParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get address details */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get address details */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get address details */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get address details */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get address details */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get address details */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetAddressesAddressData | undefined; + /** @summary Get address details */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressParameters, + TQueryFnData = GetAddressesAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddress.useInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressParameters, + TQueryFnData = GetAddressesAddressData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAddressesAddressTotal = qraft.v1Service.getAddressesAddress.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAddressesAddressByParametersTotal = qraft.v1Service.getAddressesAddress.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * address: address + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAddressesAddressResults = qraft.v1Service.getAddressesAddress.useQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getAddressesAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAddressesAddressCombinedResults = qraft.v1Service.getAddressesAddress.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getAddressesAddressCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get address details */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressData, + GetAddressesAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddress.useQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressData, + GetAddressesAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddress.useSuspenseInfiniteQuery({ + * path: { + * address: address + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAddressesAddressData, + GetAddressesAddressError, + OperationInfiniteData, + GetAddressesAddressData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetAddressesAddressError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAddressesAddressData = qraft.v1Service.getAddressesAddress.useSuspenseQueries({ + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getAddressesAddressResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAddressesAddressCombinedData = qraft.v1Service.getAddressesAddress.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1 + * } + * }, + * { + * path: { + * address: address2 + * } + * } + * ] + * }); + * getAddressesAddressCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get address details + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAddressesAddress.useSuspenseQuery({ + * path: { + * address: address + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetAddressesAddressData, + GetAddressesAddressError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetAddressesAddressSchema; + types: { + parameters: GetAddressesAddressParameters; + data: GetAddressesAddressData; + error: GetAddressesAddressError; + }; + }; + /** @summary Get a list of transactions for a given address. */ + getAddressesAddressTransactionsSkipLimit: { + /** @summary Get a list of transactions for a given address. */ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + >, + options?: CancelOptions + ): Promise; + /** @summary Get a list of transactions for a given address. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of transactions for a given address. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise>; + /** @summary Get a list of transactions for a given address. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise; + /** @summary Get a list of transactions for a given address. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + DeepReadonly, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise>; + /** @summary Get a list of transactions for a given address. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise; + /** @summary Get a list of transactions for a given address. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise; + /** @summary Get a list of transactions for a given address. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): Promise; + /** @summary Get a list of transactions for a given address. */ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a list of transactions for a given address. */ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [ + queryKey: ServiceOperationQueryKey, + data: GetAddressesAddressTransactionsSkipLimitData | undefined + ] + >; + /** @summary Get a list of transactions for a given address. */ + getQueryData( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): GetAddressesAddressTransactionsSkipLimitData | undefined; + /** @summary Get a list of transactions for a given address. */ + getQueryState( + parameters: + | ServiceOperationQueryKey + | DeepReadonly + ): QueryState | undefined; + /** @summary Get a list of transactions for a given address. */ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): + | QueryState< + OperationInfiniteData, + GetAddressesAddressTransactionsSkipLimitError + > + | undefined; + /** @summary Get a list of transactions for a given address. */ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + >, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of transactions for a given address. */ + isFetching( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): number; + /** @summary Get a list of transactions for a given address. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetAddressesAddressTransactionsSkipLimitSchema, + options: { + parameters: GetAddressesAddressTransactionsSkipLimitParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of transactions for a given address. */ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + >, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of transactions for a given address. */ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): void; + /** @summary Get a list of transactions for a given address. */ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + >, + options?: ResetOptions + ): Promise; + /** @summary Get a list of transactions for a given address. */ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + | NoInfer>> + | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of transactions for a given address. */ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of transactions for a given address. */ + setQueryData( + parameters: + | DeepReadonly + | ServiceOperationQueryKey, + updater: Updater< + NoInfer | undefined, + NoInfer> | undefined + >, + options?: SetDataOptions + ): GetAddressesAddressTransactionsSkipLimitData | undefined; + /** @summary Get a list of transactions for a given address. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressTransactionsSkipLimitParameters, + TQueryFnData = GetAddressesAddressTransactionsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetAddressesAddressTransactionsSkipLimitParameters, + TQueryFnData = GetAddressesAddressTransactionsSkipLimitData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAddressesAddressTransactionsSkipLimitTotal = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAddressesAddressTransactionsSkipLimitByParametersTotal = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * address: address, + * limit: limit + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + | QueryFiltersByQueryKey< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitData, + TInfinite, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAddressesAddressTransactionsSkipLimitResults = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQueries({ + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * } + * } + * ] + * }); + * getAddressesAddressTransactionsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAddressesAddressTransactionsSkipLimitCombinedResults = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * } + * } + * ] + * }); + * getAddressesAddressTransactionsSkipLimitCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array> + ) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of transactions for a given address. */ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useQuery({ + * path: { + * address: address, + * limit: limit + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useSuspenseInfiniteQuery({ + * path: { + * address: address, + * limit: limit + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + OperationInfiniteData, + GetAddressesAddressTransactionsSkipLimitData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult< + OperationInfiniteData, + GetAddressesAddressTransactionsSkipLimitError | Error + >; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAddressesAddressTransactionsSkipLimitData = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useSuspenseQueries({ + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * } + * } + * ] + * }); + * getAddressesAddressTransactionsSkipLimitResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAddressesAddressTransactionsSkipLimitCombinedData = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * address: address1, + * limit: limit1 + * } + * }, + * { + * path: { + * address: address2, + * limit: limit2 + * } + * } + * ] + * }); + * getAddressesAddressTransactionsSkipLimitCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetAddressesAddressTransactionsSkipLimitSchema, + GetAddressesAddressTransactionsSkipLimitParameters, + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: ( + results: Array< + WithOptional, "data"> + > + ) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of transactions for a given address. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAddressesAddressTransactionsSkipLimit.useSuspenseQuery({ + * path: { + * address: address, + * limit: limit + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetAddressesAddressTransactionsSkipLimitData, + GetAddressesAddressTransactionsSkipLimitError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetAddressesAddressTransactionsSkipLimitSchema; + types: { + parameters: GetAddressesAddressTransactionsSkipLimitParameters; + data: GetAddressesAddressTransactionsSkipLimitData; + error: GetAddressesAddressTransactionsSkipLimitError; + }; + }; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getNodesNetwork: { + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNodesNetwork.useQuery({ + * path: { + * network: network + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetNodesNetworkData, + GetNodesNetworkError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNodesNetwork.useQuery({ + * path: { + * network: network + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNodesNetworkSchema, + GetNodesNetworkData, + GetNodesNetworkParameters, + DeepReadonly, + GetNodesNetworkError + > + ): Promise>; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNodesNetworkSchema, + GetNodesNetworkData, + GetNodesNetworkParameters, + DeepReadonly, + GetNodesNetworkError + > + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetNodesNetworkSchema, + GetNodesNetworkData, + GetNodesNetworkParameters, + DeepReadonly, + GetNodesNetworkError + > + ): Promise>; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetNodesNetworkData | undefined]>; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetNodesNetworkData | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetNodesNetworkError> | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetNodesNetworkSchema, + options: { + parameters: GetNodesNetworkParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetNodesNetworkData | undefined; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNodesNetwork.useInfiniteQuery({ + * path: { + * network: network + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNodesNetworkParameters, + TQueryFnData = GetNodesNetworkData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNodesNetworkError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNodesNetwork.useInfiniteQuery({ + * path: { + * network: network + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNodesNetworkParameters, + TQueryFnData = GetNodesNetworkData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNodesNetworkError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getNodesNetworkTotal = qraft.v1Service.getNodesNetwork.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getNodesNetworkByParametersTotal = qraft.v1Service.getNodesNetwork.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * network: network + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getNodesNetworkResults = qraft.v1Service.getNodesNetwork.useQueries({ + * queries: [ + * { + * path: { + * network: network1 + * } + * }, + * { + * path: { + * network: network2 + * } + * } + * ] + * }); + * getNodesNetworkResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getNodesNetworkCombinedResults = qraft.v1Service.getNodesNetwork.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * network: network1 + * } + * }, + * { + * path: { + * network: network2 + * } + * } + * ] + * }); + * getNodesNetworkCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /** @summary Get a list of nodes (api/rpc) for a specific network. */ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNodesNetwork.useQuery({ + * path: { + * network: network + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetNodesNetworkData, + GetNodesNetworkError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNodesNetwork.useQuery({ + * path: { + * network: network + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions>, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNodesNetwork.useSuspenseInfiniteQuery({ + * path: { + * network: network + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetNodesNetworkData, + GetNodesNetworkError, + OperationInfiniteData, + GetNodesNetworkData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetNodesNetworkError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getNodesNetworkData = qraft.v1Service.getNodesNetwork.useSuspenseQueries({ + * queries: [ + * { + * path: { + * network: network1 + * } + * }, + * { + * path: { + * network: network2 + * } + * } + * ] + * }); + * getNodesNetworkResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getNodesNetworkCombinedData = qraft.v1Service.getNodesNetwork.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * network: network1 + * } + * }, + * { + * path: { + * network: network2 + * } + * } + * ] + * }); + * getNodesNetworkCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @summary Get a list of nodes (api/rpc) for a specific network. + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getNodesNetwork.useSuspenseQuery({ + * path: { + * network: network + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions>, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetNodesNetworkSchema; + types: { + parameters: GetNodesNetworkParameters; + data: GetNodesNetworkData; + error: GetNodesNetworkError; + }; + }; + createAlert: { + /**/ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createAlert.useMutation({ + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createAlert.useMutation() + * mutate({ + * body: bodyPayload, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createAlert.useMutation({ + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createAlert.useMutation() + * mutate({ + * body: bodyPayload, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const createAlertTotal = qraft.v1Service.createAlert.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const createAlertTotal = qraft.v1Service.createAlert.useIsMutating({ + * parameters: { + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: CreateAlertSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const createAlertPendingMutationVariables = qraft.v1Service.createAlert.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const createAlertMutationData = qraft.v1Service.createAlert.useMutationState({ + * filters: { + * parameters: { + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: CreateAlertSchema; + types: { + parameters: CreateAlertParameters; + data: CreateAlertData; + error: CreateAlertError; + body: CreateAlertBody; + }; + }; + getAlerts: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetAlertsError> | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetAlertsError> | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetAlertsSchema, + GetAlertsData, + GetAlertsParameters, + DeepReadonly, + GetAlertsError + > | void + ): Promise>; + /**/ + fetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /**/ + prefetchQuery(options: ServiceOperationFetchQueryOptions | void): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetAlertsData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): GetAlertsData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey | void + ): QueryState, GetAlertsError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetAlertsSchema, + options: { + parameters: GetAlertsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: (DeepReadonly | undefined) | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetAlertsData | undefined; + /**/ + getInfiniteQueryKey(parameters: DeepReadonly | void): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlerts.useInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAlertsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlerts.useInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAlertsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAlertsTotal = qraft.v1Service.getAlerts.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAlertsByParametersTotal = qraft.v1Service.getAlerts.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAlertsResults = qraft.v1Service.getAlerts.useQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAlertsCombinedResults = qraft.v1Service.getAlerts.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly | void): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions>, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlerts.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlerts.useSuspenseInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAlertsData, + GetAlertsError, + OperationInfiniteData, + GetAlertsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetAlertsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAlertsData = qraft.v1Service.getAlerts.useSuspenseQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAlertsCombinedData = qraft.v1Service.getAlerts.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getAlerts.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAlerts.useSuspenseQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | (DeepReadonly | void), + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetAlertsSchema; + types: { + parameters: GetAlertsParameters; + data: GetAlertsData; + error: GetAlertsError; + }; + }; + getAlert: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlert.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlert.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetAlertError> + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions, GetAlertError> + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions, GetAlertError> + ): Promise>; + /**/ + fetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /**/ + prefetchQuery(options: ServiceOperationFetchQueryOptions): Promise; + /**/ + ensureQueryData(options: ServiceOperationEnsureQueryDataOptions): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetAlertData | undefined]>; + /**/ + getQueryData(parameters: ServiceOperationQueryKey | DeepReadonly): GetAlertData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetAlertError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: QueryFnOptionsByQueryKey | QueryFnOptionsByParameters, + client?: ( + schema: GetAlertSchema, + options: { + parameters: GetAlertParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetAlertData | undefined; + /**/ + getInfiniteQueryKey(parameters: DeepReadonly): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlert.useInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAlertError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlert.useInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery>( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetAlertError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getAlertTotal = qraft.v1Service.getAlert.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getAlertByParametersTotal = qraft.v1Service.getAlert.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getAlertResults = qraft.v1Service.getAlert.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getAlertCombinedResults = qraft.v1Service.getAlert.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlert.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getAlert.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit>, "queryKey"> + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getAlert.useSuspenseInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetAlertData, + GetAlertError, + OperationInfiniteData, + GetAlertData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetAlertError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getAlertData = qraft.v1Service.getAlert.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getAlertCombinedData = qraft.v1Service.getAlert.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getAlertCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array>, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getAlert.useSuspenseQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit>, "queryKey"> + ): UseSuspenseQueryResult; + schema: GetAlertSchema; + types: { + parameters: GetAlertParameters; + data: GetAlertData; + error: GetAlertError; + }; + }; + patchAlert: { + /**/ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchAlert.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchAlert.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const patchAlertTotal = qraft.v1Service.patchAlert.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const patchAlertTotal = qraft.v1Service.patchAlert.useIsMutating({ + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PatchAlertSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const patchAlertPendingMutationVariables = qraft.v1Service.patchAlert.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const patchAlertMutationData = qraft.v1Service.patchAlert.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: PatchAlertSchema; + types: { + parameters: PatchAlertParameters; + data: PatchAlertData; + error: PatchAlertError; + body: PatchAlertBody; + }; + }; + deleteAlert: { + /**/ + getMutationKey(parameters: DeepReadonly | void): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteAlert.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteAlert.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteAlertTotal = qraft.v1Service.deleteAlert.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteAlertTotal = qraft.v1Service.deleteAlert.useIsMutating({ + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteAlertSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteAlertPendingMutationVariables = qraft.v1Service.deleteAlert.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteAlertMutationData = qraft.v1Service.deleteAlert.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState, TContext> + >(options?: { + filters?: + | MutationFiltersByParameters + | MutationFiltersByMutationKey; + select?: (mutation: Mutation, TContext>) => TResult; + }): Array; + schema: DeleteAlertSchema; + types: { + parameters: DeleteAlertParameters; + data: DeleteAlertData; + error: DeleteAlertError; + body: DeleteAlertBody; + }; + }; + createNotificationChannel: { + /**/ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createNotificationChannel.useMutation({ + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + CreateNotificationChannelSchema, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + TVariables, + CreateNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createNotificationChannel.useMutation({ + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + CreateNotificationChannelSchema, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + TVariables, + CreateNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const createNotificationChannelTotal = qraft.v1Service.createNotificationChannel.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const createNotificationChannelTotal = qraft.v1Service.createNotificationChannel.useIsMutating({ + * parameters: { + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateNotificationChannelSchema, + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + > + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters< + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateNotificationChannelSchema, + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + > + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: CreateNotificationChannelSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const createNotificationChannelPendingMutationVariables = qraft.v1Service.createNotificationChannel.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const createNotificationChannelMutationData = qraft.v1Service.createNotificationChannel.useMutationState({ + * filters: { + * parameters: { + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + CreateNotificationChannelData, + CreateNotificationChannelError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateNotificationChannelSchema, + CreateNotificationChannelBody, + CreateNotificationChannelData, + CreateNotificationChannelParameters, + CreateNotificationChannelError | Error, + TContext + >; + select?: ( + mutation: Mutation< + CreateNotificationChannelData, + CreateNotificationChannelError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: CreateNotificationChannelSchema; + types: { + parameters: CreateNotificationChannelParameters; + data: CreateNotificationChannelData; + error: CreateNotificationChannelError; + body: CreateNotificationChannelBody; + }; + }; + getNotificationChannels: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + >, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + DeepReadonly, + GetNotificationChannelsError + > | void + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + DeepReadonly, + GetNotificationChannelsError + > | void + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + DeepReadonly, + GetNotificationChannelsError + > | void + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > | void + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > | void + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > | void + ): Promise; + /**/ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void) + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [queryKey: ServiceOperationQueryKey, data: GetNotificationChannelsData | undefined] + >; + /**/ + getQueryData( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): GetNotificationChannelsData | undefined; + /**/ + getQueryState( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void) + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + | void + ): QueryState, GetNotificationChannelsError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | (QueryFnOptionsByParameters | void), + client?: ( + schema: GetNotificationChannelsSchema, + options: { + parameters: GetNotificationChannelsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + >, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + >, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: + | (DeepReadonly | undefined) + | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetNotificationChannelsData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannels.useInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNotificationChannelsParameters, + TQueryFnData = GetNotificationChannelsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNotificationChannelsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannels.useInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNotificationChannelsParameters, + TQueryFnData = GetNotificationChannelsData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNotificationChannelsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getNotificationChannelsTotal = qraft.v1Service.getNotificationChannels.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getNotificationChannelsByParametersTotal = qraft.v1Service.getNotificationChannels.useIsFetching({ + * infinite: false, + * parameters: { + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + | QueryFiltersByQueryKey< + GetNotificationChannelsSchema, + GetNotificationChannelsData, + TInfinite, + GetNotificationChannelsParameters, + GetNotificationChannelsError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getNotificationChannelsResults = qraft.v1Service.getNotificationChannels.useQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getNotificationChannelsCombinedResults = qraft.v1Service.getNotificationChannels.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries< + GetNotificationChannelsSchema, + GetNotificationChannelsParameters, + GetNotificationChannelsData, + GetNotificationChannelsError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey( + parameters: DeepReadonly | void + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UndefinedInitialDataOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query without parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery() + * ``` + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannels.useQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options: Omit< + DefinedInitialDataOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannels.useSuspenseInfiniteQuery({ + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: { + * query: { + * limit: initialLimit + * } + * }, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | (DeepReadonly | void), + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + OperationInfiniteData, + GetNotificationChannelsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetNotificationChannelsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getNotificationChannelsData = qraft.v1Service.getNotificationChannels.useSuspenseQueries({ + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getNotificationChannelsCombinedData = qraft.v1Service.getNotificationChannels.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * query: { + * limit: limit1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * query: { + * limit: limit2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetNotificationChannelsSchema, + GetNotificationChannelsParameters, + GetNotificationChannelsData, + GetNotificationChannelsError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query without parameters + * ```ts + * const data = qraft.v1Service.getNotificationChannels.useSuspenseQuery() + * ``` + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getNotificationChannels.useSuspenseQuery({ + * query: { + * limit: limit + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: + | ServiceOperationQueryKey + | (DeepReadonly | void), + options?: Omit< + UseSuspenseQueryOptions< + GetNotificationChannelsData, + GetNotificationChannelsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetNotificationChannelsSchema; + types: { + parameters: GetNotificationChannelsParameters; + data: GetNotificationChannelsData; + error: GetNotificationChannelsError; + }; + }; + createDefaultChannel: { + /**/ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createDefaultChannel.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createDefaultChannel.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + CreateDefaultChannelSchema, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + TVariables, + CreateDefaultChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createDefaultChannel.useMutation({}) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.createDefaultChannel.useMutation() + * mutate({ + * body: bodyPayload + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + CreateDefaultChannelSchema, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + TVariables, + CreateDefaultChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const createDefaultChannelTotal = qraft.v1Service.createDefaultChannel.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const createDefaultChannelTotal = qraft.v1Service.createDefaultChannel.useIsMutating({ + * parameters: {} + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateDefaultChannelSchema, + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + > + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters< + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateDefaultChannelSchema, + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + > + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: CreateDefaultChannelSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const createDefaultChannelPendingMutationVariables = qraft.v1Service.createDefaultChannel.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const createDefaultChannelMutationData = qraft.v1Service.createDefaultChannel.useMutationState({ + * filters: { + * parameters: {} + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + CreateDefaultChannelData, + CreateDefaultChannelError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + CreateDefaultChannelSchema, + CreateDefaultChannelBody, + CreateDefaultChannelData, + CreateDefaultChannelParameters, + CreateDefaultChannelError | Error, + TContext + >; + select?: ( + mutation: Mutation< + CreateDefaultChannelData, + CreateDefaultChannelError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: CreateDefaultChannelSchema; + types: { + parameters: CreateDefaultChannelParameters; + data: CreateDefaultChannelData; + error: CreateDefaultChannelError; + body: CreateDefaultChannelBody; + }; + }; + getNotificationChannel: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + >, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannel.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetNotificationChannelData, + GetNotificationChannelError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannel.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetNotificationChannelData, + GetNotificationChannelError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + DeepReadonly, + GetNotificationChannelError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + DeepReadonly, + GetNotificationChannelError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + DeepReadonly, + GetNotificationChannelError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetNotificationChannelSchema, + GetNotificationChannelData, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array< + [queryKey: ServiceOperationQueryKey, data: GetNotificationChannelData | undefined] + >; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetNotificationChannelData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey + ): QueryState, GetNotificationChannelError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + >, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetNotificationChannelSchema, + options: { + parameters: GetNotificationChannelParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + >, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + >, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: + | DeepReadonly + | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + >, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetNotificationChannelData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannel.useInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNotificationChannelParameters, + TQueryFnData = GetNotificationChannelData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNotificationChannelError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannel.useInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetNotificationChannelParameters, + TQueryFnData = GetNotificationChannelData, + TData = OperationInfiniteData + >( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetNotificationChannelError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getNotificationChannelTotal = qraft.v1Service.getNotificationChannel.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getNotificationChannelByParametersTotal = qraft.v1Service.getNotificationChannel.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + | QueryFiltersByQueryKey< + GetNotificationChannelSchema, + GetNotificationChannelData, + TInfinite, + GetNotificationChannelParameters, + GetNotificationChannelError + > + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getNotificationChannelResults = qraft.v1Service.getNotificationChannel.useQueries({ + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getNotificationChannelCombinedResults = qraft.v1Service.getNotificationChannel.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey( + parameters: DeepReadonly + ): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannel.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetNotificationChannelData, + GetNotificationChannelError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getNotificationChannel.useQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetNotificationChannelData, + GetNotificationChannelError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getNotificationChannel.useSuspenseInfiniteQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: + | ServiceOperationInfiniteQueryKey + | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetNotificationChannelData, + GetNotificationChannelError, + OperationInfiniteData, + GetNotificationChannelData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetNotificationChannelError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getNotificationChannelData = qraft.v1Service.getNotificationChannel.useSuspenseQueries({ + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getNotificationChannelCombinedData = qraft.v1Service.getNotificationChannel.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * id: id1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * id: id2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getNotificationChannelCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery< + GetNotificationChannelSchema, + GetNotificationChannelParameters, + GetNotificationChannelData, + GetNotificationChannelError + > + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getNotificationChannel.useSuspenseQuery({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetNotificationChannelData, + GetNotificationChannelError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetNotificationChannelSchema; + types: { + parameters: GetNotificationChannelParameters; + data: GetNotificationChannelData; + error: GetNotificationChannelError; + }; + }; + patchNotificationChannel: { + /**/ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchNotificationChannel.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + PatchNotificationChannelSchema, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + TVariables, + PatchNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchNotificationChannel.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.patchNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + PatchNotificationChannelSchema, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + TVariables, + PatchNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const patchNotificationChannelTotal = qraft.v1Service.patchNotificationChannel.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const patchNotificationChannelTotal = qraft.v1Service.patchNotificationChannel.useIsMutating({ + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchNotificationChannelSchema, + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + > + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters< + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchNotificationChannelSchema, + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + > + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: PatchNotificationChannelSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const patchNotificationChannelPendingMutationVariables = qraft.v1Service.patchNotificationChannel.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const patchNotificationChannelMutationData = qraft.v1Service.patchNotificationChannel.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + PatchNotificationChannelData, + PatchNotificationChannelError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + PatchNotificationChannelSchema, + PatchNotificationChannelBody, + PatchNotificationChannelData, + PatchNotificationChannelParameters, + PatchNotificationChannelError | Error, + TContext + >; + select?: ( + mutation: Mutation< + PatchNotificationChannelData, + PatchNotificationChannelError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: PatchNotificationChannelSchema; + types: { + parameters: PatchNotificationChannelParameters; + data: PatchNotificationChannelData; + error: PatchNotificationChannelError; + body: PatchNotificationChannelBody; + }; + }; + deleteNotificationChannel: { + /**/ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteNotificationChannel.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + DeleteNotificationChannelSchema, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + TVariables, + DeleteNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteNotificationChannel.useMutation({ + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.deleteNotificationChannel.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + DeleteNotificationChannelSchema, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + TVariables, + DeleteNotificationChannelError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const deleteNotificationChannelTotal = qraft.v1Service.deleteNotificationChannel.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const deleteNotificationChannelTotal = qraft.v1Service.deleteNotificationChannel.useIsMutating({ + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteNotificationChannelSchema, + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + > + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters< + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteNotificationChannelSchema, + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + > + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: DeleteNotificationChannelSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const deleteNotificationChannelPendingMutationVariables = qraft.v1Service.deleteNotificationChannel.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const deleteNotificationChannelMutationData = qraft.v1Service.deleteNotificationChannel.useMutationState({ + * filters: { + * parameters: { + * path: { + * id: id + * }, + * header: { + * Authorization: authorization + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + DeleteNotificationChannelData, + DeleteNotificationChannelError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + > + | MutationFiltersByMutationKey< + DeleteNotificationChannelSchema, + DeleteNotificationChannelBody, + DeleteNotificationChannelData, + DeleteNotificationChannelParameters, + DeleteNotificationChannelError | Error, + TContext + >; + select?: ( + mutation: Mutation< + DeleteNotificationChannelData, + DeleteNotificationChannelError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: DeleteNotificationChannelSchema; + types: { + parameters: DeleteNotificationChannelParameters; + data: DeleteNotificationChannelData; + error: DeleteNotificationChannelError; + body: DeleteNotificationChannelBody; + }; + }; + upsertDeploymentAlert: { + /**/ + getMutationKey( + parameters: DeepReadonly | void + ): ServiceOperationMutationKey; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.upsertDeploymentAlert.useMutation({ + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.upsertDeploymentAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * }); + * ``` + */ + useMutation( + parameters: DeepReadonly, + options?: ServiceOperationUseMutationOptions< + UpsertDeploymentAlertSchema, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + TVariables, + UpsertDeploymentAlertError | Error, + TContext + > + ): UseMutationResult; + /** + * Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests. + * Handles loading state, optimistic updates, and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation} + * @example Mutation with predefined parameters, e.g., for updating + * ```ts + * const { mutate, isPending } = qraft.v1Service.upsertDeploymentAlert.useMutation({ + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * }) + * mutate(body); + * ``` + * @example Mutation without predefined parameters, e.g., for creating + * ```ts + * const { mutate, isPending } = qraft.v1Service.upsertDeploymentAlert.useMutation() + * mutate({ + * body: bodyPayload, + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * }); + * ``` + */ + useMutation, TContext = unknown>( + parameters: void, + options?: ServiceOperationUseMutationOptions< + UpsertDeploymentAlertSchema, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + TVariables, + UpsertDeploymentAlertError | Error, + TContext + > + ): UseMutationResult; + /** + * Returns the count of currently in-progress mutations. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation} + * @example Check how many mutations are currently in progress for the specified service method. + * ```ts + * const upsertDeploymentAlertTotal = qraft.v1Service.upsertDeploymentAlert.useIsMutating() + * ``` + * @example Check how many mutations are currently in progress with the specified parameters. + * ```ts + * const upsertDeploymentAlertTotal = qraft.v1Service.upsertDeploymentAlert.useIsMutating({ + * parameters: { + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * } + * }) + * ``` + */ + useIsMutating( + filters?: + | MutationFiltersByParameters< + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + > + | MutationFiltersByMutationKey< + UpsertDeploymentAlertSchema, + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + > + ): number; + /**/ + isMutating( + filters?: + | MutationFiltersByParameters< + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + > + | MutationFiltersByMutationKey< + UpsertDeploymentAlertSchema, + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + > + ): number; + /**/ + ( + options: ServiceOperationMutationFnOptions, + client?: ( + schema: UpsertDeploymentAlertSchema, + options: ServiceOperationMutationFnOptions + ) => Promise> + ): Promise>; + /** + * Provides access to the current state of a mutation, including its status, any resulting data, and associated errors. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation} + * @example Get all variables of all running mutations. + * ```ts + * const upsertDeploymentAlertPendingMutationVariables = qraft.v1Service.upsertDeploymentAlert.useMutationState({ + * filters: { + * status: "pending" + * }, + * select: mutation => mutation.state.variables + * }) + * ``` + * @example Get all data for specific mutations via the `parameters`. + * ```ts + * const upsertDeploymentAlertMutationData = qraft.v1Service.upsertDeploymentAlert.useMutationState({ + * filters: { + * parameters: { + * path: { + * dseq: dseq + * }, + * header: { + * "x-owner-address": xOwnerAddress + * } + * } + * }, + * select: mutation => mutation.state.data + * }) + * ``` + */ + useMutationState< + TContext = unknown, + TResult = MutationState< + UpsertDeploymentAlertData, + UpsertDeploymentAlertError | Error, + MutationVariables, + TContext + > + >(options?: { + filters?: + | MutationFiltersByParameters< + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + > + | MutationFiltersByMutationKey< + UpsertDeploymentAlertSchema, + UpsertDeploymentAlertBody, + UpsertDeploymentAlertData, + UpsertDeploymentAlertParameters, + UpsertDeploymentAlertError | Error, + TContext + >; + select?: ( + mutation: Mutation< + UpsertDeploymentAlertData, + UpsertDeploymentAlertError | Error, + MutationVariables, + TContext + > + ) => TResult; + }): Array; + schema: UpsertDeploymentAlertSchema; + types: { + parameters: UpsertDeploymentAlertParameters; + data: UpsertDeploymentAlertData; + error: UpsertDeploymentAlertError; + body: UpsertDeploymentAlertBody; + }; + }; + getDeploymentAlerts: { + /**/ + cancelQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: CancelOptions + ): Promise; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentAlerts.useQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentAlerts.useQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /**/ + fetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentAlertsSchema, + GetDeploymentAlertsData, + GetDeploymentAlertsParameters, + DeepReadonly, + GetDeploymentAlertsError + > + ): Promise>; + /**/ + prefetchInfiniteQuery( + options: ServiceOperationFetchInfiniteQueryOptions< + GetDeploymentAlertsSchema, + GetDeploymentAlertsData, + GetDeploymentAlertsParameters, + DeepReadonly, + GetDeploymentAlertsError + > + ): Promise; + /**/ + ensureInfiniteQueryData( + options: ServiceOperationEnsureInfiniteQueryDataOptions< + GetDeploymentAlertsSchema, + GetDeploymentAlertsData, + GetDeploymentAlertsParameters, + DeepReadonly, + GetDeploymentAlertsError + > + ): Promise>; + /**/ + fetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /**/ + prefetchQuery( + options: ServiceOperationFetchQueryOptions + ): Promise; + /**/ + ensureQueryData( + options: ServiceOperationEnsureQueryDataOptions< + GetDeploymentAlertsSchema, + GetDeploymentAlertsData, + GetDeploymentAlertsParameters, + GetDeploymentAlertsError + > + ): Promise; + /**/ + getInfiniteQueryData( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly + ): OperationInfiniteData | undefined; + /**/ + getQueriesData( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): TInfinite extends true + ? Array< + [ + queryKey: ServiceOperationInfiniteQueryKey, + data: NoInfer> | undefined + ] + > + : Array<[queryKey: ServiceOperationQueryKey, data: GetDeploymentAlertsData | undefined]>; + /**/ + getQueryData( + parameters: ServiceOperationQueryKey | DeepReadonly + ): GetDeploymentAlertsData | undefined; + /**/ + getQueryState( + parameters: ServiceOperationQueryKey | DeepReadonly + ): QueryState | undefined; + /**/ + getInfiniteQueryState( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey + ): QueryState, GetDeploymentAlertsError> | undefined; + /**/ + invalidateQueries( + filters?: InvalidateQueryFilters, + options?: InvalidateOptions + ): Promise; + /**/ + isFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /**/ + , TSignal extends AbortSignal = AbortSignal>( + options: + | QueryFnOptionsByQueryKey + | QueryFnOptionsByParameters, + client?: ( + schema: GetDeploymentAlertsSchema, + options: { + parameters: GetDeploymentAlertsParameters; + signal?: TSignal; + meta?: TMeta; + } + ) => Promise> + ): Promise>; + /**/ + refetchQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: RefetchOptions + ): Promise; + /**/ + removeQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): void; + /**/ + resetQueries( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + options?: ResetOptions + ): Promise; + /**/ + setInfiniteQueryData( + parameters: DeepReadonly | ServiceOperationInfiniteQueryKey, + updater: Updater< + NoInfer> | undefined, + NoInfer>> | undefined + >, + options?: SetDataOptions + ): OperationInfiniteData | undefined; + /**/ + setQueriesData( + filters: + | QueryFiltersByParameters + | QueryFiltersByQueryKey, + updater: Updater | undefined, NoInfer | undefined>, + options?: SetDataOptions + ): Array; + /**/ + setQueryData( + parameters: DeepReadonly | ServiceOperationQueryKey, + updater: Updater | undefined, NoInfer> | undefined>, + options?: SetDataOptions + ): GetDeploymentAlertsData | undefined; + /**/ + getInfiniteQueryKey( + parameters: DeepReadonly + ): ServiceOperationInfiniteQueryKey; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentAlerts.useInfiniteQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentAlertsParameters, + TQueryFnData = GetDeploymentAlertsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UndefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentAlertsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseInfiniteQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation} + * + * @example Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentAlerts.useInfiniteQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useInfiniteQuery< + TPageParam extends GetDeploymentAlertsParameters, + TQueryFnData = GetDeploymentAlertsData, + TData = OperationInfiniteData + >( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataInfiniteOptions< + TQueryFnData, + GetDeploymentAlertsError, + TData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): DefinedUseInfiniteQueryResult; + /** + * Monitors the number of queries currently fetching, matching the provided filters. + * Useful for creating loading indicators or performing actions based on active requests. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation} + * @example Checks the total number of queries fetching from the specified service method, + * both normal and infinite. If no parameters are provided, no filtering is applied. + * ```ts + * const getDeploymentAlertsTotal = qraft.v1Service.getDeploymentAlerts.useIsFetching() + * ``` + * @example Checks the number of normal queries fetching with the specified parameters. + * ```ts + * const getDeploymentAlertsByParametersTotal = qraft.v1Service.getDeploymentAlerts.useIsFetching({ + * infinite: false, + * parameters: { + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * } + * }) + * ``` + */ + useIsFetching( + filters?: + | QueryFiltersByParameters + | QueryFiltersByQueryKey + ): number; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation} + * @example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties. + * ```ts + * const getDeploymentAlertsResults = qraft.v1Service.getDeploymentAlerts.useQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getDeploymentAlertsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example Combined results. Only the data will be returned. + * ```ts + * const getDeploymentAlertsCombinedResults = qraft.v1Service.getDeploymentAlerts.useQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getDeploymentAlertsCombinedResults.forEach(data => console.log({ data })); + * ``` + */ + useQueries< + T extends Array< + UseQueryOptionsForUseQueries + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array>) => TCombinedResult; + }): TCombinedResult; + /**/ + getQueryKey(parameters: DeepReadonly): ServiceOperationQueryKey; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentAlerts.useQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UndefinedInitialDataOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseQueryResult; + /** + * Performs asynchronous data fetching, manages loading states and error handling. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation} + * @example Query with parameters + * ```ts + * const { data, isLoading } = qraft.v1Service.getDeploymentAlerts.useQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options: Omit< + DefinedInitialDataOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): DefinedUseQueryResult; + /** + * Performs asynchronous data fetching with support for infinite scrolling scenarios. + * Manages paginated data and provides utilities for fetching additional pages. + * It functions similarly to `useInfiniteQuery`, but with added support for React Suspense. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation} + * + * @example Suspense Infinite Query + * ```ts + * const { data, isLoading, fetchNextPage } = qraft.v1Service.getDeploymentAlerts.useSuspenseInfiniteQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }, { + * initialPageParam: {}, + * getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => getNextPageParams(lastPage) + * }) + * + * console.log(data); + * fetchNextPage(); // Fetch the next page + * ``` + */ + useSuspenseInfiniteQuery( + parameters: ServiceOperationInfiniteQueryKey | DeepReadonly, + options: Omit< + UseSuspenseInfiniteQueryOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + OperationInfiniteData, + GetDeploymentAlertsData, + ServiceOperationInfiniteQueryKey, + PartialParameters> + >, + "queryKey" | "getPreviousPageParam" | "getNextPageParam" | "initialPageParam" + > & + InfiniteQueryPageParamsOptions>> + ): UseSuspenseInfiniteQueryResult, GetDeploymentAlertsError | Error>; + /** + * Allows you to execute multiple asynchronous data fetching operations concurrently with Suspense support. + * Similar to useQueries but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQueries|`useSuspenseQueries(...)` documentation} + * @example Basic usage with Suspense + * ```ts + * const getDeploymentAlertsData = qraft.v1Service.getDeploymentAlerts.useSuspenseQueries({ + * queries: [ + * { + * path: { + * dseq: dseq1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getDeploymentAlertsResults.forEach(({ isSuccess, data, error }) => console.log({ isSuccess, data, error })); + * ``` + * @example With data transformation using combine + * ```ts + * const getDeploymentAlertsCombinedData = qraft.v1Service.getDeploymentAlerts.useSuspenseQueries({ + * combine: results => results.map(result => result.data), + * queries: [ + * { + * path: { + * dseq: dseq1 + * }, + * header: { + * Authorization: authorization1 + * } + * }, + * { + * path: { + * dseq: dseq2 + * }, + * header: { + * Authorization: authorization2 + * } + * } + * ] + * }); + * getDeploymentAlertsCombinedData.forEach(data => console.log({ data })); + * ``` + */ + useSuspenseQueries< + T extends Array< + UseQueryOptionsForUseSuspenseQuery + >, + TCombinedResult = Array> + >(options: { + queries: T; + combine?: (results: Array, "data">>) => TCombinedResult; + }): TCombinedResult; + /** + * Performs asynchronous data fetching with Suspense support. + * Similar to useQuery but integrates with React Suspense for loading states. + * + * @see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseQuery|`useSuspenseQuery(...)` documentation} + * @example Suspense Query with parameters + * ```ts + * const data = qraft.v1Service.getDeploymentAlerts.useSuspenseQuery({ + * path: { + * dseq: dseq + * }, + * header: { + * Authorization: authorization + * } + * }) + * ``` + */ + useSuspenseQuery( + parameters: ServiceOperationQueryKey | DeepReadonly, + options?: Omit< + UseSuspenseQueryOptions< + GetDeploymentAlertsData, + GetDeploymentAlertsError, + TData, + ServiceOperationQueryKey + >, + "queryKey" + > + ): UseSuspenseQueryResult; + schema: GetDeploymentAlertsSchema; + types: { + parameters: GetDeploymentAlertsParameters; + data: GetDeploymentAlertsData; + error: GetDeploymentAlertsError; + }; + }; +} +/** + * @summary Start a trial period for a user + * @description Creates a managed wallet for a user and initiates a trial period. This endpoint handles payment method validation and may require 3D Secure authentication for certain payment methods. Returns wallet information and trial status. + */ +export const postStartTrial = { + schema: { + method: "post", + url: "/v1/start-trial", + mediaType: ["application/json"], + security: [] + } +} as { + schema: PostStartTrialSchema; + [QraftServiceOperationsToken]: V1Service["postStartTrial"]; +}; +/** @summary Get a list of wallets */ +export const getWallets = { + schema: { + method: "get", + url: "/v1/wallets", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetWalletsSchema; + [QraftServiceOperationsToken]: V1Service["getWallets"]; +}; +/** + * @summary Get wallet settings + * @description Retrieves the wallet settings for the current user's wallet + */ +export const getWalletSettings = { + schema: { + method: "get", + url: "/v1/wallet-settings", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetWalletSettingsSchema; + [QraftServiceOperationsToken]: V1Service["getWalletSettings"]; +}; +/** + * @summary Create wallet settings + * @description Creates wallet settings for a user wallet + */ +export const postWalletSettings = { + schema: { + method: "post", + url: "/v1/wallet-settings", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostWalletSettingsSchema; + [QraftServiceOperationsToken]: V1Service["postWalletSettings"]; +}; +/** + * @summary Update wallet settings + * @description Updates wallet settings for a user wallet + */ +export const putWalletSettings = { + schema: { + method: "put", + url: "/v1/wallet-settings", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PutWalletSettingsSchema; + [QraftServiceOperationsToken]: V1Service["putWalletSettings"]; +}; +/** + * @summary Delete wallet settings + * @description Deletes wallet settings for a user wallet + */ +export const deleteWalletSettings = { + schema: { + method: "delete", + url: "/v1/wallet-settings", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: DeleteWalletSettingsSchema; + [QraftServiceOperationsToken]: V1Service["deleteWalletSettings"]; +}; +/** @summary Signs a transaction via a user managed wallet */ +export const postTx = { + schema: { + method: "post", + url: "/v1/tx", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostTxSchema; + [QraftServiceOperationsToken]: V1Service["postTx"]; +}; +/** @summary Creates a stripe checkout session and redirects to checkout */ +export const getCheckout = { + schema: { + method: "get", + url: "/v1/checkout", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetCheckoutSchema; + [QraftServiceOperationsToken]: V1Service["getCheckout"]; +}; +/** @summary Stripe Webhook Handler */ +export const postStripeWebhook = { + schema: { + method: "post", + url: "/v1/stripe-webhook", + mediaType: ["text/plain"], + security: [] + } +} as { + schema: PostStripeWebhookSchema; + [QraftServiceOperationsToken]: V1Service["postStripeWebhook"]; +}; +/** + * @summary Get available Stripe pricing options + * @description Retrieves the list of available pricing options for wallet top-ups, including custom amounts and standard pricing tiers + */ +export const getStripePrices = { + schema: { + method: "get", + url: "/v1/stripe/prices", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetStripePricesSchema; + [QraftServiceOperationsToken]: V1Service["getStripePrices"]; +}; +/** @summary Apply a coupon to the current user */ +export const postStripeCouponsApply = { + schema: { + method: "post", + url: "/v1/stripe/coupons/apply", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostStripeCouponsApplySchema; + [QraftServiceOperationsToken]: V1Service["postStripeCouponsApply"]; +}; +/** + * @summary Update customer organization + * @description Updates the organization/business name for the current user's Stripe customer account + */ +export const putStripeCustomersOrganization = { + schema: { + method: "put", + url: "/v1/stripe/customers/organization", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PutStripeCustomersOrganizationSchema; + [QraftServiceOperationsToken]: V1Service["putStripeCustomersOrganization"]; +}; +/** + * @summary Create a Stripe SetupIntent for adding a payment method + * @description Creates a Stripe SetupIntent that allows users to securely add payment methods to their account. The SetupIntent provides a client secret that can be used with Stripe's frontend SDKs to collect payment method details. + */ +export const postStripePaymentMethodsSetup = { + schema: { + method: "post", + url: "/v1/stripe/payment-methods/setup", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostStripePaymentMethodsSetupSchema; + [QraftServiceOperationsToken]: V1Service["postStripePaymentMethodsSetup"]; +}; +/** @summary Marks a payment method as the default. */ +export const postStripePaymentMethodsDefault = { + schema: { + method: "post", + url: "/v1/stripe/payment-methods/default", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostStripePaymentMethodsDefaultSchema; + [QraftServiceOperationsToken]: V1Service["postStripePaymentMethodsDefault"]; +}; +/** + * @summary Get the default payment method for the current user + * @description Retrieves the default payment method associated with the current user's account, including card details, validation status, and billing information. + */ +export const getStripePaymentMethodsDefault = { + schema: { + method: "get", + url: "/v1/stripe/payment-methods/default", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetStripePaymentMethodsDefaultSchema; + [QraftServiceOperationsToken]: V1Service["getStripePaymentMethodsDefault"]; +}; +/** + * @summary Get all payment methods for the current user + * @description Retrieves all saved payment methods associated with the current user's account, including card details, validation status, and billing information. + */ +export const getStripePaymentMethods = { + schema: { + method: "get", + url: "/v1/stripe/payment-methods", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetStripePaymentMethodsSchema; + [QraftServiceOperationsToken]: V1Service["getStripePaymentMethods"]; +}; +/** + * @summary Remove a payment method + * @description Permanently removes a saved payment method from the user's account. This action cannot be undone. + */ +export const deleteStripePaymentMethodsPaymentMethodId = { + schema: { + method: "delete", + url: "/v1/stripe/payment-methods/{paymentMethodId}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: DeleteStripePaymentMethodsPaymentMethodIdSchema; + [QraftServiceOperationsToken]: V1Service["deleteStripePaymentMethodsPaymentMethodId"]; +}; +/** + * @summary Validates a payment method after 3D Secure authentication + * @description Completes the validation process for a payment method that required 3D Secure authentication. This endpoint should be called after the user completes the 3D Secure challenge. + */ +export const postStripePaymentMethodsValidate = { + schema: { + method: "post", + url: "/v1/stripe/payment-methods/validate", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostStripePaymentMethodsValidateSchema; + [QraftServiceOperationsToken]: V1Service["postStripePaymentMethodsValidate"]; +}; +/** + * @summary Confirm a payment using a saved payment method + * @description Processes a payment using a previously saved payment method. This endpoint handles wallet top-ups and may require 3D Secure authentication for certain payment methods or amounts. + */ +export const postStripeTransactionsConfirm = { + schema: { + method: "post", + url: "/v1/stripe/transactions/confirm", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostStripeTransactionsConfirmSchema; + [QraftServiceOperationsToken]: V1Service["postStripeTransactionsConfirm"]; +}; +/** @summary Get transaction history for the current customer */ +export const getStripeTransactions = { + schema: { + method: "get", + url: "/v1/stripe/transactions", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetStripeTransactionsSchema; + [QraftServiceOperationsToken]: V1Service["getStripeTransactions"]; +}; +/** @summary Export transaction history as CSV for the current customer */ +export const getStripeTransactionsExport = { + schema: { + method: "get", + url: "/v1/stripe/transactions/export", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetStripeTransactionsExportSchema; + [QraftServiceOperationsToken]: V1Service["getStripeTransactionsExport"]; +}; +/** @summary Get historical data of billing and usage for a wallet address. */ +export const getUsageHistory = { + schema: { + method: "get", + url: "/v1/usage/history", + security: [] + } +} as { + schema: GetUsageHistorySchema; + [QraftServiceOperationsToken]: V1Service["getUsageHistory"]; +}; +/** @summary Get historical usage stats for a wallet address. */ +export const getUsageHistoryStats = { + schema: { + method: "get", + url: "/v1/usage/history/stats", + security: [] + } +} as { + schema: GetUsageHistoryStatsSchema; + [QraftServiceOperationsToken]: V1Service["getUsageHistoryStats"]; +}; +/** @summary Creates an anonymous user */ +export const postAnonymousUsers = { + schema: { + method: "post", + url: "/v1/anonymous-users", + security: [] + } +} as { + schema: PostAnonymousUsersSchema; + [QraftServiceOperationsToken]: V1Service["postAnonymousUsers"]; +}; +/** @summary Retrieves an anonymous user by id */ +export const getAnonymousUsersId = { + schema: { + method: "get", + url: "/v1/anonymous-users/{id}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetAnonymousUsersIdSchema; + [QraftServiceOperationsToken]: V1Service["getAnonymousUsersId"]; +}; +/** @summary Registers a new user */ +export const postRegisterUser = { + schema: { + method: "post", + url: "/v1/register-user", + mediaType: ["application/json"], + security: [] + } +} as { + schema: PostRegisterUserSchema; + [QraftServiceOperationsToken]: V1Service["postRegisterUser"]; +}; +/** @summary Retrieves the logged in user */ +export const getUserMe = { + schema: { + method: "get", + url: "/v1/user/me", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetUserMeSchema; + [QraftServiceOperationsToken]: V1Service["getUserMe"]; +}; +/** @summary Resends a verification email */ +export const postSendVerificationEmail = { + schema: { + method: "post", + url: "/v1/send-verification-email", + mediaType: ["application/json"], + security: [] + } +} as { + schema: PostSendVerificationEmailSchema; + [QraftServiceOperationsToken]: V1Service["postSendVerificationEmail"]; +}; +/** @summary Checks if the email is verified */ +export const postVerifyEmail = { + schema: { + method: "post", + url: "/v1/verify-email", + mediaType: ["application/json"], + security: [] + } +} as { + schema: PostVerifyEmailSchema; + [QraftServiceOperationsToken]: V1Service["postVerifyEmail"]; +}; +/** @summary Get deployment settings by user ID and dseq */ +export const getDeploymentSettingsUserIdDseq = { + schema: { + method: "get", + url: "/v1/deployment-settings/{userId}/{dseq}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetDeploymentSettingsUserIdDseqSchema; + [QraftServiceOperationsToken]: V1Service["getDeploymentSettingsUserIdDseq"]; +}; +/** @summary Update deployment settings */ +export const patchDeploymentSettingsUserIdDseq = { + schema: { + method: "patch", + url: "/v1/deployment-settings/{userId}/{dseq}", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PatchDeploymentSettingsUserIdDseqSchema; + [QraftServiceOperationsToken]: V1Service["patchDeploymentSettingsUserIdDseq"]; +}; +/** @summary Create deployment settings */ +export const postDeploymentSettings = { + schema: { + method: "post", + url: "/v1/deployment-settings", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostDeploymentSettingsSchema; + [QraftServiceOperationsToken]: V1Service["postDeploymentSettings"]; +}; +/** @summary Get a deployment */ +export const getDeploymentsDseq = { + schema: { + method: "get", + url: "/v1/deployments/{dseq}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetDeploymentsDseqSchema; + [QraftServiceOperationsToken]: V1Service["getDeploymentsDseq"]; +}; +/** @summary Close a deployment */ +export const deleteDeploymentsDseq = { + schema: { + method: "delete", + url: "/v1/deployments/{dseq}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: DeleteDeploymentsDseqSchema; + [QraftServiceOperationsToken]: V1Service["deleteDeploymentsDseq"]; +}; +/** @summary Update a deployment */ +export const putDeploymentsDseq = { + schema: { + method: "put", + url: "/v1/deployments/{dseq}", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PutDeploymentsDseqSchema; + [QraftServiceOperationsToken]: V1Service["putDeploymentsDseq"]; +}; +/** @summary Create new deployment */ +export const postDeployments = { + schema: { + method: "post", + url: "/v1/deployments", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostDeploymentsSchema; + [QraftServiceOperationsToken]: V1Service["postDeployments"]; +}; +/** @summary List deployments with pagination and filtering */ +export const getDeployments = { + schema: { + method: "get", + url: "/v1/deployments", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetDeploymentsSchema; + [QraftServiceOperationsToken]: V1Service["getDeployments"]; +}; +/** @summary Deposit into a deployment */ +export const postDepositDeployment = { + schema: { + method: "post", + url: "/v1/deposit-deployment", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostDepositDeploymentSchema; + [QraftServiceOperationsToken]: V1Service["postDepositDeployment"]; +}; +/** @summary Get a list of deployments by owner address. */ +export const getAddressesAddressDeploymentsSkipLimit = { + schema: { + method: "get", + url: "/v1/addresses/{address}/deployments/{skip}/{limit}", + security: [] + } +} as { + schema: GetAddressesAddressDeploymentsSkipLimitSchema; + [QraftServiceOperationsToken]: V1Service["getAddressesAddressDeploymentsSkipLimit"]; +}; +/** @summary Get deployment details */ +export const getDeploymentOwnerDseq = { + schema: { + method: "get", + url: "/v1/deployment/{owner}/{dseq}", + security: [] + } +} as { + schema: GetDeploymentOwnerDseqSchema; + [QraftServiceOperationsToken]: V1Service["getDeploymentOwnerDseq"]; +}; +/** @summary Get weekly deployment cost */ +export const getWeeklyCost = { + schema: { + method: "get", + url: "/v1/weekly-cost", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetWeeklyCostSchema; + [QraftServiceOperationsToken]: V1Service["getWeeklyCost"]; +}; +/** @summary Create leases and send manifest */ +export const postLeases = { + schema: { + method: "post", + url: "/v1/leases", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostLeasesSchema; + [QraftServiceOperationsToken]: V1Service["postLeases"]; +}; +/** @summary List all API keys */ +export const getApiKeys = { + schema: { + method: "get", + url: "/v1/api-keys", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetApiKeysSchema; + [QraftServiceOperationsToken]: V1Service["getApiKeys"]; +}; +/** @summary Create new API key */ +export const postApiKeys = { + schema: { + method: "post", + url: "/v1/api-keys", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostApiKeysSchema; + [QraftServiceOperationsToken]: V1Service["postApiKeys"]; +}; +/** @summary Get API key by ID */ +export const getApiKeysId = { + schema: { + method: "get", + url: "/v1/api-keys/{id}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetApiKeysIdSchema; + [QraftServiceOperationsToken]: V1Service["getApiKeysId"]; +}; +/** @summary Update API key */ +export const patchApiKeysId = { + schema: { + method: "patch", + url: "/v1/api-keys/{id}", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PatchApiKeysIdSchema; + [QraftServiceOperationsToken]: V1Service["patchApiKeysId"]; +}; +/** @summary Delete API key */ +export const deleteApiKeysId = { + schema: { + method: "delete", + url: "/v1/api-keys/{id}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: DeleteApiKeysIdSchema; + [QraftServiceOperationsToken]: V1Service["deleteApiKeysId"]; +}; +/** @summary List bids */ +export const getBids = { + schema: { + method: "get", + url: "/v1/bids", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetBidsSchema; + [QraftServiceOperationsToken]: V1Service["getBids"]; +}; +/** @summary List bids by dseq */ +export const getBidsDseq = { + schema: { + method: "get", + url: "/v1/bids/{dseq}", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: GetBidsDseqSchema; + [QraftServiceOperationsToken]: V1Service["getBidsDseq"]; +}; +/** @summary Create certificate */ +export const postCertificates = { + schema: { + method: "post", + url: "/v1/certificates", + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostCertificatesSchema; + [QraftServiceOperationsToken]: V1Service["postCertificates"]; +}; +/** @summary Get user balances */ +export const getBalances = { + schema: { + method: "get", + url: "/v1/balances", + security: [] + } +} as { + schema: GetBalancesSchema; + [QraftServiceOperationsToken]: V1Service["getBalances"]; +}; +/** @summary Get a list of providers. */ +export const getProviders = { + schema: { + method: "get", + url: "/v1/providers", + security: [] + } +} as { + schema: GetProvidersSchema; + [QraftServiceOperationsToken]: V1Service["getProviders"]; +}; +/** @summary Get a provider details. */ +export const getProvidersAddress = { + schema: { + method: "get", + url: "/v1/providers/{address}", + security: [] + } +} as { + schema: GetProvidersAddressSchema; + [QraftServiceOperationsToken]: V1Service["getProvidersAddress"]; +}; +export const getProvidersProviderAddressActiveLeasesGraphData = { + schema: { + method: "get", + url: "/v1/providers/{providerAddress}/active-leases-graph-data", + security: [] + } +} as { + schema: GetProvidersProviderAddressActiveLeasesGraphDataSchema; + [QraftServiceOperationsToken]: V1Service["getProvidersProviderAddressActiveLeasesGraphData"]; +}; +/** @summary Get a list of auditors. */ +export const getAuditors = { + schema: { + method: "get", + url: "/v1/auditors", + security: [] + } +} as { + schema: GetAuditorsSchema; + [QraftServiceOperationsToken]: V1Service["getAuditors"]; +}; +/** @summary Get the provider attributes schema */ +export const getProviderAttributesSchema = { + schema: { + method: "get", + url: "/v1/provider-attributes-schema", + security: [] + } +} as { + schema: GetProviderAttributesSchemaSchema; + [QraftServiceOperationsToken]: V1Service["getProviderAttributesSchema"]; +}; +/** @summary Get a list of provider regions */ +export const getProviderRegions = { + schema: { + method: "get", + url: "/v1/provider-regions", + security: [] + } +} as { + schema: GetProviderRegionsSchema; + [QraftServiceOperationsToken]: V1Service["getProviderRegions"]; +}; +/** @summary Get dashboard data for provider console. */ +export const getProviderDashboardOwner = { + schema: { + method: "get", + url: "/v1/provider-dashboard/{owner}", + security: [] + } +} as { + schema: GetProviderDashboardOwnerSchema; + [QraftServiceOperationsToken]: V1Service["getProviderDashboardOwner"]; +}; +/** @summary Get earnings data for provider console. */ +export const getProviderEarningsOwner = { + schema: { + method: "get", + url: "/v1/provider-earnings/{owner}", + security: [] + } +} as { + schema: GetProviderEarningsOwnerSchema; + [QraftServiceOperationsToken]: V1Service["getProviderEarningsOwner"]; +}; +/** @summary Get providers grouped by version. */ +export const getProviderVersions = { + schema: { + method: "get", + url: "/v1/provider-versions", + security: [] + } +} as { + schema: GetProviderVersionsSchema; + [QraftServiceOperationsToken]: V1Service["getProviderVersions"]; +}; +export const getProviderGraphDataDataName = { + schema: { + method: "get", + url: "/v1/provider-graph-data/{dataName}", + security: [] + } +} as { + schema: GetProviderGraphDataDataNameSchema; + [QraftServiceOperationsToken]: V1Service["getProviderGraphDataDataName"]; +}; +/** @summary Get a list of deployments for a provider. */ +export const getProvidersProviderDeploymentsSkipLimit = { + schema: { + method: "get", + url: "/v1/providers/{provider}/deployments/{skip}/{limit}", + security: [] + } +} as { + schema: GetProvidersProviderDeploymentsSkipLimitSchema; + [QraftServiceOperationsToken]: V1Service["getProvidersProviderDeploymentsSkipLimit"]; +}; +/** @summary Create new JWT token for managed wallet */ +export const postCreateJwtToken = { + schema: { + method: "post", + url: "/v1/create-jwt-token", + mediaType: ["application/json"], + security: ["BearerAuth", "ApiKeyAuth"] + } +} as { + schema: PostCreateJwtTokenSchema; + [QraftServiceOperationsToken]: V1Service["postCreateJwtToken"]; +}; +export const getGraphDataDataName = { + schema: { + method: "get", + url: "/v1/graph-data/{dataName}", + security: [] + } +} as { + schema: GetGraphDataDataNameSchema; + [QraftServiceOperationsToken]: V1Service["getGraphDataDataName"]; +}; +export const getDashboardData = { + schema: { + method: "get", + url: "/v1/dashboard-data", + security: [] + } +} as { + schema: GetDashboardDataSchema; + [QraftServiceOperationsToken]: V1Service["getDashboardData"]; +}; +export const getNetworkCapacity = { + schema: { + method: "get", + url: "/v1/network-capacity", + security: [] + } +} as { + schema: GetNetworkCapacitySchema; + [QraftServiceOperationsToken]: V1Service["getNetworkCapacity"]; +}; +/** @summary Get a list of recent blocks. */ +export const getBlocks = { + schema: { + method: "get", + url: "/v1/blocks", + security: [] + } +} as { + schema: GetBlocksSchema; + [QraftServiceOperationsToken]: V1Service["getBlocks"]; +}; +/** @summary Get a block by height. */ +export const getBlocksHeight = { + schema: { + method: "get", + url: "/v1/blocks/{height}", + security: [] + } +} as { + schema: GetBlocksHeightSchema; + [QraftServiceOperationsToken]: V1Service["getBlocksHeight"]; +}; +/** @summary Get the estimated date of a future block. */ +export const getPredictedBlockDateHeight = { + schema: { + method: "get", + url: "/v1/predicted-block-date/{height}", + security: [] + } +} as { + schema: GetPredictedBlockDateHeightSchema; + [QraftServiceOperationsToken]: V1Service["getPredictedBlockDateHeight"]; +}; +/** @summary Get the estimated height of a future date and time. */ +export const getPredictedDateHeightTimestamp = { + schema: { + method: "get", + url: "/v1/predicted-date-height/{timestamp}", + security: [] + } +} as { + schema: GetPredictedDateHeightTimestampSchema; + [QraftServiceOperationsToken]: V1Service["getPredictedDateHeightTimestamp"]; +}; +/** @summary Get a list of transactions. */ +export const getTransactions = { + schema: { + method: "get", + url: "/v1/transactions", + security: [] + } +} as { + schema: GetTransactionsSchema; + [QraftServiceOperationsToken]: V1Service["getTransactions"]; +}; +/** @summary Get a transaction by hash. */ +export const getTransactionsHash = { + schema: { + method: "get", + url: "/v1/transactions/{hash}", + security: [] + } +} as { + schema: GetTransactionsHashSchema; + [QraftServiceOperationsToken]: V1Service["getTransactionsHash"]; +}; +export const getMarketDataCoin = { + schema: { + method: "get", + url: "/v1/market-data/{coin}", + security: [] + } +} as { + schema: GetMarketDataCoinSchema; + [QraftServiceOperationsToken]: V1Service["getMarketDataCoin"]; +}; +export const getValidators = { + schema: { + method: "get", + url: "/v1/validators", + security: [] + } +} as { + schema: GetValidatorsSchema; + [QraftServiceOperationsToken]: V1Service["getValidators"]; +}; +export const getValidatorsAddress = { + schema: { + method: "get", + url: "/v1/validators/{address}", + security: [] + } +} as { + schema: GetValidatorsAddressSchema; + [QraftServiceOperationsToken]: V1Service["getValidatorsAddress"]; +}; +/** @summary Estimate the price of a deployment on akash and other cloud providers. */ +export const postPricing = { + schema: { + method: "post", + url: "/v1/pricing", + mediaType: ["application/json"], + security: [] + } +} as { + schema: PostPricingSchema; + [QraftServiceOperationsToken]: V1Service["postPricing"]; +}; +/** @summary Get a list of gpu models and their availability. */ +export const getGpu = { + schema: { + method: "get", + url: "/v1/gpu", + security: [] + } +} as { + schema: GetGpuSchema; + [QraftServiceOperationsToken]: V1Service["getGpu"]; +}; +/** @summary Get a list of gpu models per vendor. Based on the content from https://raw.githubusercontent.com/akash-network/provider-configs/main/devices/pcie/gpus.json. */ +export const getGpuModels = { + schema: { + method: "get", + url: "/v1/gpu-models", + security: [] + } +} as { + schema: GetGpuModelsSchema; + [QraftServiceOperationsToken]: V1Service["getGpuModels"]; +}; +/** @summary Gets gpu analytics breakdown by vendor and model. If no vendor or model is provided, all GPUs are returned. */ +export const getGpuBreakdown = { + schema: { + method: "get", + url: "/v1/gpu-breakdown", + security: [] + } +} as { + schema: GetGpuBreakdownSchema; + [QraftServiceOperationsToken]: V1Service["getGpuBreakdown"]; +}; +/** @summary Get a list of gpu models with their availability and pricing. */ +export const getGpuPrices = { + schema: { + method: "get", + url: "/v1/gpu-prices", + security: [] + } +} as { + schema: GetGpuPricesSchema; + [QraftServiceOperationsToken]: V1Service["getGpuPrices"]; +}; +export const getProposals = { + schema: { + method: "get", + url: "/v1/proposals", + security: [] + } +} as { + schema: GetProposalsSchema; + [QraftServiceOperationsToken]: V1Service["getProposals"]; +}; +export const getProposalsId = { + schema: { + method: "get", + url: "/v1/proposals/{id}", + security: [] + } +} as { + schema: GetProposalsIdSchema; + [QraftServiceOperationsToken]: V1Service["getProposalsId"]; +}; +export const getTemplates = { + schema: { + method: "get", + url: "/v1/templates", + security: [] + } +} as { + schema: GetTemplatesSchema; + [QraftServiceOperationsToken]: V1Service["getTemplates"]; +}; +export const getTemplatesList = { + schema: { + method: "get", + url: "/v1/templates-list", + security: [] + } +} as { + schema: GetTemplatesListSchema; + [QraftServiceOperationsToken]: V1Service["getTemplatesList"]; +}; +export const getTemplatesId = { + schema: { + method: "get", + url: "/v1/templates/{id}", + security: [] + } +} as { + schema: GetTemplatesIdSchema; + [QraftServiceOperationsToken]: V1Service["getTemplatesId"]; +}; +/** @summary Get leases durations. */ +export const getLeasesDurationOwner = { + schema: { + method: "get", + url: "/v1/leases-duration/{owner}", + security: [] + } +} as { + schema: GetLeasesDurationOwnerSchema; + [QraftServiceOperationsToken]: V1Service["getLeasesDurationOwner"]; +}; +/** @summary Get address details */ +export const getAddressesAddress = { + schema: { + method: "get", + url: "/v1/addresses/{address}", + security: [] + } +} as { + schema: GetAddressesAddressSchema; + [QraftServiceOperationsToken]: V1Service["getAddressesAddress"]; +}; +/** @summary Get a list of transactions for a given address. */ +export const getAddressesAddressTransactionsSkipLimit = { + schema: { + method: "get", + url: "/v1/addresses/{address}/transactions/{skip}/{limit}", + security: [] + } +} as { + schema: GetAddressesAddressTransactionsSkipLimitSchema; + [QraftServiceOperationsToken]: V1Service["getAddressesAddressTransactionsSkipLimit"]; +}; +/** @summary Get a list of nodes (api/rpc) for a specific network. */ +export const getNodesNetwork = { + schema: { + method: "get", + url: "/v1/nodes/{network}", + security: [] + } +} as { + schema: GetNodesNetworkSchema; + [QraftServiceOperationsToken]: V1Service["getNodesNetwork"]; +}; +export const createAlert = { + schema: { + method: "post", + url: "/v1/alerts", + mediaType: ["application/json"] + } +} as { + schema: CreateAlertSchema; + [QraftServiceOperationsToken]: V1Service["createAlert"]; +}; +export const getAlerts = { + schema: { + method: "get", + url: "/v1/alerts" + } +} as { + schema: GetAlertsSchema; + [QraftServiceOperationsToken]: V1Service["getAlerts"]; +}; +export const getAlert = { + schema: { + method: "get", + url: "/v1/alerts/{id}" + } +} as { + schema: GetAlertSchema; + [QraftServiceOperationsToken]: V1Service["getAlert"]; +}; +export const patchAlert = { + schema: { + method: "patch", + url: "/v1/alerts/{id}", + mediaType: ["application/json"] + } +} as { + schema: PatchAlertSchema; + [QraftServiceOperationsToken]: V1Service["patchAlert"]; +}; +export const deleteAlert = { + schema: { + method: "delete", + url: "/v1/alerts/{id}" + } +} as { + schema: DeleteAlertSchema; + [QraftServiceOperationsToken]: V1Service["deleteAlert"]; +}; +export const createNotificationChannel = { + schema: { + method: "post", + url: "/v1/notification-channels", + mediaType: ["application/json"] + } +} as { + schema: CreateNotificationChannelSchema; + [QraftServiceOperationsToken]: V1Service["createNotificationChannel"]; +}; +export const getNotificationChannels = { + schema: { + method: "get", + url: "/v1/notification-channels" + } +} as { + schema: GetNotificationChannelsSchema; + [QraftServiceOperationsToken]: V1Service["getNotificationChannels"]; +}; +export const createDefaultChannel = { + schema: { + method: "post", + url: "/v1/notification-channels/default", + mediaType: ["application/json"] + } +} as { + schema: CreateDefaultChannelSchema; + [QraftServiceOperationsToken]: V1Service["createDefaultChannel"]; +}; +export const getNotificationChannel = { + schema: { + method: "get", + url: "/v1/notification-channels/{id}" + } +} as { + schema: GetNotificationChannelSchema; + [QraftServiceOperationsToken]: V1Service["getNotificationChannel"]; +}; +export const patchNotificationChannel = { + schema: { + method: "patch", + url: "/v1/notification-channels/{id}", + mediaType: ["application/json"] + } +} as { + schema: PatchNotificationChannelSchema; + [QraftServiceOperationsToken]: V1Service["patchNotificationChannel"]; +}; +export const deleteNotificationChannel = { + schema: { + method: "delete", + url: "/v1/notification-channels/{id}" + } +} as { + schema: DeleteNotificationChannelSchema; + [QraftServiceOperationsToken]: V1Service["deleteNotificationChannel"]; +}; +export const upsertDeploymentAlert = { + schema: { + method: "post", + url: "/v1/deployment-alerts/{dseq}", + mediaType: ["application/json"] + } +} as { + schema: UpsertDeploymentAlertSchema; + [QraftServiceOperationsToken]: V1Service["upsertDeploymentAlert"]; +}; +export const getDeploymentAlerts = { + schema: { + method: "get", + url: "/v1/deployment-alerts/{dseq}" + } +} as { + schema: GetDeploymentAlertsSchema; + [QraftServiceOperationsToken]: V1Service["getDeploymentAlerts"]; +}; +export const v1Service = { + postStartTrial, + getWallets, + getWalletSettings, + postWalletSettings, + putWalletSettings, + deleteWalletSettings, + postTx, + getCheckout, + postStripeWebhook, + getStripePrices, + postStripeCouponsApply, + putStripeCustomersOrganization, + postStripePaymentMethodsSetup, + postStripePaymentMethodsDefault, + getStripePaymentMethodsDefault, + getStripePaymentMethods, + deleteStripePaymentMethodsPaymentMethodId, + postStripePaymentMethodsValidate, + postStripeTransactionsConfirm, + getStripeTransactions, + getStripeTransactionsExport, + getUsageHistory, + getUsageHistoryStats, + postAnonymousUsers, + getAnonymousUsersId, + postRegisterUser, + getUserMe, + postSendVerificationEmail, + postVerifyEmail, + getDeploymentSettingsUserIdDseq, + patchDeploymentSettingsUserIdDseq, + postDeploymentSettings, + getDeploymentsDseq, + deleteDeploymentsDseq, + putDeploymentsDseq, + postDeployments, + getDeployments, + postDepositDeployment, + getAddressesAddressDeploymentsSkipLimit, + getDeploymentOwnerDseq, + getWeeklyCost, + postLeases, + getApiKeys, + postApiKeys, + getApiKeysId, + patchApiKeysId, + deleteApiKeysId, + getBids, + getBidsDseq, + postCertificates, + getBalances, + getProviders, + getProvidersAddress, + getProvidersProviderAddressActiveLeasesGraphData, + getAuditors, + getProviderAttributesSchema, + getProviderRegions, + getProviderDashboardOwner, + getProviderEarningsOwner, + getProviderVersions, + getProviderGraphDataDataName, + getProvidersProviderDeploymentsSkipLimit, + postCreateJwtToken, + getGraphDataDataName, + getDashboardData, + getNetworkCapacity, + getBlocks, + getBlocksHeight, + getPredictedBlockDateHeight, + getPredictedDateHeightTimestamp, + getTransactions, + getTransactionsHash, + getMarketDataCoin, + getValidators, + getValidatorsAddress, + postPricing, + getGpu, + getGpuModels, + getGpuBreakdown, + getGpuPrices, + getProposals, + getProposalsId, + getTemplates, + getTemplatesList, + getTemplatesId, + getLeasesDurationOwner, + getAddressesAddress, + getAddressesAddressTransactionsSkipLimit, + getNodesNetwork, + createAlert, + getAlerts, + getAlert, + patchAlert, + deleteAlert, + createNotificationChannel, + getNotificationChannels, + createDefaultChannel, + getNotificationChannel, + patchNotificationChannel, + deleteNotificationChannel, + upsertDeploymentAlert, + getDeploymentAlerts +} as const; +type PostStartTrialSchema = { + method: "post"; + url: "/v1/start-trial"; + mediaType: ["application/json"]; + security: []; +}; +type PostStartTrialParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStartTrialData = + | paths["/v1/start-trial"]["post"]["responses"]["200"]["content"]["application/json"] + | paths["/v1/start-trial"]["post"]["responses"]["202"]["content"]["application/json"]; +type PostStartTrialError = unknown; +type PostStartTrialBody = NonNullable["content"]["application/json"]; +type GetWalletsSchema = { + method: "get"; + url: "/v1/wallets"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetWalletsParameters = paths["/v1/wallets"]["get"]["parameters"]; +type GetWalletsData = paths["/v1/wallets"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetWalletsError = unknown; +type GetWalletSettingsSchema = { + method: "get"; + url: "/v1/wallet-settings"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetWalletSettingsParameters = undefined; +type GetWalletSettingsData = paths["/v1/wallet-settings"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetWalletSettingsError = null; +type PostWalletSettingsSchema = { + method: "post"; + url: "/v1/wallet-settings"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostWalletSettingsParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostWalletSettingsData = paths["/v1/wallet-settings"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostWalletSettingsError = null; +type PostWalletSettingsBody = NonNullable["content"]["application/json"]; +type PutWalletSettingsSchema = { + method: "put"; + url: "/v1/wallet-settings"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PutWalletSettingsParameters = { + query?: never; + header?: never; + path?: never; +}; +type PutWalletSettingsData = paths["/v1/wallet-settings"]["put"]["responses"]["200"]["content"]["application/json"]; +type PutWalletSettingsError = null; +type PutWalletSettingsBody = NonNullable["content"]["application/json"]; +type DeleteWalletSettingsSchema = { + method: "delete"; + url: "/v1/wallet-settings"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type DeleteWalletSettingsParameters = { + query?: never; + header?: never; + path?: never; +}; +type DeleteWalletSettingsData = null; +type DeleteWalletSettingsError = null; +type DeleteWalletSettingsBody = undefined; +type PostTxSchema = { + method: "post"; + url: "/v1/tx"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostTxParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostTxData = paths["/v1/tx"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostTxError = unknown; +type PostTxBody = NonNullable["content"]["application/json"]; +type GetCheckoutSchema = { + method: "get"; + url: "/v1/checkout"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetCheckoutParameters = paths["/v1/checkout"]["get"]["parameters"]; +type GetCheckoutData = null; +type GetCheckoutError = unknown; +type PostStripeWebhookSchema = { + method: "post"; + url: "/v1/stripe-webhook"; + mediaType: ["text/plain"]; + security: []; +}; +type PostStripeWebhookParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripeWebhookData = null; +type PostStripeWebhookError = paths["/v1/stripe-webhook"]["post"]["responses"]["400"]["content"]["application/json"]; +type PostStripeWebhookBody = NonNullable["content"]["text/plain"]; +type GetStripePricesSchema = { + method: "get"; + url: "/v1/stripe/prices"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetStripePricesParameters = undefined; +type GetStripePricesData = paths["/v1/stripe/prices"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetStripePricesError = unknown; +type PostStripeCouponsApplySchema = { + method: "post"; + url: "/v1/stripe/coupons/apply"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostStripeCouponsApplyParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripeCouponsApplyData = paths["/v1/stripe/coupons/apply"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostStripeCouponsApplyError = unknown; +type PostStripeCouponsApplyBody = NonNullable["content"]["application/json"]; +type PutStripeCustomersOrganizationSchema = { + method: "put"; + url: "/v1/stripe/customers/organization"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PutStripeCustomersOrganizationParameters = { + query?: never; + header?: never; + path?: never; +}; +type PutStripeCustomersOrganizationData = null; +type PutStripeCustomersOrganizationError = unknown; +type PutStripeCustomersOrganizationBody = NonNullable["content"]["application/json"]; +type PostStripePaymentMethodsSetupSchema = { + method: "post"; + url: "/v1/stripe/payment-methods/setup"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostStripePaymentMethodsSetupParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripePaymentMethodsSetupData = paths["/v1/stripe/payment-methods/setup"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostStripePaymentMethodsSetupError = unknown; +type PostStripePaymentMethodsSetupBody = undefined; +type PostStripePaymentMethodsDefaultSchema = { + method: "post"; + url: "/v1/stripe/payment-methods/default"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostStripePaymentMethodsDefaultParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripePaymentMethodsDefaultData = null; +type PostStripePaymentMethodsDefaultError = unknown; +type PostStripePaymentMethodsDefaultBody = NonNullable["content"]["application/json"]; +type GetStripePaymentMethodsDefaultSchema = { + method: "get"; + url: "/v1/stripe/payment-methods/default"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetStripePaymentMethodsDefaultParameters = undefined; +type GetStripePaymentMethodsDefaultData = paths["/v1/stripe/payment-methods/default"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetStripePaymentMethodsDefaultError = null; +type GetStripePaymentMethodsSchema = { + method: "get"; + url: "/v1/stripe/payment-methods"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetStripePaymentMethodsParameters = undefined; +type GetStripePaymentMethodsData = paths["/v1/stripe/payment-methods"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetStripePaymentMethodsError = unknown; +type DeleteStripePaymentMethodsPaymentMethodIdSchema = { + method: "delete"; + url: "/v1/stripe/payment-methods/{paymentMethodId}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type DeleteStripePaymentMethodsPaymentMethodIdParameters = paths["/v1/stripe/payment-methods/{paymentMethodId}"]["delete"]["parameters"]; +type DeleteStripePaymentMethodsPaymentMethodIdData = null; +type DeleteStripePaymentMethodsPaymentMethodIdError = unknown; +type DeleteStripePaymentMethodsPaymentMethodIdBody = undefined; +type PostStripePaymentMethodsValidateSchema = { + method: "post"; + url: "/v1/stripe/payment-methods/validate"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostStripePaymentMethodsValidateParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripePaymentMethodsValidateData = paths["/v1/stripe/payment-methods/validate"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostStripePaymentMethodsValidateError = unknown; +type PostStripePaymentMethodsValidateBody = NonNullable["content"]["application/json"]; +type PostStripeTransactionsConfirmSchema = { + method: "post"; + url: "/v1/stripe/transactions/confirm"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostStripeTransactionsConfirmParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostStripeTransactionsConfirmData = + | paths["/v1/stripe/transactions/confirm"]["post"]["responses"]["200"]["content"]["application/json"] + | paths["/v1/stripe/transactions/confirm"]["post"]["responses"]["202"]["content"]["application/json"]; +type PostStripeTransactionsConfirmError = unknown; +type PostStripeTransactionsConfirmBody = NonNullable["content"]["application/json"]; +type GetStripeTransactionsSchema = { + method: "get"; + url: "/v1/stripe/transactions"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetStripeTransactionsParameters = paths["/v1/stripe/transactions"]["get"]["parameters"]; +type GetStripeTransactionsData = paths["/v1/stripe/transactions"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetStripeTransactionsError = unknown; +type GetStripeTransactionsExportSchema = { + method: "get"; + url: "/v1/stripe/transactions/export"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetStripeTransactionsExportParameters = paths["/v1/stripe/transactions/export"]["get"]["parameters"]; +type GetStripeTransactionsExportData = paths["/v1/stripe/transactions/export"]["get"]["responses"]["200"]["content"]["text/csv"]; +type GetStripeTransactionsExportError = unknown; +type GetUsageHistorySchema = { + method: "get"; + url: "/v1/usage/history"; + security: []; +}; +type GetUsageHistoryParameters = paths["/v1/usage/history"]["get"]["parameters"]; +type GetUsageHistoryData = paths["/v1/usage/history"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetUsageHistoryError = null; +type GetUsageHistoryStatsSchema = { + method: "get"; + url: "/v1/usage/history/stats"; + security: []; +}; +type GetUsageHistoryStatsParameters = paths["/v1/usage/history/stats"]["get"]["parameters"]; +type GetUsageHistoryStatsData = paths["/v1/usage/history/stats"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetUsageHistoryStatsError = null; +type PostAnonymousUsersSchema = { + method: "post"; + url: "/v1/anonymous-users"; + security: []; +}; +type PostAnonymousUsersParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostAnonymousUsersData = paths["/v1/anonymous-users"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostAnonymousUsersError = unknown; +type PostAnonymousUsersBody = undefined; +type GetAnonymousUsersIdSchema = { + method: "get"; + url: "/v1/anonymous-users/{id}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetAnonymousUsersIdParameters = paths["/v1/anonymous-users/{id}"]["get"]["parameters"]; +type GetAnonymousUsersIdData = paths["/v1/anonymous-users/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAnonymousUsersIdError = unknown; +type PostRegisterUserSchema = { + method: "post"; + url: "/v1/register-user"; + mediaType: ["application/json"]; + security: []; +}; +type PostRegisterUserParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostRegisterUserData = paths["/v1/register-user"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostRegisterUserError = unknown; +type PostRegisterUserBody = NonNullable["content"]["application/json"]; +type GetUserMeSchema = { + method: "get"; + url: "/v1/user/me"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetUserMeParameters = undefined; +type GetUserMeData = paths["/v1/user/me"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetUserMeError = unknown; +type PostSendVerificationEmailSchema = { + method: "post"; + url: "/v1/send-verification-email"; + mediaType: ["application/json"]; + security: []; +}; +type PostSendVerificationEmailParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostSendVerificationEmailData = null; +type PostSendVerificationEmailError = unknown; +type PostSendVerificationEmailBody = paths["/v1/send-verification-email"]["post"]["requestBody"]["content"]["application/json"]; +type PostVerifyEmailSchema = { + method: "post"; + url: "/v1/verify-email"; + mediaType: ["application/json"]; + security: []; +}; +type PostVerifyEmailParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostVerifyEmailData = paths["/v1/verify-email"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostVerifyEmailError = null | null; +type PostVerifyEmailBody = paths["/v1/verify-email"]["post"]["requestBody"]["content"]["application/json"]; +type GetDeploymentSettingsUserIdDseqSchema = { + method: "get"; + url: "/v1/deployment-settings/{userId}/{dseq}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetDeploymentSettingsUserIdDseqParameters = paths["/v1/deployment-settings/{userId}/{dseq}"]["get"]["parameters"]; +type GetDeploymentSettingsUserIdDseqData = paths["/v1/deployment-settings/{userId}/{dseq}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentSettingsUserIdDseqError = paths["/v1/deployment-settings/{userId}/{dseq}"]["get"]["responses"]["404"]["content"]["application/json"]; +type PatchDeploymentSettingsUserIdDseqSchema = { + method: "patch"; + url: "/v1/deployment-settings/{userId}/{dseq}"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PatchDeploymentSettingsUserIdDseqParameters = paths["/v1/deployment-settings/{userId}/{dseq}"]["patch"]["parameters"]; +type PatchDeploymentSettingsUserIdDseqData = paths["/v1/deployment-settings/{userId}/{dseq}"]["patch"]["responses"]["200"]["content"]["application/json"]; +type PatchDeploymentSettingsUserIdDseqError = paths["/v1/deployment-settings/{userId}/{dseq}"]["patch"]["responses"]["404"]["content"]["application/json"]; +type PatchDeploymentSettingsUserIdDseqBody = NonNullable< + paths["/v1/deployment-settings/{userId}/{dseq}"]["patch"]["requestBody"] +>["content"]["application/json"]; +type PostDeploymentSettingsSchema = { + method: "post"; + url: "/v1/deployment-settings"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostDeploymentSettingsParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostDeploymentSettingsData = paths["/v1/deployment-settings"]["post"]["responses"]["201"]["content"]["application/json"]; +type PostDeploymentSettingsError = unknown; +type PostDeploymentSettingsBody = NonNullable["content"]["application/json"]; +type GetDeploymentsDseqSchema = { + method: "get"; + url: "/v1/deployments/{dseq}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetDeploymentsDseqParameters = paths["/v1/deployments/{dseq}"]["get"]["parameters"]; +type GetDeploymentsDseqData = paths["/v1/deployments/{dseq}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentsDseqError = unknown; +type DeleteDeploymentsDseqSchema = { + method: "delete"; + url: "/v1/deployments/{dseq}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type DeleteDeploymentsDseqParameters = paths["/v1/deployments/{dseq}"]["delete"]["parameters"]; +type DeleteDeploymentsDseqData = paths["/v1/deployments/{dseq}"]["delete"]["responses"]["200"]["content"]["application/json"]; +type DeleteDeploymentsDseqError = unknown; +type DeleteDeploymentsDseqBody = undefined; +type PutDeploymentsDseqSchema = { + method: "put"; + url: "/v1/deployments/{dseq}"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PutDeploymentsDseqParameters = paths["/v1/deployments/{dseq}"]["put"]["parameters"]; +type PutDeploymentsDseqData = paths["/v1/deployments/{dseq}"]["put"]["responses"]["200"]["content"]["application/json"]; +type PutDeploymentsDseqError = unknown; +type PutDeploymentsDseqBody = NonNullable["content"]["application/json"]; +type PostDeploymentsSchema = { + method: "post"; + url: "/v1/deployments"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostDeploymentsParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostDeploymentsData = paths["/v1/deployments"]["post"]["responses"]["201"]["content"]["application/json"]; +type PostDeploymentsError = unknown; +type PostDeploymentsBody = NonNullable["content"]["application/json"]; +type GetDeploymentsSchema = { + method: "get"; + url: "/v1/deployments"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetDeploymentsParameters = paths["/v1/deployments"]["get"]["parameters"]; +type GetDeploymentsData = paths["/v1/deployments"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentsError = unknown; +type PostDepositDeploymentSchema = { + method: "post"; + url: "/v1/deposit-deployment"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostDepositDeploymentParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostDepositDeploymentData = paths["/v1/deposit-deployment"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostDepositDeploymentError = unknown; +type PostDepositDeploymentBody = NonNullable["content"]["application/json"]; +type GetAddressesAddressDeploymentsSkipLimitSchema = { + method: "get"; + url: "/v1/addresses/{address}/deployments/{skip}/{limit}"; + security: []; +}; +type GetAddressesAddressDeploymentsSkipLimitParameters = paths["/v1/addresses/{address}/deployments/{skip}/{limit}"]["get"]["parameters"]; +type GetAddressesAddressDeploymentsSkipLimitData = + paths["/v1/addresses/{address}/deployments/{skip}/{limit}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAddressesAddressDeploymentsSkipLimitError = null; +type GetDeploymentOwnerDseqSchema = { + method: "get"; + url: "/v1/deployment/{owner}/{dseq}"; + security: []; +}; +type GetDeploymentOwnerDseqParameters = paths["/v1/deployment/{owner}/{dseq}"]["get"]["parameters"]; +type GetDeploymentOwnerDseqData = paths["/v1/deployment/{owner}/{dseq}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentOwnerDseqError = null | null; +type GetWeeklyCostSchema = { + method: "get"; + url: "/v1/weekly-cost"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetWeeklyCostParameters = undefined; +type GetWeeklyCostData = paths["/v1/weekly-cost"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetWeeklyCostError = unknown; +type PostLeasesSchema = { + method: "post"; + url: "/v1/leases"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostLeasesParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostLeasesData = paths["/v1/leases"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostLeasesError = unknown; +type PostLeasesBody = NonNullable["content"]["application/json"]; +type GetApiKeysSchema = { + method: "get"; + url: "/v1/api-keys"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetApiKeysParameters = undefined; +type GetApiKeysData = paths["/v1/api-keys"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetApiKeysError = unknown; +type PostApiKeysSchema = { + method: "post"; + url: "/v1/api-keys"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostApiKeysParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostApiKeysData = paths["/v1/api-keys"]["post"]["responses"]["201"]["content"]["application/json"]; +type PostApiKeysError = unknown; +type PostApiKeysBody = NonNullable["content"]["application/json"]; +type GetApiKeysIdSchema = { + method: "get"; + url: "/v1/api-keys/{id}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetApiKeysIdParameters = paths["/v1/api-keys/{id}"]["get"]["parameters"]; +type GetApiKeysIdData = paths["/v1/api-keys/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetApiKeysIdError = paths["/v1/api-keys/{id}"]["get"]["responses"]["404"]["content"]["application/json"]; +type PatchApiKeysIdSchema = { + method: "patch"; + url: "/v1/api-keys/{id}"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PatchApiKeysIdParameters = paths["/v1/api-keys/{id}"]["patch"]["parameters"]; +type PatchApiKeysIdData = paths["/v1/api-keys/{id}"]["patch"]["responses"]["200"]["content"]["application/json"]; +type PatchApiKeysIdError = paths["/v1/api-keys/{id}"]["patch"]["responses"]["404"]["content"]["application/json"]; +type PatchApiKeysIdBody = NonNullable["content"]["application/json"]; +type DeleteApiKeysIdSchema = { + method: "delete"; + url: "/v1/api-keys/{id}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type DeleteApiKeysIdParameters = paths["/v1/api-keys/{id}"]["delete"]["parameters"]; +type DeleteApiKeysIdData = null; +type DeleteApiKeysIdError = paths["/v1/api-keys/{id}"]["delete"]["responses"]["404"]["content"]["application/json"]; +type DeleteApiKeysIdBody = undefined; +type GetBidsSchema = { + method: "get"; + url: "/v1/bids"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetBidsParameters = paths["/v1/bids"]["get"]["parameters"]; +type GetBidsData = paths["/v1/bids"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetBidsError = unknown; +type GetBidsDseqSchema = { + method: "get"; + url: "/v1/bids/{dseq}"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type GetBidsDseqParameters = paths["/v1/bids/{dseq}"]["get"]["parameters"]; +type GetBidsDseqData = paths["/v1/bids/{dseq}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetBidsDseqError = unknown; +type PostCertificatesSchema = { + method: "post"; + url: "/v1/certificates"; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostCertificatesParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostCertificatesData = paths["/v1/certificates"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostCertificatesError = unknown; +type PostCertificatesBody = undefined; +type GetBalancesSchema = { + method: "get"; + url: "/v1/balances"; + security: []; +}; +type GetBalancesParameters = paths["/v1/balances"]["get"]["parameters"]; +type GetBalancesData = paths["/v1/balances"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetBalancesError = unknown; +type GetProvidersSchema = { + method: "get"; + url: "/v1/providers"; + security: []; +}; +type GetProvidersParameters = paths["/v1/providers"]["get"]["parameters"]; +type GetProvidersData = paths["/v1/providers"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProvidersError = unknown; +type GetProvidersAddressSchema = { + method: "get"; + url: "/v1/providers/{address}"; + security: []; +}; +type GetProvidersAddressParameters = paths["/v1/providers/{address}"]["get"]["parameters"]; +type GetProvidersAddressData = paths["/v1/providers/{address}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProvidersAddressError = null | null; +type GetProvidersProviderAddressActiveLeasesGraphDataSchema = { + method: "get"; + url: "/v1/providers/{providerAddress}/active-leases-graph-data"; + security: []; +}; +type GetProvidersProviderAddressActiveLeasesGraphDataParameters = paths["/v1/providers/{providerAddress}/active-leases-graph-data"]["get"]["parameters"]; +type GetProvidersProviderAddressActiveLeasesGraphDataData = + paths["/v1/providers/{providerAddress}/active-leases-graph-data"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProvidersProviderAddressActiveLeasesGraphDataError = null; +type GetAuditorsSchema = { + method: "get"; + url: "/v1/auditors"; + security: []; +}; +type GetAuditorsParameters = undefined; +type GetAuditorsData = paths["/v1/auditors"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAuditorsError = unknown; +type GetProviderAttributesSchemaSchema = { + method: "get"; + url: "/v1/provider-attributes-schema"; + security: []; +}; +type GetProviderAttributesSchemaParameters = undefined; +type GetProviderAttributesSchemaData = paths["/v1/provider-attributes-schema"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderAttributesSchemaError = unknown; +type GetProviderRegionsSchema = { + method: "get"; + url: "/v1/provider-regions"; + security: []; +}; +type GetProviderRegionsParameters = undefined; +type GetProviderRegionsData = paths["/v1/provider-regions"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderRegionsError = unknown; +type GetProviderDashboardOwnerSchema = { + method: "get"; + url: "/v1/provider-dashboard/{owner}"; + security: []; +}; +type GetProviderDashboardOwnerParameters = paths["/v1/provider-dashboard/{owner}"]["get"]["parameters"]; +type GetProviderDashboardOwnerData = paths["/v1/provider-dashboard/{owner}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderDashboardOwnerError = null; +type GetProviderEarningsOwnerSchema = { + method: "get"; + url: "/v1/provider-earnings/{owner}"; + security: []; +}; +type GetProviderEarningsOwnerParameters = paths["/v1/provider-earnings/{owner}"]["get"]["parameters"]; +type GetProviderEarningsOwnerData = paths["/v1/provider-earnings/{owner}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderEarningsOwnerError = null; +type GetProviderVersionsSchema = { + method: "get"; + url: "/v1/provider-versions"; + security: []; +}; +type GetProviderVersionsParameters = undefined; +type GetProviderVersionsData = paths["/v1/provider-versions"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderVersionsError = unknown; +type GetProviderGraphDataDataNameSchema = { + method: "get"; + url: "/v1/provider-graph-data/{dataName}"; + security: []; +}; +type GetProviderGraphDataDataNameParameters = paths["/v1/provider-graph-data/{dataName}"]["get"]["parameters"]; +type GetProviderGraphDataDataNameData = paths["/v1/provider-graph-data/{dataName}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProviderGraphDataDataNameError = null; +type GetProvidersProviderDeploymentsSkipLimitSchema = { + method: "get"; + url: "/v1/providers/{provider}/deployments/{skip}/{limit}"; + security: []; +}; +type GetProvidersProviderDeploymentsSkipLimitParameters = paths["/v1/providers/{provider}/deployments/{skip}/{limit}"]["get"]["parameters"]; +type GetProvidersProviderDeploymentsSkipLimitData = + paths["/v1/providers/{provider}/deployments/{skip}/{limit}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProvidersProviderDeploymentsSkipLimitError = null; +type PostCreateJwtTokenSchema = { + method: "post"; + url: "/v1/create-jwt-token"; + mediaType: ["application/json"]; + security: ["BearerAuth", "ApiKeyAuth"]; +}; +type PostCreateJwtTokenParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostCreateJwtTokenData = paths["/v1/create-jwt-token"]["post"]["responses"]["201"]["content"]["application/json"]; +type PostCreateJwtTokenError = unknown; +type PostCreateJwtTokenBody = NonNullable["content"]["application/json"]; +type GetGraphDataDataNameSchema = { + method: "get"; + url: "/v1/graph-data/{dataName}"; + security: []; +}; +type GetGraphDataDataNameParameters = paths["/v1/graph-data/{dataName}"]["get"]["parameters"]; +type GetGraphDataDataNameData = paths["/v1/graph-data/{dataName}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetGraphDataDataNameError = null; +type GetDashboardDataSchema = { + method: "get"; + url: "/v1/dashboard-data"; + security: []; +}; +type GetDashboardDataParameters = undefined; +type GetDashboardDataData = paths["/v1/dashboard-data"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDashboardDataError = unknown; +type GetNetworkCapacitySchema = { + method: "get"; + url: "/v1/network-capacity"; + security: []; +}; +type GetNetworkCapacityParameters = undefined; +type GetNetworkCapacityData = paths["/v1/network-capacity"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetNetworkCapacityError = unknown; +type GetBlocksSchema = { + method: "get"; + url: "/v1/blocks"; + security: []; +}; +type GetBlocksParameters = paths["/v1/blocks"]["get"]["parameters"]; +type GetBlocksData = paths["/v1/blocks"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetBlocksError = unknown; +type GetBlocksHeightSchema = { + method: "get"; + url: "/v1/blocks/{height}"; + security: []; +}; +type GetBlocksHeightParameters = paths["/v1/blocks/{height}"]["get"]["parameters"]; +type GetBlocksHeightData = paths["/v1/blocks/{height}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetBlocksHeightError = null | null; +type GetPredictedBlockDateHeightSchema = { + method: "get"; + url: "/v1/predicted-block-date/{height}"; + security: []; +}; +type GetPredictedBlockDateHeightParameters = paths["/v1/predicted-block-date/{height}"]["get"]["parameters"]; +type GetPredictedBlockDateHeightData = paths["/v1/predicted-block-date/{height}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetPredictedBlockDateHeightError = null; +type GetPredictedDateHeightTimestampSchema = { + method: "get"; + url: "/v1/predicted-date-height/{timestamp}"; + security: []; +}; +type GetPredictedDateHeightTimestampParameters = paths["/v1/predicted-date-height/{timestamp}"]["get"]["parameters"]; +type GetPredictedDateHeightTimestampData = paths["/v1/predicted-date-height/{timestamp}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetPredictedDateHeightTimestampError = null; +type GetTransactionsSchema = { + method: "get"; + url: "/v1/transactions"; + security: []; +}; +type GetTransactionsParameters = paths["/v1/transactions"]["get"]["parameters"]; +type GetTransactionsData = paths["/v1/transactions"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetTransactionsError = unknown; +type GetTransactionsHashSchema = { + method: "get"; + url: "/v1/transactions/{hash}"; + security: []; +}; +type GetTransactionsHashParameters = paths["/v1/transactions/{hash}"]["get"]["parameters"]; +type GetTransactionsHashData = paths["/v1/transactions/{hash}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetTransactionsHashError = null; +type GetMarketDataCoinSchema = { + method: "get"; + url: "/v1/market-data/{coin}"; + security: []; +}; +type GetMarketDataCoinParameters = paths["/v1/market-data/{coin}"]["get"]["parameters"]; +type GetMarketDataCoinData = paths["/v1/market-data/{coin}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetMarketDataCoinError = unknown; +type GetValidatorsSchema = { + method: "get"; + url: "/v1/validators"; + security: []; +}; +type GetValidatorsParameters = undefined; +type GetValidatorsData = paths["/v1/validators"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetValidatorsError = unknown; +type GetValidatorsAddressSchema = { + method: "get"; + url: "/v1/validators/{address}"; + security: []; +}; +type GetValidatorsAddressParameters = paths["/v1/validators/{address}"]["get"]["parameters"]; +type GetValidatorsAddressData = paths["/v1/validators/{address}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetValidatorsAddressError = null | null; +type PostPricingSchema = { + method: "post"; + url: "/v1/pricing"; + mediaType: ["application/json"]; + security: []; +}; +type PostPricingParameters = { + query?: never; + header?: never; + path?: never; +}; +type PostPricingData = paths["/v1/pricing"]["post"]["responses"]["200"]["content"]["application/json"]; +type PostPricingError = null; +type PostPricingBody = NonNullable["content"]["application/json"]; +type GetGpuSchema = { + method: "get"; + url: "/v1/gpu"; + security: []; +}; +type GetGpuParameters = paths["/v1/gpu"]["get"]["parameters"]; +type GetGpuData = paths["/v1/gpu"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetGpuError = null; +type GetGpuModelsSchema = { + method: "get"; + url: "/v1/gpu-models"; + security: []; +}; +type GetGpuModelsParameters = undefined; +type GetGpuModelsData = paths["/v1/gpu-models"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetGpuModelsError = unknown; +type GetGpuBreakdownSchema = { + method: "get"; + url: "/v1/gpu-breakdown"; + security: []; +}; +type GetGpuBreakdownParameters = paths["/v1/gpu-breakdown"]["get"]["parameters"]; +type GetGpuBreakdownData = paths["/v1/gpu-breakdown"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetGpuBreakdownError = unknown; +type GetGpuPricesSchema = { + method: "get"; + url: "/v1/gpu-prices"; + security: []; +}; +type GetGpuPricesParameters = undefined; +type GetGpuPricesData = paths["/v1/gpu-prices"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetGpuPricesError = unknown; +type GetProposalsSchema = { + method: "get"; + url: "/v1/proposals"; + security: []; +}; +type GetProposalsParameters = undefined; +type GetProposalsData = paths["/v1/proposals"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProposalsError = unknown; +type GetProposalsIdSchema = { + method: "get"; + url: "/v1/proposals/{id}"; + security: []; +}; +type GetProposalsIdParameters = paths["/v1/proposals/{id}"]["get"]["parameters"]; +type GetProposalsIdData = paths["/v1/proposals/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetProposalsIdError = null | null; +type GetTemplatesSchema = { + method: "get"; + url: "/v1/templates"; + security: []; +}; +type GetTemplatesParameters = undefined; +type GetTemplatesData = paths["/v1/templates"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetTemplatesError = unknown; +type GetTemplatesListSchema = { + method: "get"; + url: "/v1/templates-list"; + security: []; +}; +type GetTemplatesListParameters = undefined; +type GetTemplatesListData = paths["/v1/templates-list"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetTemplatesListError = unknown; +type GetTemplatesIdSchema = { + method: "get"; + url: "/v1/templates/{id}"; + security: []; +}; +type GetTemplatesIdParameters = paths["/v1/templates/{id}"]["get"]["parameters"]; +type GetTemplatesIdData = paths["/v1/templates/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetTemplatesIdError = null; +type GetLeasesDurationOwnerSchema = { + method: "get"; + url: "/v1/leases-duration/{owner}"; + security: []; +}; +type GetLeasesDurationOwnerParameters = paths["/v1/leases-duration/{owner}"]["get"]["parameters"]; +type GetLeasesDurationOwnerData = paths["/v1/leases-duration/{owner}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetLeasesDurationOwnerError = null; +type GetAddressesAddressSchema = { + method: "get"; + url: "/v1/addresses/{address}"; + security: []; +}; +type GetAddressesAddressParameters = paths["/v1/addresses/{address}"]["get"]["parameters"]; +type GetAddressesAddressData = paths["/v1/addresses/{address}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAddressesAddressError = null; +type GetAddressesAddressTransactionsSkipLimitSchema = { + method: "get"; + url: "/v1/addresses/{address}/transactions/{skip}/{limit}"; + security: []; +}; +type GetAddressesAddressTransactionsSkipLimitParameters = paths["/v1/addresses/{address}/transactions/{skip}/{limit}"]["get"]["parameters"]; +type GetAddressesAddressTransactionsSkipLimitData = + paths["/v1/addresses/{address}/transactions/{skip}/{limit}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAddressesAddressTransactionsSkipLimitError = null; +type GetNodesNetworkSchema = { + method: "get"; + url: "/v1/nodes/{network}"; + security: []; +}; +type GetNodesNetworkParameters = paths["/v1/nodes/{network}"]["get"]["parameters"]; +type GetNodesNetworkData = paths["/v1/nodes/{network}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetNodesNetworkError = unknown; +type CreateAlertSchema = { + method: "post"; + url: "/v1/alerts"; + mediaType: ["application/json"]; +}; +type CreateAlertParameters = paths["/v1/alerts"]["post"]["parameters"]; +type CreateAlertData = paths["/v1/alerts"]["post"]["responses"]["201"]["content"]["application/json"]; +type CreateAlertError = + | paths["/v1/alerts"]["post"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/alerts"]["post"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/alerts"]["post"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/alerts"]["post"]["responses"]["500"]["content"]["application/json"]; +type CreateAlertBody = paths["/v1/alerts"]["post"]["requestBody"]["content"]["application/json"]; +type GetAlertsSchema = { + method: "get"; + url: "/v1/alerts"; +}; +type GetAlertsParameters = paths["/v1/alerts"]["get"]["parameters"]; +type GetAlertsData = paths["/v1/alerts"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAlertsError = + | paths["/v1/alerts"]["get"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/alerts"]["get"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/alerts"]["get"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/alerts"]["get"]["responses"]["500"]["content"]["application/json"]; +type GetAlertSchema = { + method: "get"; + url: "/v1/alerts/{id}"; +}; +type GetAlertParameters = paths["/v1/alerts/{id}"]["get"]["parameters"]; +type GetAlertData = paths["/v1/alerts/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetAlertError = + | paths["/v1/alerts/{id}"]["get"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["get"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["get"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["get"]["responses"]["500"]["content"]["application/json"]; +type PatchAlertSchema = { + method: "patch"; + url: "/v1/alerts/{id}"; + mediaType: ["application/json"]; +}; +type PatchAlertParameters = paths["/v1/alerts/{id}"]["patch"]["parameters"]; +type PatchAlertData = paths["/v1/alerts/{id}"]["patch"]["responses"]["200"]["content"]["application/json"]; +type PatchAlertError = + | paths["/v1/alerts/{id}"]["patch"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["patch"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["patch"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["patch"]["responses"]["500"]["content"]["application/json"]; +type PatchAlertBody = paths["/v1/alerts/{id}"]["patch"]["requestBody"]["content"]["application/json"]; +type DeleteAlertSchema = { + method: "delete"; + url: "/v1/alerts/{id}"; +}; +type DeleteAlertParameters = paths["/v1/alerts/{id}"]["delete"]["parameters"]; +type DeleteAlertData = paths["/v1/alerts/{id}"]["delete"]["responses"]["200"]["content"]["application/json"]; +type DeleteAlertError = + | paths["/v1/alerts/{id}"]["delete"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["delete"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["delete"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/alerts/{id}"]["delete"]["responses"]["500"]["content"]["application/json"]; +type DeleteAlertBody = undefined; +type CreateNotificationChannelSchema = { + method: "post"; + url: "/v1/notification-channels"; + mediaType: ["application/json"]; +}; +type CreateNotificationChannelParameters = paths["/v1/notification-channels"]["post"]["parameters"]; +type CreateNotificationChannelData = paths["/v1/notification-channels"]["post"]["responses"]["201"]["content"]["application/json"]; +type CreateNotificationChannelError = + | paths["/v1/notification-channels"]["post"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/notification-channels"]["post"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/notification-channels"]["post"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/notification-channels"]["post"]["responses"]["500"]["content"]["application/json"]; +type CreateNotificationChannelBody = paths["/v1/notification-channels"]["post"]["requestBody"]["content"]["application/json"]; +type GetNotificationChannelsSchema = { + method: "get"; + url: "/v1/notification-channels"; +}; +type GetNotificationChannelsParameters = paths["/v1/notification-channels"]["get"]["parameters"]; +type GetNotificationChannelsData = paths["/v1/notification-channels"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetNotificationChannelsError = + | paths["/v1/notification-channels"]["get"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/notification-channels"]["get"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/notification-channels"]["get"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/notification-channels"]["get"]["responses"]["500"]["content"]["application/json"]; +type CreateDefaultChannelSchema = { + method: "post"; + url: "/v1/notification-channels/default"; + mediaType: ["application/json"]; +}; +type CreateDefaultChannelParameters = { + query?: never; + header?: never; + path?: never; +}; +type CreateDefaultChannelData = null; +type CreateDefaultChannelError = unknown; +type CreateDefaultChannelBody = paths["/v1/notification-channels/default"]["post"]["requestBody"]["content"]["application/json"]; +type GetNotificationChannelSchema = { + method: "get"; + url: "/v1/notification-channels/{id}"; +}; +type GetNotificationChannelParameters = paths["/v1/notification-channels/{id}"]["get"]["parameters"]; +type GetNotificationChannelData = paths["/v1/notification-channels/{id}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetNotificationChannelError = + | paths["/v1/notification-channels/{id}"]["get"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["get"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["get"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["get"]["responses"]["404"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["get"]["responses"]["500"]["content"]["application/json"]; +type PatchNotificationChannelSchema = { + method: "patch"; + url: "/v1/notification-channels/{id}"; + mediaType: ["application/json"]; +}; +type PatchNotificationChannelParameters = paths["/v1/notification-channels/{id}"]["patch"]["parameters"]; +type PatchNotificationChannelData = paths["/v1/notification-channels/{id}"]["patch"]["responses"]["200"]["content"]["application/json"]; +type PatchNotificationChannelError = + | paths["/v1/notification-channels/{id}"]["patch"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["patch"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["patch"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["patch"]["responses"]["404"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["patch"]["responses"]["500"]["content"]["application/json"]; +type PatchNotificationChannelBody = paths["/v1/notification-channels/{id}"]["patch"]["requestBody"]["content"]["application/json"]; +type DeleteNotificationChannelSchema = { + method: "delete"; + url: "/v1/notification-channels/{id}"; +}; +type DeleteNotificationChannelParameters = paths["/v1/notification-channels/{id}"]["delete"]["parameters"]; +type DeleteNotificationChannelData = paths["/v1/notification-channels/{id}"]["delete"]["responses"]["200"]["content"]["application/json"]; +type DeleteNotificationChannelError = + | paths["/v1/notification-channels/{id}"]["delete"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["delete"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["delete"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["delete"]["responses"]["404"]["content"]["application/json"] + | paths["/v1/notification-channels/{id}"]["delete"]["responses"]["500"]["content"]["application/json"]; +type DeleteNotificationChannelBody = undefined; +type UpsertDeploymentAlertSchema = { + method: "post"; + url: "/v1/deployment-alerts/{dseq}"; + mediaType: ["application/json"]; +}; +type UpsertDeploymentAlertParameters = paths["/v1/deployment-alerts/{dseq}"]["post"]["parameters"]; +type UpsertDeploymentAlertData = paths["/v1/deployment-alerts/{dseq}"]["post"]["responses"]["201"]["content"]["application/json"]; +type UpsertDeploymentAlertError = + | paths["/v1/deployment-alerts/{dseq}"]["post"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["post"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["post"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["post"]["responses"]["500"]["content"]["application/json"]; +type UpsertDeploymentAlertBody = paths["/v1/deployment-alerts/{dseq}"]["post"]["requestBody"]["content"]["application/json"]; +type GetDeploymentAlertsSchema = { + method: "get"; + url: "/v1/deployment-alerts/{dseq}"; +}; +type GetDeploymentAlertsParameters = paths["/v1/deployment-alerts/{dseq}"]["get"]["parameters"]; +type GetDeploymentAlertsData = paths["/v1/deployment-alerts/{dseq}"]["get"]["responses"]["200"]["content"]["application/json"]; +type GetDeploymentAlertsError = + | paths["/v1/deployment-alerts/{dseq}"]["get"]["responses"]["400"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["get"]["responses"]["401"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["get"]["responses"]["403"]["content"]["application/json"] + | paths["/v1/deployment-alerts/{dseq}"]["get"]["responses"]["500"]["content"]["application/json"]; diff --git a/packages/react-query-sdk/src/api/services/index.ts b/packages/react-query-sdk/src/api/services/index.ts new file mode 100644 index 0000000000..d2c90f2101 --- /dev/null +++ b/packages/react-query-sdk/src/api/services/index.ts @@ -0,0 +1,17 @@ +/** + * This file was auto-generated by @openapi-qraft/cli. + * Do not make direct changes to the file. + */ + +import type { AkashService } from "./AkashService"; +import { akashService } from "./AkashService"; +import type { V1Service } from "./V1Service"; +import { v1Service } from "./V1Service"; +export type Services = { + v1: V1Service; + akash: AkashService; +}; +export const services = { + v1: v1Service, + akash: akashService +} as const;