Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPipedreamHQ%2Fpipedream-sdk-typescript)
[![npm shield](https://img.shields.io/npm/v/@pipedream/sdk)](https://www.npmjs.com/package/@pipedream/sdk)

The Pipedream TypeScript library provides convenient access to the Pipedream API from TypeScript.
The Pipedream TypeScript library provides convenient access to the Pipedream APIs from TypeScript.

## Installation

Expand Down
3 changes: 1 addition & 2 deletions src/api/resources/actions/client/requests/RunActionOpts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
id: string;
/** The external user ID */
externalUserId: string;
/** The configured properties for the action */
configuredProps?: Record<string, unknown>;
configuredProps?: Pipedream.ConfiguredProp;

Check failure on line 19 in src/api/resources/actions/client/requests/RunActionOpts.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'ConfiguredProp'. Did you mean 'ConfigurableProp'?
/** The ID for dynamic props */
dynamicPropsId?: string;
stashId?: Pipedream.RunActionOptsStashId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../../../../index.js";

/**
* @example
* {
Expand All @@ -13,8 +15,7 @@
externalUserId: string;
/** Whether the trigger should be active */
active?: boolean;
/** The configured properties for the trigger */
configuredProps?: Record<string, unknown>;
configuredProps?: Pipedream.ConfiguredProp;

Check failure on line 18 in src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'ConfiguredProp'. Did you mean 'ConfigurableProp'?
/** The name of the trigger */
name?: string;
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../../../../index.js";

/**
* @example
* {
Expand All @@ -14,8 +16,7 @@
id: string;
/** The external user ID */
externalUserId: string;
/** The configured properties for the trigger */
configuredProps?: Record<string, unknown>;
configuredProps?: Pipedream.ConfiguredProp;

Check failure on line 19 in src/api/resources/triggers/client/requests/DeployTriggerOpts.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'ConfiguredProp'. Did you mean 'ConfigurableProp'?
/** The ID for dynamic props */
dynamicPropsId?: string;
/** Optional webhook URL to receive trigger events */
Expand Down
3 changes: 1 addition & 2 deletions src/api/types/Account.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
* End user account data, returned from the API.
*/
export interface Account {
/** The unique ID of the account. */
id: string;
id: Pipedream.AccountId;

Check failure on line 11 in src/api/types/Account.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'AccountId'. Did you mean 'Account'?
/** The custom name of the account if set. */
name?: string;
/** The external ID associated with the account. */
Expand Down
8 changes: 8 additions & 0 deletions src/api/types/AccountId.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

/**
* The unique ID of the account.
*/
export type AccountId = string;
5 changes: 3 additions & 2 deletions src/api/types/ConfigurePropOpts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

/**
* Request options for configuring a component's prop
*/
Expand All @@ -14,8 +16,7 @@
propName: string;
/** Whether this operation should block until completion */
blocking?: boolean;
/** The configured properties for the component */
configuredProps?: Record<string, unknown>;
configuredProps?: Pipedream.ConfiguredProp;

Check failure on line 19 in src/api/types/ConfigurePropOpts.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'ConfiguredProp'. Did you mean 'ConfigurableProp'?
/** The ID for dynamic props */
dynamicPropsId?: string;
/** Page number for paginated results */
Expand Down
5 changes: 2 additions & 3 deletions src/api/types/ConfigurePropResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@
*/
export interface ConfigurePropResponse {
/** Available options (with labels) for the configured prop */
options?: Pipedream.PropOption[];
options?: Pipedream.ConfigurePropResponseOptionsItem[];

Check failure on line 12 in src/api/types/ConfigurePropResponse.ts

View workflow job for this annotation

GitHub Actions / compile

Namespace '"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member 'ConfigurePropResponseOptionsItem'.
/** Available options for the configured prop */
stringOptions?: string[];
/** Any logs produced during the configuration of the prop */
observations?: Record<string, unknown>;
observations?: Pipedream.Observation[];

Check failure on line 15 in src/api/types/ConfigurePropResponse.ts

View workflow job for this annotation

GitHub Actions / compile

Namespace '"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member 'Observation'.
/** New context after configuring the prop */
context?: Record<string, unknown>;
/** Any errors that occurred during configuration */
Expand Down
7 changes: 7 additions & 0 deletions src/api/types/ConfigurePropResponseOptionsItem.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

export type ConfigurePropResponseOptionsItem = Pipedream.PropOption | Pipedream.PropOptionNested;

Check failure on line 7 in src/api/types/ConfigurePropResponseOptionsItem.ts

View workflow job for this annotation

GitHub Actions / compile

Namespace '"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member 'PropOptionNested'.
10 changes: 10 additions & 0 deletions src/api/types/ConfiguredProp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

/**
* The configured properties of the component
*/
export type ConfiguredProp = Record<string, Pipedream.ConfiguredPropValue>;

Check failure on line 10 in src/api/types/ConfiguredProp.ts

View workflow job for this annotation

GitHub Actions / compile

Namespace '"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member 'ConfiguredPropValue'.
9 changes: 9 additions & 0 deletions src/api/types/ConfiguredPropApp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

export interface ConfiguredPropApp {
authProvisionId?: Pipedream.AccountId;

Check failure on line 8 in src/api/types/ConfiguredPropApp.ts

View workflow job for this annotation

GitHub Actions / compile

'"/home/runner/work/pipedream-sdk-typescript/pipedream-sdk-typescript/src/api/index"' has no exported member named 'AccountId'. Did you mean 'Account'?
}
14 changes: 14 additions & 0 deletions src/api/types/ConfiguredPropSql.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

export interface ConfiguredPropSql {
/** The raw SQL query, as provided by the user */
value?: string;
/** The SQL query to execute */
query?: string;
/** The list of parameters for the prepared statement */
params?: string[];
/** Whether to use prepared statements for the query or not */
usePreparedStatements?: boolean;
}
15 changes: 15 additions & 0 deletions src/api/types/ConfiguredPropValue.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

export type ConfiguredPropValue =
| unknown
| Pipedream.ConfiguredPropApp
| Pipedream.ConfiguredPropSql
| boolean
| number
| Record<string, unknown>
| string
| string[];
3 changes: 1 addition & 2 deletions src/api/types/DeployedComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ export interface DeployedComponent {
componentId: string;
/** The configurable properties of the component */
configurableProps: Pipedream.ConfigurableProp[];
/** The configured properties of the component */
configuredProps: Record<string, unknown>;
configuredProps: Pipedream.ConfiguredProp;
/** Whether the deployed component is active */
active: boolean;
/** The timestamp when the component was deployed (epoch milliseconds) */
Expand Down
18 changes: 18 additions & 0 deletions src/api/types/Observation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

/**
* Any logs produced during the configuration of the prop
*/
export interface Observation {
err?: Pipedream.ObservationError;
/** The source of the log (e.g. `console.log`) */
k: string;
/** The log message */
msg?: string;
/** The time at which the log was produced, as milliseconds since the epoch */
ts: number;
}
15 changes: 15 additions & 0 deletions src/api/types/ObservationError.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

/**
* Details about an observed error message
*/
export interface ObservationError {
/** The name of the error/exception */
name?: string;
/** The error message */
message?: string;
/** The stack trace of the error */
stack?: string;
}
12 changes: 12 additions & 0 deletions src/api/types/PropOptionNested.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/**
* 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 (nested under `__lv`)
*/
export interface PropOptionNested {
lv: Pipedream.PropOption;
}
5 changes: 3 additions & 2 deletions src/api/types/ReloadPropsOpts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* This file was auto-generated by Fern from our API Definition.
*/

import * as Pipedream from "../index.js";

/**
* Request options for reloading a component's props when dealing with dynamic props
*/
Expand All @@ -12,8 +14,7 @@ export interface ReloadPropsOpts {
externalUserId: string;
/** Whether this operation should block until completion */
blocking?: boolean;
/** The configured properties for the component */
configuredProps?: Record<string, unknown>;
configuredProps?: Pipedream.ConfiguredProp;
/** The ID for dynamic props */
dynamicPropsId?: string;
}
3 changes: 1 addition & 2 deletions src/api/types/ReloadPropsResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ import * as Pipedream from "../index.js";
* Response from reloading component props
*/
export interface ReloadPropsResponse {
/** Any logs produced during the configuration of the prop */
observations?: Record<string, unknown>;
observations?: Pipedream.Observation[];
/** Any errors that occurred during configuration */
errors?: string[];
dynamicProps?: Pipedream.DynamicProps;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,15 @@
import * as serializers from "../../../../index.js";
import * as Pipedream from "../../../../../api/index.js";
import * as core from "../../../../../core/index.js";
import { ConfiguredProp } from "../../../../types/ConfiguredProp.js";
import { RunActionOptsStashId } from "../../../../types/RunActionOptsStashId.js";
import { ConfiguredPropValue } from "../../../../types/ConfiguredPropValue.js";

export const RunActionOpts: core.serialization.Schema<serializers.RunActionOpts.Raw, Pipedream.RunActionOpts> =
core.serialization.object({
id: core.serialization.string(),
externalUserId: core.serialization.property("external_user_id", core.serialization.string()),
configuredProps: core.serialization.property(
"configured_props",
core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
),
configuredProps: core.serialization.property("configured_props", ConfiguredProp.optional()),
dynamicPropsId: core.serialization.property("dynamic_props_id", core.serialization.string().optional()),
stashId: core.serialization.property("stash_id", RunActionOptsStashId.optional()),
});
Expand All @@ -23,7 +22,7 @@ export declare namespace RunActionOpts {
export interface Raw {
id: string;
external_user_id: string;
configured_props?: Record<string, unknown> | null;
configured_props?: ConfiguredProp.Raw | null;
dynamic_props_id?: string | null;
stash_id?: RunActionOptsStashId.Raw | null;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,22 @@
import * as serializers from "../../../../index.js";
import * as Pipedream from "../../../../../api/index.js";
import * as core from "../../../../../core/index.js";
import { ConfiguredProp } from "../../../../types/ConfiguredProp.js";
import { ConfiguredPropValue } from "../../../../types/ConfiguredPropValue.js";

export const UpdateTriggerOpts: core.serialization.Schema<
serializers.UpdateTriggerOpts.Raw,
Omit<Pipedream.UpdateTriggerOpts, "externalUserId">
> = core.serialization.object({
active: core.serialization.boolean().optional(),
configuredProps: core.serialization.property(
"configured_props",
core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
),
configuredProps: core.serialization.property("configured_props", ConfiguredProp.optional()),
name: core.serialization.string().optional(),
});

export declare namespace UpdateTriggerOpts {
export interface Raw {
active?: boolean | null;
configured_props?: Record<string, unknown> | null;
configured_props?: ConfiguredProp.Raw | null;
name?: string | null;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@
import * as serializers from "../../../../index.js";
import * as Pipedream from "../../../../../api/index.js";
import * as core from "../../../../../core/index.js";
import { ConfiguredProp } from "../../../../types/ConfiguredProp.js";
import { ConfiguredPropValue } from "../../../../types/ConfiguredPropValue.js";

export const DeployTriggerOpts: core.serialization.Schema<
serializers.DeployTriggerOpts.Raw,
Pipedream.DeployTriggerOpts
> = core.serialization.object({
id: core.serialization.string(),
externalUserId: core.serialization.property("external_user_id", core.serialization.string()),
configuredProps: core.serialization.property(
"configured_props",
core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
),
configuredProps: core.serialization.property("configured_props", ConfiguredProp.optional()),
dynamicPropsId: core.serialization.property("dynamic_props_id", core.serialization.string().optional()),
webhookUrl: core.serialization.property("webhook_url", core.serialization.string().optional()),
});
Expand All @@ -24,7 +23,7 @@ export declare namespace DeployTriggerOpts {
export interface Raw {
id: string;
external_user_id: string;
configured_props?: Record<string, unknown> | null;
configured_props?: ConfiguredProp.Raw | null;
dynamic_props_id?: string | null;
webhook_url?: string | null;
}
Expand Down
5 changes: 3 additions & 2 deletions src/serialization/types/Account.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
import * as serializers from "../index.js";
import * as Pipedream from "../../api/index.js";
import * as core from "../../core/index.js";
import { AccountId } from "./AccountId.js";
import { App } from "./App.js";

export const Account: core.serialization.ObjectSchema<serializers.Account.Raw, Pipedream.Account> =
core.serialization.object({
id: core.serialization.string(),
id: AccountId,
name: core.serialization.string().optional(),
externalId: core.serialization.property("external_id", core.serialization.string().optional()),
healthy: core.serialization.boolean().optional(),
Expand All @@ -26,7 +27,7 @@ export const Account: core.serialization.ObjectSchema<serializers.Account.Raw, P

export declare namespace Account {
export interface Raw {
id: string;
id: AccountId.Raw;
name?: string | null;
external_id?: string | null;
healthy?: boolean | null;
Expand Down
14 changes: 14 additions & 0 deletions src/serialization/types/AccountId.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* This file was auto-generated by Fern from our API Definition.
*/

import * as serializers from "../index.js";
import * as Pipedream from "../../api/index.js";
import * as core from "../../core/index.js";

export const AccountId: core.serialization.Schema<serializers.AccountId.Raw, Pipedream.AccountId> =
core.serialization.string();

export declare namespace AccountId {
export type Raw = string;
}
Loading