// Copyright 2022 Luca Casonato. All rights reserved. MIT license.
/**
 * Blockchain Node Engine API Client for Deno
 * ==========================================
 * 
 * 
 * 
 * Docs: https://cloud.google.com/blockchain-node-engine
 * Source: https://googleapis.deno.dev/v1/blockchainnodeengine:v1.ts
 */

import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts";
export { auth, GoogleAuth };
export type { CredentialsClient };

export class BlockchainNodeEngine {
  #client: CredentialsClient | undefined;
  #baseUrl: string;

  constructor(client?: CredentialsClient, baseUrl: string = "https://blockchainnodeengine.googleapis.com/") {
    this.#client = client;
    this.#baseUrl = baseUrl;
  }

  /**
   * Creates a new blockchain node in a given project and location.
   *
   * @param parent Required. Value for parent.
   */
  async projectsLocationsBlockchainNodesCreate(parent: string, req: BlockchainNode, opts: ProjectsLocationsBlockchainNodesCreateOptions = {}): Promise<Operation> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/blockchainNodes`);
    if (opts.blockchainNodeId !== undefined) {
      url.searchParams.append("blockchainNodeId", String(opts.blockchainNodeId));
    }
    if (opts.requestId !== undefined) {
      url.searchParams.append("requestId", String(opts.requestId));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return data as Operation;
  }

  /**
   * Deletes a single blockchain node.
   *
   * @param name Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
   */
  async projectsLocationsBlockchainNodesDelete(name: string, opts: ProjectsLocationsBlockchainNodesDeleteOptions = {}): Promise<Operation> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.requestId !== undefined) {
      url.searchParams.append("requestId", String(opts.requestId));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return data as Operation;
  }

  /**
   * Gets details of a single blockchain node.
   *
   * @param name Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
   */
  async projectsLocationsBlockchainNodesGet(name: string): Promise<BlockchainNode> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as BlockchainNode;
  }

  /**
   * Lists blockchain nodes in a given project and location.
   *
   * @param parent Required. Parent value for `ListNodesRequest`.
   */
  async projectsLocationsBlockchainNodesList(parent: string, opts: ProjectsLocationsBlockchainNodesListOptions = {}): Promise<ListBlockchainNodesResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/blockchainNodes`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.orderBy !== undefined) {
      url.searchParams.append("orderBy", String(opts.orderBy));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as ListBlockchainNodesResponse;
  }

  /**
   * Updates the parameters of a single blockchain node.
   *
   * @param name Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
   */
  async projectsLocationsBlockchainNodesPatch(name: string, req: BlockchainNode, opts: ProjectsLocationsBlockchainNodesPatchOptions = {}): Promise<Operation> {
    opts = serializeProjectsLocationsBlockchainNodesPatchOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.requestId !== undefined) {
      url.searchParams.append("requestId", String(opts.requestId));
    }
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PATCH",
      body,
    });
    return data as Operation;
  }

  /**
   * Gets information about a location.
   *
   * @param name Resource name for the location.
   */
  async projectsLocationsGet(name: string): Promise<Location> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Location;
  }

  /**
   * Lists information about the supported locations for this service.
   *
   * @param name The resource that owns the locations collection, if applicable.
   */
  async projectsLocationsList(name: string, opts: ProjectsLocationsListOptions = {}): Promise<ListLocationsResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ name }/locations`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as ListLocationsResponse;
  }

  /**
   * Starts asynchronous cancellation on a long-running operation. The server
   * makes a best effort to cancel the operation, but success is not guaranteed.
   * If the server doesn't support this method, it returns
   * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or
   * other methods to check whether the cancellation succeeded or whether the
   * operation completed despite cancellation. On successful cancellation, the
   * operation is not deleted; instead, it becomes an operation with an
   * Operation.error value with a google.rpc.Status.code of 1, corresponding to
   * `Code.CANCELLED`.
   *
   * @param name The name of the operation resource to be cancelled.
   */
  async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<GoogleProtobufEmpty> {
    const url = new URL(`${this.#baseUrl}v1/${ name }:cancel`);
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return data as GoogleProtobufEmpty;
  }

  /**
   * Deletes a long-running operation. This method indicates that the client is
   * no longer interested in the operation result. It does not cancel the
   * operation. If the server doesn't support this method, it returns
   * `google.rpc.Code.UNIMPLEMENTED`.
   *
   * @param name The name of the operation resource to be deleted.
   */
  async projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return data as GoogleProtobufEmpty;
  }

  /**
   * Gets the latest state of a long-running operation. Clients can use this
   * method to poll the operation result at intervals as recommended by the API
   * service.
   *
   * @param name The name of the operation resource.
   */
  async projectsLocationsOperationsGet(name: string): Promise<Operation> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Operation;
  }

  /**
   * Lists operations that match the specified filter in the request. If the
   * server doesn't support this method, it returns `UNIMPLEMENTED`.
   *
   * @param name The name of the operation's parent resource.
   */
  async projectsLocationsOperationsList(name: string, opts: ProjectsLocationsOperationsListOptions = {}): Promise<ListOperationsResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ name }/operations`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as ListOperationsResponse;
  }
}

/**
 * A representation of a blockchain node.
 */
export interface BlockchainNode {
  /**
   * Immutable. The blockchain type of the node.
   */
  blockchainType?:  | "BLOCKCHAIN_TYPE_UNSPECIFIED" | "ETHEREUM";
  /**
   * Output only. The connection information used to interact with a blockchain
   * node.
   */
  readonly connectionInfo?: ConnectionInfo;
  /**
   * Output only. The timestamp at which the blockchain node was first created.
   */
  readonly createTime?: Date;
  /**
   * Ethereum-specific blockchain node details.
   */
  ethereumDetails?: EthereumDetails;
  /**
   * User-provided key-value pairs.
   */
  labels?: {
    [key: string]: string
  };
  /**
   * Output only. The fully qualified name of the blockchain node. e.g.
   * `projects/my-project/locations/us-central1/blockchainNodes/my-node`.
   */
  readonly name?: string;
  /**
   * Optional. When true, the node is only accessible via Private Service
   * Connect; no public endpoints are exposed. Otherwise, the node is only
   * accessible via public endpoints. Warning: Private Service Connect enabled
   * nodes may require a manual migration effort to remain compatible with
   * future versions of the product. If this feature is enabled, you will be
   * notified of these changes along with any required action to avoid
   * disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
   */
  privateServiceConnectEnabled?: boolean;
  /**
   * Output only. A status representing the state of the node.
   */
  readonly state?:  | "STATE_UNSPECIFIED" | "CREATING" | "DELETING" | "RUNNING" | "ERROR" | "UPDATING" | "REPAIRING" | "RECONCILING" | "SYNCING";
  /**
   * Output only. The timestamp at which the blockchain node was last updated.
   */
  readonly updateTime?: Date;
}

/**
 * The request message for Operations.CancelOperation.
 */
export interface CancelOperationRequest {
}

/**
 * The connection information through which to interact with a blockchain node.
 */
export interface ConnectionInfo {
  /**
   * Output only. The endpoint information through which to interact with a
   * blockchain node.
   */
  readonly endpointInfo?: EndpointInfo;
  /**
   * Output only. A service attachment that exposes a node, and has the
   * following format:
   * projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
   */
  readonly serviceAttachment?: string;
}

/**
 * Contains endpoint information through which to interact with a blockchain
 * node.
 */
export interface EndpointInfo {
  /**
   * Output only. The assigned URL for the node JSON-RPC API endpoint.
   */
  readonly jsonRpcApiEndpoint?: string;
  /**
   * Output only. The assigned URL for the node WebSockets API endpoint.
   */
  readonly websocketsApiEndpoint?: string;
}

/**
 * Ethereum-specific blockchain node details.
 */
export interface EthereumDetails {
  /**
   * Output only. Ethereum-specific endpoint information.
   */
  readonly additionalEndpoints?: EthereumEndpoints;
  /**
   * Immutable. Enables JSON-RPC access to functions in the `admin` namespace.
   * Defaults to `false`.
   */
  apiEnableAdmin?: boolean;
  /**
   * Immutable. Enables JSON-RPC access to functions in the `debug` namespace.
   * Defaults to `false`.
   */
  apiEnableDebug?: boolean;
  /**
   * Immutable. The consensus client.
   */
  consensusClient?:  | "CONSENSUS_CLIENT_UNSPECIFIED" | "LIGHTHOUSE" | "ERIGON_EMBEDDED_CONSENSUS_LAYER";
  /**
   * Immutable. The execution client
   */
  executionClient?:  | "EXECUTION_CLIENT_UNSPECIFIED" | "GETH" | "ERIGON";
  /**
   * Details for the Geth execution client.
   */
  gethDetails?: GethDetails;
  /**
   * Immutable. The Ethereum environment being accessed.
   */
  network?:  | "NETWORK_UNSPECIFIED" | "MAINNET" | "TESTNET_GOERLI_PRATER" | "TESTNET_SEPOLIA" | "TESTNET_HOLESKY";
  /**
   * Immutable. The type of Ethereum node.
   */
  nodeType?:  | "NODE_TYPE_UNSPECIFIED" | "LIGHT" | "FULL" | "ARCHIVE";
  /**
   * Configuration for validator-related parameters on the beacon client, and
   * for any GCP-managed validator client.
   */
  validatorConfig?: ValidatorConfig;
}

/**
 * Contains endpoint information specific to Ethereum nodes.
 */
export interface EthereumEndpoints {
  /**
   * Output only. The assigned URL for the node's Beacon API endpoint.
   */
  readonly beaconApiEndpoint?: string;
  /**
   * Output only. The assigned URL for the node's Beacon Prometheus metrics
   * endpoint. See [Prometheus
   * Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for
   * more details.
   */
  readonly beaconPrometheusMetricsApiEndpoint?: string;
  /**
   * Output only. The assigned URL for the node's execution client's Prometheus
   * metrics endpoint.
   */
  readonly executionClientPrometheusMetricsApiEndpoint?: string;
}

/**
 * Options for the Geth execution client. See [Command-line
 * Options](https://geth.ethereum.org/docs/fundamentals/command-line-options)
 * for more details.
 */
export interface GethDetails {
  /**
   * Immutable. Blockchain garbage collection mode.
   */
  garbageCollectionMode?:  | "GARBAGE_COLLECTION_MODE_UNSPECIFIED" | "FULL" | "ARCHIVE";
}

/**
 * A generic empty message that you can re-use to avoid defining duplicated
 * empty messages in your APIs. A typical example is to use it as the request or
 * the response type of an API method. For instance: service Foo { rpc
 * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
 */
export interface GoogleProtobufEmpty {
}

/**
 * Message for response to listing blockchain nodes.
 */
export interface ListBlockchainNodesResponse {
  /**
   * The list of nodes
   */
  blockchainNodes?: BlockchainNode[];
  /**
   * A token identifying a page of results the server should return.
   */
  nextPageToken?: string;
  /**
   * Locations that could not be reached.
   */
  unreachable?: string[];
}

/**
 * The response message for Locations.ListLocations.
 */
export interface ListLocationsResponse {
  /**
   * A list of locations that matches the specified filter in the request.
   */
  locations?: Location[];
  /**
   * The standard List next-page token.
   */
  nextPageToken?: string;
}

/**
 * The response message for Operations.ListOperations.
 */
export interface ListOperationsResponse {
  /**
   * The standard List next-page token.
   */
  nextPageToken?: string;
  /**
   * A list of operations that matches the specified filter in the request.
   */
  operations?: Operation[];
}

/**
 * A resource that represents a Google Cloud location.
 */
export interface Location {
  /**
   * The friendly name for this location, typically a nearby city name. For
   * example, "Tokyo".
   */
  displayName?: string;
  /**
   * Cross-service attributes for the location. For example
   * {"cloud.googleapis.com/region": "us-east1"}
   */
  labels?: {
    [key: string]: string
  };
  /**
   * The canonical id for this location. For example: `"us-east1"`.
   */
  locationId?: string;
  /**
   * Service-specific metadata. For example the available capacity at the given
   * location.
   */
  metadata?: {
    [key: string]: any
  };
  /**
   * Resource name for the location, which may vary between implementations.
   * For example: `"projects/example-project/locations/us-east1"`
   */
  name?: string;
}

/**
 * This resource represents a long-running operation that is the result of a
 * network API call.
 */
export interface Operation {
  /**
   * If the value is `false`, it means the operation is still in progress. If
   * `true`, the operation is completed, and either `error` or `response` is
   * available.
   */
  done?: boolean;
  /**
   * The error result of the operation in case of failure or cancellation.
   */
  error?: Status;
  /**
   * Service-specific metadata associated with the operation. It typically
   * contains progress information and common metadata such as create time. Some
   * services might not provide such metadata. Any method that returns a
   * long-running operation should document the metadata type, if any.
   */
  metadata?: {
    [key: string]: any
  };
  /**
   * The server-assigned name, which is only unique within the same service
   * that originally returns it. If you use the default HTTP mapping, the `name`
   * should be a resource name ending with `operations/{unique_id}`.
   */
  name?: string;
  /**
   * The normal, successful response of the operation. If the original method
   * returns no data on success, such as `Delete`, the response is
   * `google.protobuf.Empty`. If the original method is standard
   * `Get`/`Create`/`Update`, the response should be the resource. For other
   * methods, the response should have the type `XxxResponse`, where `Xxx` is
   * the original method name. For example, if the original method name is
   * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
   */
  response?: {
    [key: string]: any
  };
}

/**
 * Represents the metadata of the long-running operation.
 */
export interface OperationMetadata {
  /**
   * Output only. API version used to start the operation.
   */
  readonly apiVersion?: string;
  /**
   * Output only. The time the operation was created.
   */
  readonly createTime?: Date;
  /**
   * Output only. The time the operation finished running.
   */
  readonly endTime?: Date;
  /**
   * Output only. Identifies whether the user has requested cancellation of the
   * operation. Operations that have been cancelled successfully have
   * `Operation.error` value with a `google.rpc.Status.code` of `1`,
   * corresponding to `Code.CANCELLED`.
   */
  readonly requestedCancellation?: boolean;
  /**
   * Output only. Human-readable status of the operation, if any.
   */
  readonly statusMessage?: string;
  /**
   * Output only. Server-defined resource path for the target of the operation.
   */
  readonly target?: string;
  /**
   * Output only. Name of the verb executed by the operation.
   */
  readonly verb?: string;
}

/**
 * Additional options for
 * BlockchainNodeEngine#projectsLocationsBlockchainNodesCreate.
 */
export interface ProjectsLocationsBlockchainNodesCreateOptions {
  /**
   * Required. ID of the requesting object.
   */
  blockchainNodeId?: string;
  /**
   * Optional. An optional request ID to identify requests. Specify a unique
   * request ID so that if you must retry your request, the server will know to
   * ignore the request if it has already been completed. The server will
   * guarantee that for at least 60 minutes since the first request. For
   * example, consider a situation where you make an initial request and the
   * request times out. If you make the request again with the same request ID,
   * the server can check if original operation with the same request ID was
   * received, and if so, will ignore the second request. This prevents clients
   * from accidentally creating duplicate commitments. The request ID must be a
   * valid UUID with the exception that zero UUID is not supported
   * (00000000-0000-0000-0000-000000000000).
   */
  requestId?: string;
}

/**
 * Additional options for
 * BlockchainNodeEngine#projectsLocationsBlockchainNodesDelete.
 */
export interface ProjectsLocationsBlockchainNodesDeleteOptions {
  /**
   * Optional. An optional request ID to identify requests. Specify a unique
   * request ID so that if you must retry your request, the server will know to
   * ignore the request if it has already been completed. The server will
   * guarantee that for at least 60 minutes after the first request. For
   * example, consider a situation where you make an initial request and the
   * request times out. If you make the request again with the same request ID,
   * the server can check if original operation with the same request ID was
   * received, and if so, will ignore the second request. This prevents clients
   * from accidentally creating duplicate commitments. The request ID must be a
   * valid UUID with the exception that zero UUID is not supported
   * (00000000-0000-0000-0000-000000000000).
   */
  requestId?: string;
}

/**
 * Additional options for
 * BlockchainNodeEngine#projectsLocationsBlockchainNodesList.
 */
export interface ProjectsLocationsBlockchainNodesListOptions {
  /**
   * Filtering results.
   */
  filter?: string;
  /**
   * Hint for how to order the results.
   */
  orderBy?: string;
  /**
   * Requested page size. Server may return fewer items than requested. If
   * unspecified, server will pick an appropriate default.
   */
  pageSize?: number;
  /**
   * A token identifying a page of results the server should return.
   */
  pageToken?: string;
}

/**
 * Additional options for
 * BlockchainNodeEngine#projectsLocationsBlockchainNodesPatch.
 */
export interface ProjectsLocationsBlockchainNodesPatchOptions {
  /**
   * Optional. An optional request ID to identify requests. Specify a unique
   * request ID so that if you must retry your request, the server will know to
   * ignore the request if it has already been completed. The server will
   * guarantee that for at least 60 minutes since the first request. For
   * example, consider a situation where you make an initial request and the
   * request times out. If you make the request again with the same request ID,
   * the server can check if original operation with the same request ID was
   * received, and if so, will ignore the second request. This prevents clients
   * from accidentally creating duplicate commitments. The request ID must be a
   * valid UUID with the exception that zero UUID is not supported
   * (00000000-0000-0000-0000-000000000000).
   */
  requestId?: string;
  /**
   * Required. Field mask is used to specify the fields to be overwritten in
   * the Blockchain node resource by the update. The fields specified in the
   * `update_mask` are relative to the resource, not the full request. A field
   * will be overwritten if it is in the mask. If the user does not provide a
   * mask then all fields will be overwritten.
   */
  updateMask?: string /* FieldMask */;
}

function serializeProjectsLocationsBlockchainNodesPatchOptions(data: any): ProjectsLocationsBlockchainNodesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeProjectsLocationsBlockchainNodesPatchOptions(data: any): ProjectsLocationsBlockchainNodesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * Additional options for BlockchainNodeEngine#projectsLocationsList.
 */
export interface ProjectsLocationsListOptions {
  /**
   * A filter to narrow down results to a preferred subset. The filtering
   * language accepts strings like `"displayName=tokyo"`, and is documented in
   * more detail in [AIP-160](https://google.aip.dev/160).
   */
  filter?: string;
  /**
   * The maximum number of results to return. If not set, the service selects a
   * default.
   */
  pageSize?: number;
  /**
   * A page token received from the `next_page_token` field in the response.
   * Send that page token to receive the subsequent page.
   */
  pageToken?: string;
}

/**
 * Additional options for BlockchainNodeEngine#projectsLocationsOperationsList.
 */
export interface ProjectsLocationsOperationsListOptions {
  /**
   * The standard list filter.
   */
  filter?: string;
  /**
   * The standard list page size.
   */
  pageSize?: number;
  /**
   * The standard list page token.
   */
  pageToken?: string;
}

/**
 * The `Status` type defines a logical error model that is suitable for
 * different programming environments, including REST APIs and RPC APIs. It is
 * used by [gRPC](https://github.com/grpc). Each `Status` message contains three
 * pieces of data: error code, error message, and error details. You can find
 * out more about this error model and how to work with it in the [API Design
 * Guide](https://cloud.google.com/apis/design/errors).
 */
export interface Status {
  /**
   * The status code, which should be an enum value of google.rpc.Code.
   */
  code?: number;
  /**
   * A list of messages that carry the error details. There is a common set of
   * message types for APIs to use.
   */
  details?: {
    [key: string]: any
  }[];
  /**
   * A developer-facing error message, which should be in English. Any
   * user-facing error message should be localized and sent in the
   * google.rpc.Status.details field, or localized by the client.
   */
  message?: string;
}

/**
 * Configuration for validator-related parameters on the beacon client, and for
 * any GCP-managed validator client.
 */
export interface ValidatorConfig {
  /**
   * An Ethereum address which the beacon client will send fee rewards to if no
   * recipient is configured in the validator client. See
   * https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or
   * https://docs.prylabs.network/docs/execution-node/fee-recipient for examples
   * of how this is used. Note that while this is often described as
   * "suggested", as we run the execution node we can trust the execution node,
   * and therefore this is considered enforced.
   */
  beaconFeeRecipient?: string;
  /**
   * Immutable. When true, deploys a GCP-managed validator client alongside the
   * beacon client.
   */
  managedValidatorClient?: boolean;
  /**
   * URLs for MEV-relay services to use for block building. When set, a
   * GCP-managed MEV-boost service is configured on the beacon client.
   */
  mevRelayUrls?: string[];
}