File stash downloads and stricter prop values (#173)

* Add new API to download files from a file stash * Specify the possible prop values (instead of `unknown`) --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Jay Vercellone <jay@pipedream.com>

Author: fern-api[bot]

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@pipedream/sdk",
- "version": "2.0.5",
+ "version": "2.0.6",
  "private": false,
  "repository": "github:PipedreamHQ/pipedream-sdk-typescript",
  "type": "commonjs",

src/api/resources/fileStash/client/Client.ts

@@ -0,0 +1,140 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as Pipedream from "../../../index.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as errors from "../../../../errors/index.js";
+
+export declare namespace FileStash {
+ export interface Options {
+ environment?: core.Supplier<environments.PipedreamEnvironment | string>;
+ /** Specify a custom URL to connect the client to. */
+ baseUrl?: core.Supplier<string>;
+ projectId: string;
+ token?: core.Supplier<core.BearerToken | undefined>;
+ /** Override the x-pd-environment header */
+ projectEnvironment?: core.Supplier<Pipedream.ProjectEnvironment | undefined>;
+ /** Additional headers to include in requests. */
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+ }
+
+ export interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
+ timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
+ maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the x-pd-environment header */
+ projectEnvironment?: Pipedream.ProjectEnvironment | undefined;
+ /** Additional query string parameters to include in the request. */
+ queryParams?: Record<string, unknown>;
+ /** Additional headers to include in the request. */
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+ }
+}
+
+export class FileStash {
+ protected readonly _options: FileStash.Options;
+
+ constructor(_options: FileStash.Options) {
+ this._options = _options;
+ }
+
+ /**
+ * Download a file from File Stash
+ *
+ * @param {Pipedream.FileStashDownloadFileRequest} request
+ * @param {FileStash.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link Pipedream.TooManyRequestsError}
+ *
+ * @example
+ * await client.fileStash.downloadFile({
+ * s3Key: "s3_key"
+ * })
+ */
+ public downloadFile(
+ request: Pipedream.FileStashDownloadFileRequest,
+ requestOptions?: FileStash.RequestOptions,
+ ): core.HttpResponsePromise<void> {
+ return core.HttpResponsePromise.fromPromise(this.__downloadFile(request, requestOptions));
+ }
+
+ private async __downloadFile(
+ request: Pipedream.FileStashDownloadFileRequest,
+ requestOptions?: FileStash.RequestOptions,
+ ): Promise<core.WithRawResponse<void>> {
+ const { s3Key } = request;
+ const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
+ _queryParams["s3_key"] = s3Key;
+ let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+ this._options?.headers,
+ mergeOnlyDefinedHeaders({
+ Authorization: await this._getAuthorizationHeader(),
+ "x-pd-environment": requestOptions?.projectEnvironment ?? this._options?.projectEnvironment,
+ }),
+ requestOptions?.headers,
+ );
+ const _response = await core.fetcher({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)) ??
+ environments.PipedreamEnvironment.Prod,
+ `v1/connect/${encodeURIComponent(this._options.projectId)}/file_stash/download`,
+ ),
+ method: "GET",
+ headers: _headers,
+ queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
+ timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+ maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ });
+ if (_response.ok) {
+ return { data: undefined, rawResponse: _response.rawResponse };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 429:
+ throw new Pipedream.TooManyRequestsError(_response.error.body, _response.rawResponse);
+ default:
+ throw new errors.PipedreamError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ switch (_response.error.reason) {
+ case "non-json":
+ throw new errors.PipedreamError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.rawBody,
+ rawResponse: _response.rawResponse,
+ });
+ case "timeout":
+ throw new errors.PipedreamTimeoutError(
+ "Timeout exceeded when calling GET /v1/connect/{project_id}/file_stash/download.",
+ );
+ case "unknown":
+ throw new errors.PipedreamError({
+ message: _response.error.errorMessage,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ protected async _getAuthorizationHeader(): Promise<string | undefined> {
+ const bearer = await core.Supplier.get(this._options.token);
+ if (bearer != null) {
+ return `Bearer ${bearer}`;
+ }
+
+ return undefined;
+ }
+}

src/api/resources/fileStash/client/index.ts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

src/api/resources/fileStash/client/requests/FileStashDownloadFileRequest.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ * {
+ * s3Key: "s3_key"
+ * }
+ */
+export interface FileStashDownloadFileRequest {
+ s3Key: string;
+}

src/api/resources/fileStash/client/requests/index.ts

@@ -0,0 +1 @@
+export { type FileStashDownloadFileRequest } from "./FileStashDownloadFileRequest.js";

src/api/resources/fileStash/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

src/api/resources/index.ts

@@ -7,6 +7,7 @@ export * as components from "./components/index.js";
 export * as actions from "./actions/index.js";
 export * as triggers from "./triggers/index.js";
 export * as deployedTriggers from "./deployedTriggers/index.js";
+export * as fileStash from "./fileStash/index.js";
 export * as projects from "./projects/index.js";
 export * as proxy from "./proxy/index.js";
 export * as tokens from "./tokens/index.js";
@@ -18,6 +19,7 @@ export * from "./components/client/requests/index.js";
 export * from "./actions/client/requests/index.js";
 export * from "./triggers/client/requests/index.js";
 export * from "./deployedTriggers/client/requests/index.js";
+export * from "./fileStash/client/requests/index.js";
 export * from "./proxy/client/requests/index.js";
 export * from "./tokens/client/requests/index.js";
 export * from "./oauthTokens/client/requests/index.js";

src/api/types/PropOption.ts

@@ -2,11 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
+import * as Pipedream from "../index.js";
+
 /**
  * A configuration option for a component's prop
  */
 export interface PropOption {
  /** The human-readable label for the option */
  label: string;
- value?: unknown;
+ value?: Pipedream.PropOptionValue;
 }

src/api/types/PropOptionValue.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * The value of a prop option
+ */
+export type PropOptionValue = string | number | boolean;

src/api/types/index.ts

@@ -81,6 +81,7 @@ export * from "./ProjectEnvironment.js";
 export * from "./ProjectInfoResponse.js";
 export * from "./ProjectInfoResponseApp.js";
 export * from "./PropOption.js";
+export * from "./PropOptionValue.js";
 export * from "./PropOptionNested.js";
 export * from "./ProxyResponse.js";
 export * from "./ReloadPropsOpts.js";