@civitai/client 0.1.9-beta.9 → 0.2.0-beta.2

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,370 @@
+import type { Options as ClientOptions, TDataShape, Client } from './client';
+import type {
+  GetBlobData,
+  GetBlobErrors,
+  HeadBlobData,
+  HeadBlobResponses,
+  HeadBlobErrors,
+  InvokeAgeClassificationStepTemplateData,
+  InvokeAgeClassificationStepTemplateResponses,
+  InvokeAgeClassificationStepTemplateErrors,
+  InvokeComfyStepTemplateData,
+  InvokeComfyStepTemplateResponses,
+  InvokeComfyStepTemplateErrors,
+  InvokeEchoStepTemplateData,
+  InvokeEchoStepTemplateResponses,
+  InvokeEchoStepTemplateErrors,
+  InvokeImageGenStepTemplateData,
+  InvokeImageGenStepTemplateResponses,
+  InvokeImageGenStepTemplateErrors,
+  InvokeImageResourceTrainingStepTemplateData,
+  InvokeImageResourceTrainingStepTemplateResponses,
+  InvokeImageResourceTrainingStepTemplateErrors,
+  InvokeImageUploadStepTemplateData,
+  InvokeImageUploadStepTemplateResponses,
+  InvokeImageUploadStepTemplateErrors,
+  InvokeTextToImageStepTemplateData,
+  InvokeTextToImageStepTemplateResponses,
+  InvokeTextToImageStepTemplateErrors,
+  InvokeVideoEnhancementStepTemplateData,
+  InvokeVideoEnhancementStepTemplateResponses,
+  InvokeVideoEnhancementStepTemplateErrors,
+  InvokeVideoGenStepTemplateData,
+  InvokeVideoGenStepTemplateResponses,
+  InvokeVideoGenStepTemplateErrors,
+  InvalidateResourceData,
+  InvalidateResourceResponses,
+  InvalidateResourceErrors,
+  GetResourceData,
+  GetResourceResponses,
+  GetResourceErrors,
+  QueryWorkflowsData,
+  QueryWorkflowsResponses,
+  QueryWorkflowsErrors,
+  SubmitWorkflowData,
+  SubmitWorkflowResponses,
+  SubmitWorkflowErrors,
+  DeleteWorkflowData,
+  DeleteWorkflowResponses,
+  DeleteWorkflowErrors,
+  GetWorkflowData,
+  GetWorkflowResponses,
+  GetWorkflowErrors,
+  PatchWorkflowData,
+  PatchWorkflowResponses,
+  PatchWorkflowErrors,
+  UpdateWorkflowData,
+  UpdateWorkflowResponses,
+  UpdateWorkflowErrors,
+  RemoveAllWorkflowTagsData,
+  RemoveAllWorkflowTagsResponses,
+  RemoveAllWorkflowTagsErrors,
+  AddWorkflowTagData,
+  AddWorkflowTagResponses,
+  AddWorkflowTagErrors,
+  RemoveWorkflowTagData,
+  RemoveWorkflowTagResponses,
+  RemoveWorkflowTagErrors,
+  GetWorkflowStepData,
+  GetWorkflowStepResponses,
+  GetWorkflowStepErrors,
+  PatchWorkflowStepData,
+  PatchWorkflowStepResponses,
+  PatchWorkflowStepErrors,
+  UpdateWorkflowStepData,
+  UpdateWorkflowStepResponses,
+  UpdateWorkflowStepErrors,
+} from './types.gen';
+export type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean,
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
+};
+/**
+ * Get blob by ID. This will return the blob as a binary stream.
+ */
+export declare const getBlob: <ThrowOnError extends boolean = false>(
+  options: Options<GetBlobData, ThrowOnError>
+) => import('./client').RequestResult<unknown, GetBlobErrors, ThrowOnError, 'fields'>;
+/**
+ * Handles HTTP HEAD requests for a specific blob, checking its existence and NSFW level.
+ */
+export declare const headBlob: <ThrowOnError extends boolean = false>(
+  options: Options<HeadBlobData, ThrowOnError>
+) => import('./client').RequestResult<HeadBlobResponses, HeadBlobErrors, ThrowOnError, 'fields'>;
+/**
+ * Age classification
+ * Detects minors in media content. Returns a boolean value indicating whether the content contains minors as well as details on where minors are detected.
+ */
+export declare const invokeAgeClassificationStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeAgeClassificationStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeAgeClassificationStepTemplateResponses,
+  InvokeAgeClassificationStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Comfy workflows
+ * Runs a comfy workflow. Currently there are limited nodes available. Contact support for more information.
+ */
+export declare const invokeComfyStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeComfyStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeComfyStepTemplateResponses,
+  InvokeComfyStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Echo
+ * A workflow step that takes a message string and retuns it.
+ * /// This step is intended for testing purposes.
+ */
+export declare const invokeEchoStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeEchoStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeEchoStepTemplateResponses,
+  InvokeEchoStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Image Generation
+ * Generate images through text/image inputs using any of our supported engines
+ */
+export declare const invokeImageGenStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeImageGenStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeImageGenStepTemplateResponses,
+  InvokeImageGenStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * LORA Training
+ * Train LORA's
+ */
+export declare const invokeImageResourceTrainingStepTemplate: <
+  ThrowOnError extends boolean = false,
+>(
+  options?: Options<InvokeImageResourceTrainingStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeImageResourceTrainingStepTemplateResponses,
+  InvokeImageResourceTrainingStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Image upload
+ * Uploads an image to be used in a workflow
+ */
+export declare const invokeImageUploadStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeImageUploadStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeImageUploadStepTemplateResponses,
+  InvokeImageUploadStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * TextToImage
+ * Generate images using text as input
+ */
+export declare const invokeTextToImageStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeTextToImageStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeTextToImageStepTemplateResponses,
+  InvokeTextToImageStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Upscale videos and/or interpolate frames
+ */
+export declare const invokeVideoEnhancementStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeVideoEnhancementStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeVideoEnhancementStepTemplateResponses,
+  InvokeVideoEnhancementStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Video generation
+ * Generate videos through text/image inputs using any of our supported engines
+ */
+export declare const invokeVideoGenStepTemplate: <ThrowOnError extends boolean = false>(
+  options?: Options<InvokeVideoGenStepTemplateData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvokeVideoGenStepTemplateResponses,
+  InvokeVideoGenStepTemplateErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Invalidates the cache of a specific resource.
+ */
+export declare const invalidateResource: <ThrowOnError extends boolean = false>(
+  options: Options<InvalidateResourceData, ThrowOnError>
+) => import('./client').RequestResult<
+  InvalidateResourceResponses,
+  InvalidateResourceErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Get an existing resource.
+ */
+export declare const getResource: <ThrowOnError extends boolean = false>(
+  options: Options<GetResourceData, ThrowOnError>
+) => import('./client').RequestResult<
+  GetResourceResponses,
+  GetResourceErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Query workflows
+ */
+export declare const queryWorkflows: <ThrowOnError extends boolean = false>(
+  options?: Options<QueryWorkflowsData, ThrowOnError>
+) => import('./client').RequestResult<
+  QueryWorkflowsResponses,
+  QueryWorkflowsErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Submit workflow
+ */
+export declare const submitWorkflow: <ThrowOnError extends boolean = false>(
+  options?: Options<SubmitWorkflowData, ThrowOnError>
+) => import('./client').RequestResult<
+  SubmitWorkflowResponses,
+  SubmitWorkflowErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Delete workflow
+ * This will delete a workflow. This may trigger a refund if the work requested with this workflow has not yet started
+ */
+export declare const deleteWorkflow: <ThrowOnError extends boolean = false>(
+  options: Options<DeleteWorkflowData, ThrowOnError>
+) => import('./client').RequestResult<
+  DeleteWorkflowResponses,
+  DeleteWorkflowErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Get workflow
+ */
+export declare const getWorkflow: <ThrowOnError extends boolean = false>(
+  options: Options<GetWorkflowData, ThrowOnError>
+) => import('./client').RequestResult<
+  GetWorkflowResponses,
+  GetWorkflowErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Patch workflow
+ * Patches a worfklow using JSON Patch. This can currently be used to cancel a worfklow, update metadata and add additional tags
+ */
+export declare const patchWorkflow: <ThrowOnError extends boolean = false>(
+  options: Options<PatchWorkflowData, ThrowOnError>
+) => import('./client').RequestResult<
+  PatchWorkflowResponses,
+  PatchWorkflowErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Update workflow
+ * Updates a worfklow. This can currently be used to cancel a worfklow or override metadata and/or tags
+ */
+export declare const updateWorkflow: <ThrowOnError extends boolean = false>(
+  options: Options<UpdateWorkflowData, ThrowOnError>
+) => import('./client').RequestResult<
+  UpdateWorkflowResponses,
+  UpdateWorkflowErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Delete all workflow tags
+ */
+export declare const removeAllWorkflowTags: <ThrowOnError extends boolean = false>(
+  options: Options<RemoveAllWorkflowTagsData, ThrowOnError>
+) => import('./client').RequestResult<
+  RemoveAllWorkflowTagsResponses,
+  RemoveAllWorkflowTagsErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Add workflow tag
+ * Adds a tag to a workflow
+ */
+export declare const addWorkflowTag: <ThrowOnError extends boolean = false>(
+  options: Options<AddWorkflowTagData, ThrowOnError>
+) => import('./client').RequestResult<
+  AddWorkflowTagResponses,
+  AddWorkflowTagErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Delete workflow tag
+ */
+export declare const removeWorkflowTag: <ThrowOnError extends boolean = false>(
+  options: Options<RemoveWorkflowTagData, ThrowOnError>
+) => import('./client').RequestResult<
+  RemoveWorkflowTagResponses,
+  RemoveWorkflowTagErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Get the status of a workflow step
+ */
+export declare const getWorkflowStep: <ThrowOnError extends boolean = false>(
+  options: Options<GetWorkflowStepData, ThrowOnError>
+) => import('./client').RequestResult<
+  GetWorkflowStepResponses,
+  GetWorkflowStepErrors,
+  ThrowOnError,
+  'fields'
+>;
+export declare const patchWorkflowStep: <ThrowOnError extends boolean = false>(
+  options: Options<PatchWorkflowStepData, ThrowOnError>
+) => import('./client').RequestResult<
+  PatchWorkflowStepResponses,
+  PatchWorkflowStepErrors,
+  ThrowOnError,
+  'fields'
+>;
+/**
+ * Updates a step within a particular workflow.
+ */
+export declare const updateWorkflowStep: <ThrowOnError extends boolean = false>(
+  options: Options<UpdateWorkflowStepData, ThrowOnError>
+) => import('./client').RequestResult<
+  UpdateWorkflowStepResponses,
+  UpdateWorkflowStepErrors,
+  ThrowOnError,
+  'fields'
+>;