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

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as RegistrarAPI from './registrar';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BaseUpdateStatus extends APIResource {
  static override readonly _key: readonly ['registrar', 'updateStatus'] = Object.freeze([
    'registrar',
    'updateStatus',
  ] as const);

  /**
   * 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> {
    const { account_id } = params;
    return (
      this._client.get(
        path`/accounts/${account_id}/registrar/registrations/${domainName}/update-status`,
        options,
      ) as APIPromise<{ result: RegistrarAPI.WorkflowStatus }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class UpdateStatus extends BaseUpdateStatus {}

export interface UpdateStatusGetParams {
  /**
   * Cloudflare account ID.
   */
  account_id: string;
}

export declare namespace UpdateStatus {
  export { type UpdateStatusGetParams as UpdateStatusGetParams };
}