cloudflare/resources/registrar/update-status.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import * as RegistrarAPI from "./registrar.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseUpdateStatus extends APIResource {
    static readonly _key: readonly ['registrar', 'updateStatus'];
    /**
     * Returns the current status of a domain update workflow.
     *
     * Use this endpoint to poll for completion when the PATCH response returned
     * `202 Accepted`. The URL is provided in the `links.self` field of the workflow
     * status response.
     *
     * Poll this endpoint until the workflow reaches a terminal state or a state that
     * requires user attention.
     *
     * Use increasing backoff between polls. When the workflow remains blocked on a
     * third party, use a longer polling interval and do not poll indefinitely.
     *
     * @example
     * ```ts
     * const workflowStatus =
     *   await client.registrar.updateStatus.get('example.com', {
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    get(domainName: string, params: UpdateStatusGetParams, options?: RequestOptions): APIPromise<RegistrarAPI.WorkflowStatus>;
}
export declare class UpdateStatus extends BaseUpdateStatus {
}
export interface UpdateStatusGetParams {
    /**
     * Cloudflare account ID.
     */
    account_id: string;
}
export declare namespace UpdateStatus {
    export { type UpdateStatusGetParams as UpdateStatusGetParams };
}
//# sourceMappingURL=update-status.d.ts.map