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

import { APIResource } from '../../../core/resource';
import * as SippyAPI from './sippy';
import { APIPromise } from '../../../core/api-promise';
import { buildHeaders } from '../../../internal/headers';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseSippyResource extends APIResource {
  static override readonly _key: readonly ['r2', 'buckets', 'sippy'] = Object.freeze([
    'r2',
    'buckets',
    'sippy',
  ] as const);

  /**
   * Configures and enables Sippy on-demand migration for an R2 bucket. When a
   * requested object is missing from R2, Sippy serves it from the configured source
   * storage provider and copies it to R2.
   *
   * @example
   * ```ts
   * const sippy = await client.r2.buckets.sippy.update(
   *   'example-bucket',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  update(bucketName: string, params: SippyUpdateParams, options?: RequestOptions): APIPromise<Sippy> {
    const { account_id, 'cf-r2-jurisdiction': cfR2Jurisdiction, ...body } = params;
    return (
      this._client.put(path`/accounts/${account_id}/r2/buckets/${bucketName}/sippy`, {
        body,
        ...options,
        headers: buildHeaders([
          {
            ...(cfR2Jurisdiction?.toString() != null ?
              { 'cf-r2-jurisdiction': cfR2Jurisdiction?.toString() }
            : undefined),
          },
          options?.headers,
        ]),
      }) as APIPromise<{ result: Sippy }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Disables Sippy on-demand migration for an R2 bucket. Requests no longer fetch
   * missing objects from the source storage provider. Objects already copied to R2
   * remain in the bucket.
   *
   * @example
   * ```ts
   * const sippy = await client.r2.buckets.sippy.delete(
   *   'example-bucket',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  delete(
    bucketName: string,
    params: SippyDeleteParams,
    options?: RequestOptions,
  ): APIPromise<SippyDeleteResponse> {
    const { account_id, 'cf-r2-jurisdiction': cfR2Jurisdiction } = params;
    return (
      this._client.delete(path`/accounts/${account_id}/r2/buckets/${bucketName}/sippy`, {
        ...options,
        headers: buildHeaders([
          {
            ...(cfR2Jurisdiction?.toString() != null ?
              { 'cf-r2-jurisdiction': cfR2Jurisdiction?.toString() }
            : undefined),
          },
          options?.headers,
        ]),
      }) as APIPromise<{ result: SippyDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Gets configuration for Sippy for an existing R2 bucket.
   *
   * @example
   * ```ts
   * const sippy = await client.r2.buckets.sippy.get(
   *   'example-bucket',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  get(bucketName: string, params: SippyGetParams, options?: RequestOptions): APIPromise<Sippy> {
    const { account_id, 'cf-r2-jurisdiction': cfR2Jurisdiction } = params;
    return (
      this._client.get(path`/accounts/${account_id}/r2/buckets/${bucketName}/sippy`, {
        ...options,
        headers: buildHeaders([
          {
            ...(cfR2Jurisdiction?.toString() != null ?
              { 'cf-r2-jurisdiction': cfR2Jurisdiction?.toString() }
            : undefined),
          },
          options?.headers,
        ]),
      }) as APIPromise<{ result: Sippy }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class SippyResource extends BaseSippyResource {}

export type Provider = 'r2';

export type ProviderParam = 'r2';

export interface Sippy {
  /**
   * Details about the configured destination bucket.
   */
  destination?: Sippy.Destination;

  /**
   * State of Sippy for this bucket.
   */
  enabled?: boolean;

  /**
   * Details about the configured source bucket.
   */
  source?: Sippy.Source;
}

export namespace Sippy {
  /**
   * Details about the configured destination bucket.
   */
  export interface Destination {
    /**
     * ID of the Cloudflare API token used when writing objects to this bucket.
     */
    accessKeyId?: string;

    account?: string;

    /**
     * Name of the bucket on the provider.
     */
    bucket?: string;

    provider?: SippyAPI.Provider;
  }

  /**
   * Details about the configured source bucket.
   */
  export interface Source {
    /**
     * Name of the bucket on the provider (AWS, GCS only).
     */
    bucket?: string | null;

    /**
     * S3-compatible URL (Generic S3-compatible providers only).
     */
    bucketUrl?: string | null;

    /**
     * Name of the Azure Blob Storage container (Azure only).
     */
    container?: string | null;

    provider?: 'aws' | 'gcs' | 's3' | 'azure';

    /**
     * Region where the bucket resides (AWS only).
     */
    region?: string | null;
  }
}

export interface SippyDeleteResponse {
  enabled?: false;
}

export type SippyUpdateParams =
  | SippyUpdateParams.R2EnableSippyAws
  | SippyUpdateParams.R2EnableSippyGcs
  | SippyUpdateParams.R2EnableSippyS3
  | SippyUpdateParams.R2EnableSippyAzure;

export declare namespace SippyUpdateParams {
  export interface R2EnableSippyAws {
    /**
     * Path param: Cloudflare account ID that owns the R2 resource.
     */
    account_id: string;

    /**
     * Body param: R2 bucket to copy objects to.
     */
    destination?: R2EnableSippyAws.Destination;

    /**
     * Body param: AWS S3 bucket to copy objects from.
     */
    source?: R2EnableSippyAws.Source;

    /**
     * Header param: Jurisdiction where objects in this bucket are guaranteed to be
     * stored.
     */
    'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
  }

  export namespace R2EnableSippyAws {
    /**
     * R2 bucket to copy objects to.
     */
    export interface Destination {
      /**
       * ID of a Cloudflare API token. This is the value labelled "Access Key ID" when
       * creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      accessKeyId?: string;

      provider?: SippyAPI.ProviderParam;

      /**
       * Value of a Cloudflare API token. This is the value labelled "Secret Access Key"
       * when creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      secretAccessKey?: string;
    }

    /**
     * AWS S3 bucket to copy objects from.
     */
    export interface Source {
      /**
       * Access Key ID of an IAM credential (ideally scoped to a single S3 bucket).
       */
      accessKeyId?: string;

      /**
       * Name of the AWS S3 bucket.
       */
      bucket?: string;

      provider?: 'aws';

      /**
       * AWS region containing the source S3 bucket.
       */
      region?: string;

      /**
       * Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket).
       */
      secretAccessKey?: string;
    }
  }

  export interface R2EnableSippyGcs {
    /**
     * Path param: Cloudflare account ID that owns the R2 resource.
     */
    account_id: string;

    /**
     * Body param: R2 bucket to copy objects to.
     */
    destination?: R2EnableSippyGcs.Destination;

    /**
     * Body param: GCS bucket to copy objects from.
     */
    source?: R2EnableSippyGcs.Source;

    /**
     * Header param: Jurisdiction where objects in this bucket are guaranteed to be
     * stored.
     */
    'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
  }

  export namespace R2EnableSippyGcs {
    /**
     * R2 bucket to copy objects to.
     */
    export interface Destination {
      /**
       * ID of a Cloudflare API token. This is the value labelled "Access Key ID" when
       * creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      accessKeyId?: string;

      provider?: SippyAPI.ProviderParam;

      /**
       * Value of a Cloudflare API token. This is the value labelled "Secret Access Key"
       * when creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      secretAccessKey?: string;
    }

    /**
     * GCS bucket to copy objects from.
     */
    export interface Source {
      /**
       * Name of the GCS bucket.
       */
      bucket?: string;

      /**
       * Client email of an IAM credential (ideally scoped to a single GCS bucket).
       */
      clientEmail?: string;

      /**
       * Private Key of an IAM credential (ideally scoped to a single GCS bucket).
       */
      privateKey?: string;

      provider?: 'gcs';
    }
  }

  export interface R2EnableSippyS3 {
    /**
     * Path param: Cloudflare account ID that owns the R2 resource.
     */
    account_id: string;

    /**
     * Body param: R2 bucket to copy objects to.
     */
    destination?: R2EnableSippyS3.Destination;

    /**
     * Body param: General S3-compatible provider to copy objects from.
     */
    source?: R2EnableSippyS3.Source;

    /**
     * Header param: Jurisdiction where objects in this bucket are guaranteed to be
     * stored.
     */
    'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
  }

  export namespace R2EnableSippyS3 {
    /**
     * R2 bucket to copy objects to.
     */
    export interface Destination {
      /**
       * ID of a Cloudflare API token. This is the value labelled "Access Key ID" when
       * creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      accessKeyId?: string;

      provider?: SippyAPI.ProviderParam;

      /**
       * Value of a Cloudflare API token. This is the value labelled "Secret Access Key"
       * when creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      secretAccessKey?: string;
    }

    /**
     * General S3-compatible provider to copy objects from.
     */
    export interface Source {
      /**
       * Access Key ID of an IAM credential (ideally scoped to a single S3 bucket).
       */
      accessKeyId?: string;

      /**
       * URL to the S3-compatible API of the bucket.
       */
      bucketUrl?: string;

      provider?: 's3';

      /**
       * Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket).
       */
      secretAccessKey?: string;
    }
  }

  export interface R2EnableSippyAzure {
    /**
     * Path param: Cloudflare account ID that owns the R2 resource.
     */
    account_id: string;

    /**
     * Body param: R2 bucket to copy objects to.
     */
    destination?: R2EnableSippyAzure.Destination;

    /**
     * Body param: Azure Blob Storage container to copy objects from.
     */
    source?: R2EnableSippyAzure.Source;

    /**
     * Header param: Jurisdiction where objects in this bucket are guaranteed to be
     * stored.
     */
    'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
  }

  export namespace R2EnableSippyAzure {
    /**
     * R2 bucket to copy objects to.
     */
    export interface Destination {
      /**
       * ID of a Cloudflare API token. This is the value labelled "Access Key ID" when
       * creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      accessKeyId?: string;

      provider?: SippyAPI.ProviderParam;

      /**
       * Value of a Cloudflare API token. This is the value labelled "Secret Access Key"
       * when creating an API. token from the
       * [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
       *
       * Sippy will use this token when writing objects to R2, so it is best to scope
       * this token to the bucket you're enabling Sippy for.
       */
      secretAccessKey?: string;
    }

    /**
     * Azure Blob Storage container to copy objects from.
     */
    export interface Source {
      /**
       * Access key for the Azure Storage account. Mutually exclusive with sasToken.
       */
      accountKey?: string;

      /**
       * Name of the Azure Storage account.
       */
      accountName?: string;

      /**
       * Name of the Azure Blob Storage container.
       */
      container?: string;

      provider?: 'azure';

      /**
       * Shared Access Signature token for the Azure Storage account. Mutually exclusive
       * with accountKey.
       */
      sasToken?: string;
    }
  }
}

export interface SippyDeleteParams {
  /**
   * Path param: Cloudflare account ID that owns the R2 resource.
   */
  account_id: string;

  /**
   * Header param: Jurisdiction where objects in this bucket are guaranteed to be
   * stored.
   */
  'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
}

export interface SippyGetParams {
  /**
   * Path param: Cloudflare account ID that owns the R2 resource.
   */
  account_id: string;

  /**
   * Header param: Jurisdiction where objects in this bucket are guaranteed to be
   * stored.
   */
  'cf-r2-jurisdiction'?: 'default' | 'eu' | 'us' | 'fedramp' | 'fedramp-high';
}

export declare namespace SippyResource {
  export {
    type Provider as Provider,
    type Sippy as Sippy,
    type SippyDeleteResponse as SippyDeleteResponse,
    type SippyUpdateParams as SippyUpdateParams,
    type SippyDeleteParams as SippyDeleteParams,
    type SippyGetParams as SippyGetParams,
  };
}