Class Files

constructor

• new Files(options?: SDKOptions): Files

  Parameters

  • options: SDKOptions = {}

  Returns Files

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

list

• list(
      environment: string,
      path: string,
      params?: GetEnvironmentFilesParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<GetEnvironmentFilesResponse>

  Retrieves file metadata or directory contents from an environment's snapshot. To download file contents directly, pass ?alt=media or use the files.download helper.

  Parameters

  • environment: string
  • path: string
  • Optionalparams: GetEnvironmentFilesParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<GetEnvironmentFilesResponse>