import * as API from "@distilled.cloud/core/api"; import { type HetznerOpError, type HetznerOpContext } from "../protocol.ts"; export type { HetznerOpError, HetznerOpContext }; export interface GetCertificatesActionRequest { /** ID of the Action. */ id: number; } /** Status of the Action. */ export type GetCertificatesActionResponseActionStatus = "running" | "success" | "error"; export interface GetCertificatesActionResponseActionResourcesItem { /** ID of the Resource. */ id: number; /** Type of the Resource. */ type: string; } /** Resources the Action relates to. */ export type GetCertificatesActionResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export interface GetCertificatesActionResponseActionError { /** Fixed error code for machines. */ code: string; /** Error message for humans. */ message: string; } export interface GetCertificatesActionResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: GetCertificatesActionResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: GetCertificatesActionResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: GetCertificatesActionResponseActionError | null; } export interface GetCertificatesActionResponse { action: GetCertificatesActionResponseAction; } export type ListCertificateActionsRequestSortItem = "id" | "id:asc" | "id:desc" | "command" | "command:asc" | "command:desc" | "status" | "status:asc" | "status:desc" | "started" | "started:asc" | "started:desc" | "finished" | "finished:asc" | "finished:desc"; export type ListCertificateActionsRequestSortList = Array; /** Status of the Action. */ export type ListCertificateActionsRequestStatusItem = "running" | "success" | "error"; export type ListCertificateActionsRequestStatusList = Array; export interface ListCertificateActionsRequest { /** ID of the Certificate. */ id: number; /** Sort actions by field and direction. May be used multiple times. For more information, see "[Sorting](#description/sorting)". */ sort?: ListCertificateActionsRequestSortList; /** Filter the actions by status. May be used multiple times. The response will only contain actions matching the specified statuses. */ status?: ListCertificateActionsRequestStatusList; /** Page number to return. For more information, see "[Pagination](#description/pagination)". */ page?: number; /** Maximum number of entries returned per page. For more information, see "[Pagination](#description/pagination)". */ per_page?: number; } /** Status of the Action. */ export type ListCertificateActionsResponseActionsItemStatus = "running" | "success" | "error"; export type ListCertificateActionsResponseActionsItemResourcesItem = GetCertificatesActionResponseActionResourcesItem; /** Resources the Action relates to. */ export type ListCertificateActionsResponseActionsItemResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type ListCertificateActionsResponseActionsItemError = GetCertificatesActionResponseActionError; export interface ListCertificateActionsResponseActionsItem { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: ListCertificateActionsResponseActionsItemStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: ListCertificateActionsResponseActionsItemResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: GetCertificatesActionResponseActionError | null; } export type ListCertificateActionsResponseActionsList = Array; /** See "[Pagination](#description/pagination)" for more information. */ export interface ListCertificateActionsResponseMetaPagination { /** Current page number. */ page: number; /** Maximum number of entries returned per page. */ per_page: number; /** Page number of the previous page. Can be null if the current page is the first one. */ previous_page: number | null; /** Page number of the next page. Can be null if the current page is the last one. */ next_page: number | null; /** Page number of the last page available. Can be null if the current page is the last one. */ last_page: number | null; /** Total number of entries that exist for this query. Can be null if unknown. */ total_entries: number | null; } export interface ListCertificateActionsResponseMeta { /** See "[Pagination](#description/pagination)" for more information. */ pagination: ListCertificateActionsResponseMetaPagination; } export interface ListCertificateActionsResponse { actions: ListCertificateActionsResponseActionsList; meta: ListCertificateActionsResponseMeta; } export type ListCertificatesActionsRequestIdList = Array; export type ListCertificatesActionsRequestSortItem = "id" | "id:asc" | "id:desc" | "command" | "command:asc" | "command:desc" | "status" | "status:asc" | "status:desc" | "started" | "started:asc" | "started:desc" | "finished" | "finished:asc" | "finished:desc"; export type ListCertificatesActionsRequestSortList = Array; /** Status of the Action. */ export type ListCertificatesActionsRequestStatusItem = "running" | "success" | "error"; export type ListCertificatesActionsRequestStatusList = Array; export interface ListCertificatesActionsRequest { /** Filter the actions by ID. May be used multiple times. The response will only contain actions matching the specified IDs. */ id?: ListCertificatesActionsRequestIdList; /** Sort actions by field and direction. May be used multiple times. For more information, see "[Sorting](#description/sorting)". */ sort?: ListCertificatesActionsRequestSortList; /** Filter the actions by status. May be used multiple times. The response will only contain actions matching the specified statuses. */ status?: ListCertificatesActionsRequestStatusList; /** Page number to return. For more information, see "[Pagination](#description/pagination)". */ page?: number; /** Maximum number of entries returned per page. For more information, see "[Pagination](#description/pagination)". */ per_page?: number; } /** Status of the Action. */ export type ListCertificatesActionsResponseActionsItemStatus = "running" | "success" | "error"; export type ListCertificatesActionsResponseActionsItemResourcesItem = GetCertificatesActionResponseActionResourcesItem; /** Resources the Action relates to. */ export type ListCertificatesActionsResponseActionsItemResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type ListCertificatesActionsResponseActionsItemError = GetCertificatesActionResponseActionError; export interface ListCertificatesActionsResponseActionsItem { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: ListCertificatesActionsResponseActionsItemStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: ListCertificatesActionsResponseActionsItemResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: GetCertificatesActionResponseActionError | null; } export type ListCertificatesActionsResponseActionsList = Array; /** See "[Pagination](#description/pagination)" for more information. */ export type ListCertificatesActionsResponseMetaPagination = ListCertificateActionsResponseMetaPagination; export type ListCertificatesActionsResponseMeta = ListCertificateActionsResponseMeta; export interface ListCertificatesActionsResponse { actions: ListCertificatesActionsResponseActionsList; meta: ListCertificateActionsResponseMeta; } export interface RetryCertificateRequest { /** ID of the Certificate. */ id: number; } /** Status of the Action. */ export type RetryCertificateResponseActionStatus = "running" | "success" | "error"; export type RetryCertificateResponseActionResourcesItem = GetCertificatesActionResponseActionResourcesItem; /** Resources the Action relates to. */ export type RetryCertificateResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type RetryCertificateResponseActionError = GetCertificatesActionResponseActionError; export interface RetryCertificateResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: RetryCertificateResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: RetryCertificateResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: GetCertificatesActionResponseActionError | null; } export interface RetryCertificateResponse { action: RetryCertificateResponseAction; } export type GetCertificatesActionError = HetznerOpError; /** Get an Action Returns a specific Action object. */ export declare const getCertificatesAction: API.OperationMethod; export type ListCertificateActionsError = HetznerOpError; /** List Actions for a Certificate Returns all Action objects for a Certificate. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. Only type `managed` Certificates can have Actions. For type `uploaded` Certificates the `actions` key will always contain an empty array. */ export declare const listCertificateActions: API.PaginatedOperationMethod; export type ListCertificatesActionsError = HetznerOpError; /** List Actions Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter. */ export declare const listCertificatesActions: API.PaginatedOperationMethod; export type RetryCertificateError = HetznerOpError; /** Retry Issuance or Renewal Retry a failed Certificate issuance or renewal. Only applicable if the type of the Certificate is `managed` and the issuance or renewal status is `failed`. #### Operation specific errors */ export declare const retryCertificate: API.OperationMethod; //# sourceMappingURL=certificate_actions.d.ts.map