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/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;
4 changes: 3 additions & 1 deletion 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 @@ -15,7 +17,7 @@
/** Whether this operation should block until completion */
blocking?: boolean;
/** The configured properties for the component */
configuredProps?: Record<string, unknown>;
configuredProps?: Record<string, Pipedream.ConfigurePropOptsConfiguredPropsValue>;

Check failure on line 20 in src/api/types/ConfigurePropOpts.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 'ConfigurePropOptsConfiguredPropsValue'.
/** The ID for dynamic props */
dynamicPropsId?: string;
/** Page number for paginated results */
Expand Down
15 changes: 15 additions & 0 deletions src/api/types/ConfigurePropOptsConfiguredPropsValue.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 ConfigurePropOptsConfiguredPropsValue =
| unknown
| Pipedream.ConfiguredPropApp

Check failure on line 9 in src/api/types/ConfigurePropOptsConfiguredPropsValue.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 'ConfiguredPropApp'. Did you mean 'ConfigurablePropApp'?
| Pipedream.ConfiguredPropSql

Check failure on line 10 in src/api/types/ConfigurePropOptsConfiguredPropsValue.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 'ConfiguredPropSql'. Did you mean 'ConfigurablePropSql'?
| boolean
| number
| Record<string, unknown>
| string
| string[];
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'.
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;
}
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;

Check failure on line 11 in src/api/types/Observation.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 '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;
}
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 @@
* Response from reloading component props
*/
export interface ReloadPropsResponse {
/** Any logs produced during the configuration of the prop */
observations?: Record<string, unknown>;
observations?: Pipedream.Observation[];

Check failure on line 11 in src/api/types/ReloadPropsResponse.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'.
/** Any errors that occurred during configuration */
errors?: string[];
dynamicProps?: Pipedream.DynamicProps;
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;
}
5 changes: 3 additions & 2 deletions src/serialization/types/ConfigurePropOpts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import * as serializers from "../index.js";
import * as Pipedream from "../../api/index.js";
import * as core from "../../core/index.js";
import { ConfigurePropOptsConfiguredPropsValue } from "./ConfigurePropOptsConfiguredPropsValue.js";

export const ConfigurePropOpts: core.serialization.ObjectSchema<
serializers.ConfigurePropOpts.Raw,
Expand All @@ -16,7 +17,7 @@ export const ConfigurePropOpts: core.serialization.ObjectSchema<
blocking: core.serialization.boolean().optional(),
configuredProps: core.serialization.property(
"configured_props",
core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
core.serialization.record(core.serialization.string(), ConfigurePropOptsConfiguredPropsValue).optional(),
),
dynamicPropsId: core.serialization.property("dynamic_props_id", core.serialization.string().optional()),
page: core.serialization.number().optional(),
Expand All @@ -33,7 +34,7 @@ export declare namespace ConfigurePropOpts {
external_user_id: string;
prop_name: string;
blocking?: boolean | null;
configured_props?: Record<string, unknown> | null;
configured_props?: Record<string, ConfigurePropOptsConfiguredPropsValue.Raw> | null;
dynamic_props_id?: string | null;
page?: number | null;
prev_context?: Record<string, unknown> | null;
Expand Down
35 changes: 35 additions & 0 deletions src/serialization/types/ConfigurePropOptsConfiguredPropsValue.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/**
* 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";
import { ConfiguredPropApp } from "./ConfiguredPropApp.js";
import { ConfiguredPropSql } from "./ConfiguredPropSql.js";

export const ConfigurePropOptsConfiguredPropsValue: core.serialization.Schema<
serializers.ConfigurePropOptsConfiguredPropsValue.Raw,
Pipedream.ConfigurePropOptsConfiguredPropsValue
> = core.serialization.undiscriminatedUnion([
core.serialization.unknown(),
ConfiguredPropApp,
ConfiguredPropSql,
core.serialization.boolean(),
core.serialization.number(),
core.serialization.record(core.serialization.string(), core.serialization.unknown()),
core.serialization.string(),
core.serialization.list(core.serialization.string()),
]);

export declare namespace ConfigurePropOptsConfiguredPropsValue {
export type Raw =
| unknown
| ConfiguredPropApp.Raw
| ConfiguredPropSql.Raw
| boolean
| number
| Record<string, unknown>
| string
| string[];
}
11 changes: 6 additions & 5 deletions src/serialization/types/ConfigurePropResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,28 @@
import * as serializers from "../index.js";
import * as Pipedream from "../../api/index.js";
import * as core from "../../core/index.js";
import { PropOption } from "./PropOption.js";
import { ConfigurePropResponseOptionsItem } from "./ConfigurePropResponseOptionsItem.js";
import { Observation } from "./Observation.js";

export const ConfigurePropResponse: core.serialization.ObjectSchema<
serializers.ConfigurePropResponse.Raw,
Pipedream.ConfigurePropResponse
> = core.serialization.object({
options: core.serialization.list(PropOption).optional(),
options: core.serialization.list(ConfigurePropResponseOptionsItem).optional(),
stringOptions: core.serialization.property(
"string_options",
core.serialization.list(core.serialization.string()).optional(),
),
observations: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
observations: core.serialization.list(Observation).optional(),
context: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
errors: core.serialization.list(core.serialization.string()).optional(),
});

export declare namespace ConfigurePropResponse {
export interface Raw {
options?: PropOption.Raw[] | null;
options?: ConfigurePropResponseOptionsItem.Raw[] | null;
string_options?: string[] | null;
observations?: Record<string, unknown> | null;
observations?: Observation.Raw[] | null;
context?: Record<string, unknown> | null;
errors?: string[] | null;
}
Expand Down
18 changes: 18 additions & 0 deletions src/serialization/types/ConfigurePropResponseOptionsItem.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 serializers from "../index.js";
import * as Pipedream from "../../api/index.js";
import * as core from "../../core/index.js";
import { PropOption } from "./PropOption.js";
import { PropOptionNested } from "./PropOptionNested.js";

export const ConfigurePropResponseOptionsItem: core.serialization.Schema<
serializers.ConfigurePropResponseOptionsItem.Raw,
Pipedream.ConfigurePropResponseOptionsItem
> = core.serialization.undiscriminatedUnion([PropOption, PropOptionNested]);

export declare namespace ConfigurePropResponseOptionsItem {
export type Raw = PropOption.Raw | PropOptionNested.Raw;
}
21 changes: 21 additions & 0 deletions src/serialization/types/ConfiguredPropApp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* 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";
import { AccountId } from "./AccountId.js";

export const ConfiguredPropApp: core.serialization.ObjectSchema<
serializers.ConfiguredPropApp.Raw,
Pipedream.ConfiguredPropApp
> = core.serialization.object({
authProvisionId: AccountId.optional(),
});

export declare namespace ConfiguredPropApp {
export interface Raw {
authProvisionId?: AccountId.Raw | null;
}
}
26 changes: 26 additions & 0 deletions src/serialization/types/ConfiguredPropSql.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/**
* 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 ConfiguredPropSql: core.serialization.ObjectSchema<
serializers.ConfiguredPropSql.Raw,
Pipedream.ConfiguredPropSql
> = core.serialization.object({
value: core.serialization.string().optional(),
query: core.serialization.string().optional(),
params: core.serialization.list(core.serialization.string()).optional(),
usePreparedStatements: core.serialization.boolean().optional(),
});

export declare namespace ConfiguredPropSql {
export interface Raw {
value?: string | null;
query?: string | null;
params?: string[] | null;
usePreparedStatements?: boolean | null;
}
}
25 changes: 25 additions & 0 deletions src/serialization/types/Observation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/**
* 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";
import { ObservationError } from "./ObservationError.js";

export const Observation: core.serialization.ObjectSchema<serializers.Observation.Raw, Pipedream.Observation> =
core.serialization.object({
err: ObservationError.optional(),
k: core.serialization.string(),
msg: core.serialization.string().optional(),
ts: core.serialization.number(),
});

export declare namespace Observation {
export interface Raw {
err?: ObservationError.Raw | null;
k: string;
msg?: string | null;
ts: number;
}
}
Loading