diff --git a/README.md b/README.md index 32cdc9d..195154b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,26 @@ The Pipedream TypeScript library provides convenient access to the Pipedream APIs from TypeScript. +## Table of Contents + +- [Installation](#installation) +- [Reference](#reference) +- [Migration From V 1 X](#migration-from-v-1-x) +- [Usage](#usage) +- [Request and Response Types](#request-and-response-types) +- [Exception Handling](#exception-handling) +- [Binary Response](#binary-response) +- [Pagination](#pagination) +- [Advanced](#advanced) + - [Additional Headers](#additional-headers) + - [Additional Query String Parameters](#additional-query-string-parameters) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Aborting Requests](#aborting-requests) + - [Access Raw Response Data](#access-raw-response-data) + - [Runtime Compatibility](#runtime-compatibility) +- [Contributing](#contributing) + ## Installation ```sh @@ -34,7 +54,7 @@ await client.actions.run({ }); ``` -## Request And Response Types +## Request and Response Types The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace: diff --git a/package.json b/package.json index de4dd44..fadf8df 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@pipedream/sdk", - "version": "2.2.0", + "version": "2.2.1", "private": false, "repository": "github:PipedreamHQ/pipedream-sdk-typescript", "type": "commonjs", @@ -10,11 +10,6 @@ "exports": { ".": { "types": "./dist/cjs/index.d.ts", - "browser": { - "types": "./dist/esm/browser/index.d.mts", - "import": "./dist/esm/browser/index.mjs", - "default": "./dist/esm/browser/index.mjs" - }, "import": { "types": "./dist/esm/index.d.mts", "default": "./dist/esm/index.mjs" @@ -25,18 +20,6 @@ }, "default": "./dist/cjs/index.js" }, - "./browser": { - "types": "./dist/esm/browser/index.d.mts", - "import": { - "types": "./dist/esm/browser/index.d.mts", - "default": "./dist/esm/browser/index.mjs" - }, - "require": { - "types": "./dist/cjs/browser/index.d.ts", - "default": "./dist/cjs/browser/index.js" - }, - "default": "./dist/esm/browser/index.mjs" - }, "./serialization": { "types": "./dist/cjs/serialization/index.d.ts", "import": { @@ -49,18 +32,6 @@ }, "default": "./dist/cjs/serialization/index.js" }, - "./server": { - "types": "./dist/cjs/index.d.ts", - "import": { - "types": "./dist/esm/index.d.mts", - "default": "./dist/esm/index.mjs" - }, - "require": { - "types": "./dist/cjs/index.d.ts", - "default": "./dist/cjs/index.js" - }, - "default": "./dist/cjs/index.js" - }, "./package.json": "./package.json" }, "files": [ @@ -93,8 +64,6 @@ "@biomejs/biome": "2.2.5" }, "browser": { - "./dist/cjs/wrapper/utils/getBaseUrl.js": "./dist/cjs/wrapper/utils/getBaseUrl.browser.js", - "./dist/esm/wrapper/utils/getBaseUrl.mjs": "./dist/esm/wrapper/utils/getBaseUrl.browser.mjs", "fs": false, "os": false, "path": false, diff --git a/src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts b/src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts index 500728e..a88ccb0 100644 --- a/src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts +++ b/src/api/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts @@ -16,4 +16,6 @@ export interface UpdateTriggerOpts { configuredProps?: Pipedream.ConfiguredProps; /** The name of the trigger */ name?: string; + /** Whether the trigger should emit events during deployment */ + emitOnDeploy?: boolean; } diff --git a/src/api/resources/triggers/client/requests/DeployTriggerOpts.ts b/src/api/resources/triggers/client/requests/DeployTriggerOpts.ts index 6f864a9..cc84f99 100644 --- a/src/api/resources/triggers/client/requests/DeployTriggerOpts.ts +++ b/src/api/resources/triggers/client/requests/DeployTriggerOpts.ts @@ -23,4 +23,6 @@ export interface DeployTriggerOpts { workflowId?: string; /** Optional webhook URL to receive trigger events */ webhookUrl?: string; + /** Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified. */ + emitOnDeploy?: boolean; } diff --git a/src/api/types/ConfigurableProp.ts b/src/api/types/ConfigurableProp.ts index 390eaa2..9ace9cf 100644 --- a/src/api/types/ConfigurableProp.ts +++ b/src/api/types/ConfigurableProp.ts @@ -3,28 +3,108 @@ import type * as Pipedream from "../index.js"; /** - * A configuration or input field for a component. + * A configuration or input field for a component. This is a discriminated union based on the type field. */ -export interface ConfigurableProp { - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - type: Pipedream.ConfigurablePropType; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; +export type ConfigurableProp = + | Pipedream.ConfigurableProp.Alert + | Pipedream.ConfigurableProp.Any + | Pipedream.ConfigurableProp.App + | Pipedream.ConfigurableProp.Boolean + | Pipedream.ConfigurableProp.InterfaceTimer + | Pipedream.ConfigurableProp.InterfaceApphook + | Pipedream.ConfigurableProp.IntegerArray + | Pipedream.ConfigurableProp.InterfaceHttp + | Pipedream.ConfigurableProp.ServiceDb + | Pipedream.ConfigurableProp.Sql + | Pipedream.ConfigurableProp.AirtableBaseId + | Pipedream.ConfigurableProp.AirtableTableId + | Pipedream.ConfigurableProp.AirtableViewId + | Pipedream.ConfigurableProp.AirtableFieldId + | Pipedream.ConfigurableProp.DiscordChannel + | Pipedream.ConfigurableProp.DiscordChannelArray + | Pipedream.ConfigurableProp.Integer + | Pipedream.ConfigurableProp.Object + | Pipedream.ConfigurableProp.String + | Pipedream.ConfigurableProp.StringArray; + +export namespace ConfigurableProp { + export interface Alert extends Pipedream.ConfigurablePropAlert { + type: "alert"; + } + + export interface Any extends Pipedream.ConfigurablePropAny { + type: "any"; + } + + export interface App extends Pipedream.ConfigurablePropApp { + type: "app"; + } + + export interface Boolean extends Pipedream.ConfigurablePropBoolean { + type: "boolean"; + } + + export interface InterfaceTimer extends Pipedream.ConfigurablePropTimer { + type: "$.interface.timer"; + } + + export interface InterfaceApphook extends Pipedream.ConfigurablePropApphook { + type: "$.interface.apphook"; + } + + export interface IntegerArray extends Pipedream.ConfigurablePropIntegerArray { + type: "integer[]"; + } + + export interface InterfaceHttp extends Pipedream.ConfigurablePropHttp { + type: "$.interface.http"; + } + + export interface ServiceDb extends Pipedream.ConfigurablePropDb { + type: "$.service.db"; + } + + export interface Sql extends Pipedream.ConfigurablePropSql { + type: "sql"; + } + + export interface AirtableBaseId extends Pipedream.ConfigurablePropAirtableBaseId { + type: "$.airtable.baseId"; + } + + export interface AirtableTableId extends Pipedream.ConfigurablePropAirtableTableId { + type: "$.airtable.tableId"; + } + + export interface AirtableViewId extends Pipedream.ConfigurablePropAirtableViewId { + type: "$.airtable.viewId"; + } + + export interface AirtableFieldId extends Pipedream.ConfigurablePropAirtableFieldId { + type: "$.airtable.fieldId"; + } + + export interface DiscordChannel extends Pipedream.ConfigurablePropDiscordChannel { + type: "$.discord.channel"; + } + + export interface DiscordChannelArray extends Pipedream.ConfigurablePropDiscordChannelArray { + type: "$.discord.channel[]"; + } + + export interface Integer extends Pipedream.ConfigurablePropInteger { + type: "integer"; + } + + export interface Object extends Pipedream.ConfigurablePropObject { + type: "object"; + } + + export interface String extends Pipedream.ConfigurablePropString { + type: "string"; + } + + export interface StringArray extends Pipedream.ConfigurablePropStringArray { + type: "string[]"; + } } diff --git a/src/api/types/ConfigurablePropAirtableBaseId.ts b/src/api/types/ConfigurablePropAirtableBaseId.ts index 7755a5a..708f25c 100644 --- a/src/api/types/ConfigurablePropAirtableBaseId.ts +++ b/src/api/types/ConfigurablePropAirtableBaseId.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropAirtableBaseId { - type: "$.airtable.baseId"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropAirtableBaseId extends Pipedream.ConfigurablePropBase { /** The name of the app prop that provides Airtable authentication */ appProp: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropAirtableFieldId.ts b/src/api/types/ConfigurablePropAirtableFieldId.ts index 1676649..e1196e8 100644 --- a/src/api/types/ConfigurablePropAirtableFieldId.ts +++ b/src/api/types/ConfigurablePropAirtableFieldId.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropAirtableFieldId { - type: "$.airtable.fieldId"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropAirtableFieldId extends Pipedream.ConfigurablePropBase { /** The name of the prop that provides the Airtable table ID */ tableIdProp: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropAirtableTableId.ts b/src/api/types/ConfigurablePropAirtableTableId.ts index 4d9109c..df5b675 100644 --- a/src/api/types/ConfigurablePropAirtableTableId.ts +++ b/src/api/types/ConfigurablePropAirtableTableId.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropAirtableTableId { - type: "$.airtable.tableId"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropAirtableTableId extends Pipedream.ConfigurablePropBase { /** The name of the prop that provides the Airtable base ID */ baseIdProp: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropAirtableViewId.ts b/src/api/types/ConfigurablePropAirtableViewId.ts index 155aa84..161caa2 100644 --- a/src/api/types/ConfigurablePropAirtableViewId.ts +++ b/src/api/types/ConfigurablePropAirtableViewId.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropAirtableViewId { - type: "$.airtable.viewId"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropAirtableViewId extends Pipedream.ConfigurablePropBase { /** The name of the prop that provides the Airtable table ID */ tableIdProp: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropAlert.ts b/src/api/types/ConfigurablePropAlert.ts index 3f08428..6e9616d 100644 --- a/src/api/types/ConfigurablePropAlert.ts +++ b/src/api/types/ConfigurablePropAlert.ts @@ -2,29 +2,8 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropAlert { - type: "alert"; +export interface ConfigurablePropAlert extends Pipedream.ConfigurablePropBase { alertType?: Pipedream.ConfigurablePropAlertType; /** The content of the alert, which can include HTML or plain text. */ content: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropAny.ts b/src/api/types/ConfigurablePropAny.ts index 7277cfb..41dcbe5 100644 --- a/src/api/types/ConfigurablePropAny.ts +++ b/src/api/types/ConfigurablePropAny.ts @@ -2,28 +2,7 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropAny { - type: "any"; +export interface ConfigurablePropAny extends Pipedream.ConfigurablePropBase { default?: Pipedream.ConfiguredPropValueAny | undefined; options?: Pipedream.ConfigurablePropAnyOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropApp.ts b/src/api/types/ConfigurablePropApp.ts index 600d82c..5997f9b 100644 --- a/src/api/types/ConfigurablePropApp.ts +++ b/src/api/types/ConfigurablePropApp.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropApp { - type: "app"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropApp extends Pipedream.ConfigurablePropBase { /** The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured. */ app: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropApphook.ts b/src/api/types/ConfigurablePropApphook.ts index ae1e0bf..1cc9e24 100644 --- a/src/api/types/ConfigurablePropApphook.ts +++ b/src/api/types/ConfigurablePropApphook.ts @@ -1,7 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropApphook { - type: "$.interface.apphook"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropApphook extends Pipedream.ConfigurablePropBase { /** The name of the app prop that this apphook depends on */ appProp: string; /** List of event names to listen for */ @@ -10,24 +11,4 @@ export interface ConfigurablePropApphook { remote?: boolean; /** Static configuration for the apphook */ static?: unknown[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropBase.ts b/src/api/types/ConfigurablePropBase.ts new file mode 100644 index 0000000..37098e1 --- /dev/null +++ b/src/api/types/ConfigurablePropBase.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * A configuration or input field for a component. + */ +export interface ConfigurablePropBase { + /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ + name: string; + /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ + label?: string; + /** A description of the prop, shown to the user when configuring the component. */ + description?: string; + /** If true, this prop does not need to be specified. */ + optional?: boolean; + /** If true, this prop will be ignored. */ + disabled?: boolean; + /** If true, should not expose this prop to the user */ + hidden?: boolean; + /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ + remoteOptions?: boolean; + /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ + useQuery?: boolean; + /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ + reloadProps?: boolean; + /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ + withLabel?: boolean; +} diff --git a/src/api/types/ConfigurablePropBoolean.ts b/src/api/types/ConfigurablePropBoolean.ts index fd6c9cc..8c0e77f 100644 --- a/src/api/types/ConfigurablePropBoolean.ts +++ b/src/api/types/ConfigurablePropBoolean.ts @@ -2,28 +2,7 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropBoolean { - type: "boolean"; +export interface ConfigurablePropBoolean extends Pipedream.ConfigurablePropBase { default?: Pipedream.ConfiguredPropValueBoolean; options?: Pipedream.ConfigurablePropBooleanOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropDb.ts b/src/api/types/ConfigurablePropDb.ts index 4047086..abe3e04 100644 --- a/src/api/types/ConfigurablePropDb.ts +++ b/src/api/types/ConfigurablePropDb.ts @@ -1,25 +1,5 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropDb { - type: "$.service.db"; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; -} +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropDb extends Pipedream.ConfigurablePropBase {} diff --git a/src/api/types/ConfigurablePropDiscord.ts b/src/api/types/ConfigurablePropDiscord.ts index dc3d7b2..4ea47bd 100644 --- a/src/api/types/ConfigurablePropDiscord.ts +++ b/src/api/types/ConfigurablePropDiscord.ts @@ -1,25 +1,7 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropDiscord { +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropDiscord extends Pipedream.ConfigurablePropBase { type: "$.discord.channel"; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropDiscordChannel.ts b/src/api/types/ConfigurablePropDiscordChannel.ts index 302c506..201a2fb 100644 --- a/src/api/types/ConfigurablePropDiscordChannel.ts +++ b/src/api/types/ConfigurablePropDiscordChannel.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropDiscordChannel { - type: "$.discord.channel"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropDiscordChannel extends Pipedream.ConfigurablePropBase { /** The name of the app prop that provides Discord authentication */ appProp: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropDiscordChannelArray.ts b/src/api/types/ConfigurablePropDiscordChannelArray.ts index c6869dd..3cb3c0a 100644 --- a/src/api/types/ConfigurablePropDiscordChannelArray.ts +++ b/src/api/types/ConfigurablePropDiscordChannelArray.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropDiscordChannelArray { - type: "$.discord.channel[]"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropDiscordChannelArray extends Pipedream.ConfigurablePropBase { /** The name of the app prop that provides Discord authentication */ appProp?: string; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropHttp.ts b/src/api/types/ConfigurablePropHttp.ts index fd1dd12..d567ce0 100644 --- a/src/api/types/ConfigurablePropHttp.ts +++ b/src/api/types/ConfigurablePropHttp.ts @@ -1,27 +1,8 @@ // This file was auto-generated by Fern from our API Definition. -export interface ConfigurablePropHttp { - type: "$.interface.http"; +import type * as Pipedream from "../index.js"; + +export interface ConfigurablePropHttp extends Pipedream.ConfigurablePropBase { /** Whether this HTTP interface allows custom responses */ customResponse?: boolean; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropInteger.ts b/src/api/types/ConfigurablePropInteger.ts index 72d5338..3761601 100644 --- a/src/api/types/ConfigurablePropInteger.ts +++ b/src/api/types/ConfigurablePropInteger.ts @@ -2,8 +2,7 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropInteger { - type: "integer"; +export interface ConfigurablePropInteger extends Pipedream.ConfigurablePropBase { /** The minimum value for this integer prop. */ min?: number; /** The maximum value for this integer prop. */ @@ -11,24 +10,4 @@ export interface ConfigurablePropInteger { default?: Pipedream.ConfiguredPropValueInteger; /** Available integer options */ options?: Pipedream.ConfigurablePropIntegerOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropIntegerArray.ts b/src/api/types/ConfigurablePropIntegerArray.ts index 9cd3335..eaa8fdd 100644 --- a/src/api/types/ConfigurablePropIntegerArray.ts +++ b/src/api/types/ConfigurablePropIntegerArray.ts @@ -2,8 +2,7 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropIntegerArray { - type: "integer[]"; +export interface ConfigurablePropIntegerArray extends Pipedream.ConfigurablePropBase { /** The minimum value for integers in this array */ min?: number; /** The maximum value for integers in this array */ @@ -12,24 +11,4 @@ export interface ConfigurablePropIntegerArray { default?: Pipedream.ConfiguredPropValueInteger[]; /** Available options for the integer array */ options?: Pipedream.ConfigurablePropIntegerArrayOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropObject.ts b/src/api/types/ConfigurablePropObject.ts index f675481..8e7b215 100644 --- a/src/api/types/ConfigurablePropObject.ts +++ b/src/api/types/ConfigurablePropObject.ts @@ -2,28 +2,7 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropObject { - type: "object"; +export interface ConfigurablePropObject extends Pipedream.ConfigurablePropBase { default?: Pipedream.ConfiguredPropValueObject; options?: Pipedream.ConfigurablePropObjectOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropSql.ts b/src/api/types/ConfigurablePropSql.ts index 132a593..ac3e551 100644 --- a/src/api/types/ConfigurablePropSql.ts +++ b/src/api/types/ConfigurablePropSql.ts @@ -2,29 +2,8 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropSql { - type: "sql"; +export interface ConfigurablePropSql extends Pipedream.ConfigurablePropBase { auth?: Pipedream.ConfigurablePropSqlAuth; default?: Pipedream.ConfiguredPropValueSql; options?: Pipedream.ConfigurablePropSqlOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropString.ts b/src/api/types/ConfigurablePropString.ts index 82ecb69..61e725f 100644 --- a/src/api/types/ConfigurablePropString.ts +++ b/src/api/types/ConfigurablePropString.ts @@ -2,30 +2,9 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropString { - type: "string"; +export interface ConfigurablePropString extends Pipedream.ConfigurablePropBase { /** If true, this prop is a secret and should not be displayed in plain text. */ secret?: boolean; default?: Pipedream.ConfiguredPropValueString; options?: Pipedream.ConfigurablePropStringOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropStringArray.ts b/src/api/types/ConfigurablePropStringArray.ts index 42b99ec..246abf0 100644 --- a/src/api/types/ConfigurablePropStringArray.ts +++ b/src/api/types/ConfigurablePropStringArray.ts @@ -2,31 +2,10 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropStringArray { - type: "string[]"; +export interface ConfigurablePropStringArray extends Pipedream.ConfigurablePropBase { /** If true, this prop is a secret and should not be displayed in plain text. */ secret?: boolean; /** The default value for this prop */ default?: Pipedream.ConfiguredPropValueString[]; options?: Pipedream.ConfigurablePropStringArrayOptionsItem[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropTimer.ts b/src/api/types/ConfigurablePropTimer.ts index adeb3cb..e70638e 100644 --- a/src/api/types/ConfigurablePropTimer.ts +++ b/src/api/types/ConfigurablePropTimer.ts @@ -2,30 +2,9 @@ import type * as Pipedream from "../index.js"; -export interface ConfigurablePropTimer { - type: "$.interface.timer"; +export interface ConfigurablePropTimer extends Pipedream.ConfigurablePropBase { static?: Pipedream.ConfigurablePropTimerStatic; default?: Pipedream.ConfigurablePropTimerDefault; /** Available timer configuration options */ options?: (Pipedream.ConfigurablePropTimerOption | undefined)[]; - /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */ - name: string; - /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */ - label?: string; - /** A description of the prop, shown to the user when configuring the component. */ - description?: string; - /** If true, this prop does not need to be specified. */ - optional?: boolean; - /** If true, this prop will be ignored. */ - disabled?: boolean; - /** If true, should not expose this prop to the user */ - hidden?: boolean; - /** If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options */ - remoteOptions?: boolean; - /** If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options */ - useQuery?: boolean; - /** If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one */ - reloadProps?: boolean; - /** If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label */ - withLabel?: boolean; } diff --git a/src/api/types/ConfigurablePropType.ts b/src/api/types/ConfigurablePropType.ts deleted file mode 100644 index 0153c34..0000000 --- a/src/api/types/ConfigurablePropType.ts +++ /dev/null @@ -1,28 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export const ConfigurablePropType = { - AirtableBaseId: "$.airtable.baseId", - AirtableFieldId: "$.airtable.fieldId", - AirtableTableId: "$.airtable.tableId", - AirtableViewId: "$.airtable.viewId", - DiscordChannel: "$.discord.channel", - DiscordChannelArray: "$.discord.channel[]", - InterfaceApphook: "$.interface.apphook", - InterfaceHttp: "$.interface.http", - InterfaceTimer: "$.interface.timer", - ServiceDb: "$.service.db", - Alert: "alert", - Any: "any", - App: "app", - Boolean: "boolean", - DataStore: "data_store", - Dir: "dir", - HttpRequest: "http_request", - Integer: "integer", - IntegerArray: "integer[]", - Object: "object", - Sql: "sql", - String: "string", - StringArray: "string[]", -} as const; -export type ConfigurablePropType = (typeof ConfigurablePropType)[keyof typeof ConfigurablePropType]; diff --git a/src/api/types/DeployedComponent.ts b/src/api/types/DeployedComponent.ts index c257a87..eda4866 100644 --- a/src/api/types/DeployedComponent.ts +++ b/src/api/types/DeployedComponent.ts @@ -29,4 +29,6 @@ export interface DeployedComponent { nameSlug: string; /** Callback observations for the deployed component */ callbackObservations?: unknown; + /** Whether the trigger emits events during the deploy hook execution. When false, the $emit function is disabled during deploy hook execution. Defaults to true. */ + emitOnDeploy?: boolean; } diff --git a/src/api/types/index.ts b/src/api/types/index.ts index f466b70..985eaf3 100644 --- a/src/api/types/index.ts +++ b/src/api/types/index.ts @@ -9,6 +9,7 @@ export * from "./Component.js"; export * from "./ComponentStash.js"; export * from "./ComponentType.js"; export * from "./ConfigurableProp.js"; +export * from "./ConfigurablePropBase.js"; export * from "./ConfigurablePropAirtableBaseId.js"; export * from "./ConfigurablePropAirtableFieldId.js"; export * from "./ConfigurablePropAirtableTableId.js"; @@ -43,7 +44,6 @@ export * from "./ConfigurablePropTimer.js"; export * from "./ConfigurablePropTimerDefault.js"; export * from "./ConfigurablePropTimerOption.js"; export * from "./ConfigurablePropTimerStatic.js"; -export * from "./ConfigurablePropType.js"; export * from "./ConfiguredProps.js"; export * from "./ConfiguredPropValue.js"; export * from "./ConfiguredPropValueAny.js"; diff --git a/src/serialization/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts b/src/serialization/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts index 2c8d307..8938a5a 100644 --- a/src/serialization/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts +++ b/src/serialization/resources/deployedTriggers/client/requests/UpdateTriggerOpts.ts @@ -12,6 +12,7 @@ export const UpdateTriggerOpts: core.serialization.Schema< active: core.serialization.boolean().optional(), configuredProps: core.serialization.property("configured_props", ConfiguredProps.optional()), name: core.serialization.string().optional(), + emitOnDeploy: core.serialization.property("emit_on_deploy", core.serialization.boolean().optional()), }); export declare namespace UpdateTriggerOpts { @@ -19,5 +20,6 @@ export declare namespace UpdateTriggerOpts { active?: boolean | null; configured_props?: ConfiguredProps.Raw | null; name?: string | null; + emit_on_deploy?: boolean | null; } } diff --git a/src/serialization/resources/triggers/client/requests/DeployTriggerOpts.ts b/src/serialization/resources/triggers/client/requests/DeployTriggerOpts.ts index a97c6dd..911c437 100644 --- a/src/serialization/resources/triggers/client/requests/DeployTriggerOpts.ts +++ b/src/serialization/resources/triggers/client/requests/DeployTriggerOpts.ts @@ -16,6 +16,7 @@ export const DeployTriggerOpts: core.serialization.Schema< dynamicPropsId: core.serialization.property("dynamic_props_id", core.serialization.string().optional()), workflowId: core.serialization.property("workflow_id", core.serialization.string().optional()), webhookUrl: core.serialization.property("webhook_url", core.serialization.string().optional()), + emitOnDeploy: core.serialization.property("emit_on_deploy", core.serialization.boolean().optional()), }); export declare namespace DeployTriggerOpts { @@ -27,5 +28,6 @@ export declare namespace DeployTriggerOpts { dynamic_props_id?: string | null; workflow_id?: string | null; webhook_url?: string | null; + emit_on_deploy?: boolean | null; } } diff --git a/src/serialization/types/ConfigurableProp.ts b/src/serialization/types/ConfigurableProp.ts index ede495e..289256c 100644 --- a/src/serialization/types/ConfigurableProp.ts +++ b/src/serialization/types/ConfigurableProp.ts @@ -3,37 +3,156 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; -import { ConfigurablePropType } from "./ConfigurablePropType.js"; - -export const ConfigurableProp: core.serialization.ObjectSchema< - serializers.ConfigurableProp.Raw, - Pipedream.ConfigurableProp -> = core.serialization.object({ - name: core.serialization.string(), - type: ConfigurablePropType, - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +import { ConfigurablePropAirtableBaseId } from "./ConfigurablePropAirtableBaseId.js"; +import { ConfigurablePropAirtableFieldId } from "./ConfigurablePropAirtableFieldId.js"; +import { ConfigurablePropAirtableTableId } from "./ConfigurablePropAirtableTableId.js"; +import { ConfigurablePropAirtableViewId } from "./ConfigurablePropAirtableViewId.js"; +import { ConfigurablePropAlert } from "./ConfigurablePropAlert.js"; +import { ConfigurablePropAny } from "./ConfigurablePropAny.js"; +import { ConfigurablePropApp } from "./ConfigurablePropApp.js"; +import { ConfigurablePropApphook } from "./ConfigurablePropApphook.js"; +import { ConfigurablePropBoolean } from "./ConfigurablePropBoolean.js"; +import { ConfigurablePropDb } from "./ConfigurablePropDb.js"; +import { ConfigurablePropDiscordChannel } from "./ConfigurablePropDiscordChannel.js"; +import { ConfigurablePropDiscordChannelArray } from "./ConfigurablePropDiscordChannelArray.js"; +import { ConfigurablePropHttp } from "./ConfigurablePropHttp.js"; +import { ConfigurablePropInteger } from "./ConfigurablePropInteger.js"; +import { ConfigurablePropIntegerArray } from "./ConfigurablePropIntegerArray.js"; +import { ConfigurablePropObject } from "./ConfigurablePropObject.js"; +import { ConfigurablePropSql } from "./ConfigurablePropSql.js"; +import { ConfigurablePropString } from "./ConfigurablePropString.js"; +import { ConfigurablePropStringArray } from "./ConfigurablePropStringArray.js"; +import { ConfigurablePropTimer } from "./ConfigurablePropTimer.js"; + +export const ConfigurableProp: core.serialization.Schema = + core.serialization + .union("type", { + alert: ConfigurablePropAlert, + any: ConfigurablePropAny, + app: ConfigurablePropApp, + boolean: ConfigurablePropBoolean, + "$.interface.timer": ConfigurablePropTimer, + "$.interface.apphook": ConfigurablePropApphook, + "integer[]": ConfigurablePropIntegerArray, + "$.interface.http": ConfigurablePropHttp, + "$.service.db": ConfigurablePropDb, + sql: ConfigurablePropSql, + "$.airtable.baseId": ConfigurablePropAirtableBaseId, + "$.airtable.tableId": ConfigurablePropAirtableTableId, + "$.airtable.viewId": ConfigurablePropAirtableViewId, + "$.airtable.fieldId": ConfigurablePropAirtableFieldId, + "$.discord.channel": ConfigurablePropDiscordChannel, + "$.discord.channel[]": ConfigurablePropDiscordChannelArray, + integer: ConfigurablePropInteger, + object: ConfigurablePropObject, + string: ConfigurablePropString, + "string[]": ConfigurablePropStringArray, + }) + .transform({ + transform: (value) => value, + untransform: (value) => value, + }); export declare namespace ConfigurableProp { - export interface Raw { - name: string; - type: ConfigurablePropType.Raw; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; + export type Raw = + | ConfigurableProp.Alert + | ConfigurableProp.Any + | ConfigurableProp.App + | ConfigurableProp.Boolean + | ConfigurableProp.InterfaceTimer + | ConfigurableProp.InterfaceApphook + | ConfigurableProp.IntegerArray + | ConfigurableProp.InterfaceHttp + | ConfigurableProp.ServiceDb + | ConfigurableProp.Sql + | ConfigurableProp.AirtableBaseId + | ConfigurableProp.AirtableTableId + | ConfigurableProp.AirtableViewId + | ConfigurableProp.AirtableFieldId + | ConfigurableProp.DiscordChannel + | ConfigurableProp.DiscordChannelArray + | ConfigurableProp.Integer + | ConfigurableProp.Object + | ConfigurableProp.String + | ConfigurableProp.StringArray; + + export interface Alert extends ConfigurablePropAlert.Raw { + type: "alert"; + } + + export interface Any extends ConfigurablePropAny.Raw { + type: "any"; + } + + export interface App extends ConfigurablePropApp.Raw { + type: "app"; + } + + export interface Boolean extends ConfigurablePropBoolean.Raw { + type: "boolean"; + } + + export interface InterfaceTimer extends ConfigurablePropTimer.Raw { + type: "$.interface.timer"; + } + + export interface InterfaceApphook extends ConfigurablePropApphook.Raw { + type: "$.interface.apphook"; + } + + export interface IntegerArray extends ConfigurablePropIntegerArray.Raw { + type: "integer[]"; + } + + export interface InterfaceHttp extends ConfigurablePropHttp.Raw { + type: "$.interface.http"; + } + + export interface ServiceDb extends ConfigurablePropDb.Raw { + type: "$.service.db"; + } + + export interface Sql extends ConfigurablePropSql.Raw { + type: "sql"; + } + + export interface AirtableBaseId extends ConfigurablePropAirtableBaseId.Raw { + type: "$.airtable.baseId"; + } + + export interface AirtableTableId extends ConfigurablePropAirtableTableId.Raw { + type: "$.airtable.tableId"; + } + + export interface AirtableViewId extends ConfigurablePropAirtableViewId.Raw { + type: "$.airtable.viewId"; + } + + export interface AirtableFieldId extends ConfigurablePropAirtableFieldId.Raw { + type: "$.airtable.fieldId"; + } + + export interface DiscordChannel extends ConfigurablePropDiscordChannel.Raw { + type: "$.discord.channel"; + } + + export interface DiscordChannelArray extends ConfigurablePropDiscordChannelArray.Raw { + type: "$.discord.channel[]"; + } + + export interface Integer extends ConfigurablePropInteger.Raw { + type: "integer"; + } + + export interface Object extends ConfigurablePropObject.Raw { + type: "object"; + } + + export interface String extends ConfigurablePropString.Raw { + type: "string"; + } + + export interface StringArray extends ConfigurablePropStringArray.Raw { + type: "string[]"; } } diff --git a/src/serialization/types/ConfigurablePropAirtableBaseId.ts b/src/serialization/types/ConfigurablePropAirtableBaseId.ts index 61078b0..95e7046 100644 --- a/src/serialization/types/ConfigurablePropAirtableBaseId.ts +++ b/src/serialization/types/ConfigurablePropAirtableBaseId.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropAirtableBaseId: core.serialization.ObjectSchema< serializers.ConfigurablePropAirtableBaseId.Raw, Pipedream.ConfigurablePropAirtableBaseId -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.airtable.baseId"), - appProp: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + appProp: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAirtableBaseId { - export interface Raw { - type: "$.airtable.baseId"; + export interface Raw extends ConfigurablePropBase.Raw { appProp: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropAirtableFieldId.ts b/src/serialization/types/ConfigurablePropAirtableFieldId.ts index 2d1e337..70496ce 100644 --- a/src/serialization/types/ConfigurablePropAirtableFieldId.ts +++ b/src/serialization/types/ConfigurablePropAirtableFieldId.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropAirtableFieldId: core.serialization.ObjectSchema< serializers.ConfigurablePropAirtableFieldId.Raw, Pipedream.ConfigurablePropAirtableFieldId -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.airtable.fieldId"), - tableIdProp: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + tableIdProp: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAirtableFieldId { - export interface Raw { - type: "$.airtable.fieldId"; + export interface Raw extends ConfigurablePropBase.Raw { tableIdProp: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropAirtableTableId.ts b/src/serialization/types/ConfigurablePropAirtableTableId.ts index 920b272..4f8e148 100644 --- a/src/serialization/types/ConfigurablePropAirtableTableId.ts +++ b/src/serialization/types/ConfigurablePropAirtableTableId.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropAirtableTableId: core.serialization.ObjectSchema< serializers.ConfigurablePropAirtableTableId.Raw, Pipedream.ConfigurablePropAirtableTableId -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.airtable.tableId"), - baseIdProp: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + baseIdProp: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAirtableTableId { - export interface Raw { - type: "$.airtable.tableId"; + export interface Raw extends ConfigurablePropBase.Raw { baseIdProp: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropAirtableViewId.ts b/src/serialization/types/ConfigurablePropAirtableViewId.ts index 3cb92f0..69e8e7e 100644 --- a/src/serialization/types/ConfigurablePropAirtableViewId.ts +++ b/src/serialization/types/ConfigurablePropAirtableViewId.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropAirtableViewId: core.serialization.ObjectSchema< serializers.ConfigurablePropAirtableViewId.Raw, Pipedream.ConfigurablePropAirtableViewId -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.airtable.viewId"), - tableIdProp: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + tableIdProp: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAirtableViewId { - export interface Raw { - type: "$.airtable.viewId"; + export interface Raw extends ConfigurablePropBase.Raw { tableIdProp: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropAlert.ts b/src/serialization/types/ConfigurablePropAlert.ts index 98d0e8c..289a736 100644 --- a/src/serialization/types/ConfigurablePropAlert.ts +++ b/src/serialization/types/ConfigurablePropAlert.ts @@ -4,40 +4,21 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; import { ConfigurablePropAlertType } from "./ConfigurablePropAlertType.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropAlert: core.serialization.ObjectSchema< serializers.ConfigurablePropAlert.Raw, Pipedream.ConfigurablePropAlert -> = core.serialization.object({ - type: core.serialization.stringLiteral("alert"), - alertType: ConfigurablePropAlertType.optional(), - content: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + alertType: ConfigurablePropAlertType.optional(), + content: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAlert { - export interface Raw { - type: "alert"; + export interface Raw extends ConfigurablePropBase.Raw { alertType?: ConfigurablePropAlertType.Raw | null; content: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropAny.ts b/src/serialization/types/ConfigurablePropAny.ts index 0fa0d68..ae562fc 100644 --- a/src/serialization/types/ConfigurablePropAny.ts +++ b/src/serialization/types/ConfigurablePropAny.ts @@ -4,41 +4,22 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; import { ConfigurablePropAnyOptionsItem } from "./ConfigurablePropAnyOptionsItem.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfiguredPropValueAny } from "./ConfiguredPropValueAny.js"; export const ConfigurablePropAny: core.serialization.ObjectSchema< serializers.ConfigurablePropAny.Raw, Pipedream.ConfigurablePropAny -> = core.serialization.object({ - type: core.serialization.stringLiteral("any"), - default: ConfiguredPropValueAny.optional(), - options: core.serialization.list(ConfigurablePropAnyOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + default: ConfiguredPropValueAny.optional(), + options: core.serialization.list(ConfigurablePropAnyOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropAny { - export interface Raw { - type: "any"; + export interface Raw extends ConfigurablePropBase.Raw { default?: (ConfiguredPropValueAny.Raw | undefined) | null; options?: ConfigurablePropAnyOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropApp.ts b/src/serialization/types/ConfigurablePropApp.ts index b765c5a..8d4cf1e 100644 --- a/src/serialization/types/ConfigurablePropApp.ts +++ b/src/serialization/types/ConfigurablePropApp.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropApp: core.serialization.ObjectSchema< serializers.ConfigurablePropApp.Raw, Pipedream.ConfigurablePropApp -> = core.serialization.object({ - type: core.serialization.stringLiteral("app"), - app: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + app: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropApp { - export interface Raw { - type: "app"; + export interface Raw extends ConfigurablePropBase.Raw { app: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropApphook.ts b/src/serialization/types/ConfigurablePropApphook.ts index 29e1c54..2bf929f 100644 --- a/src/serialization/types/ConfigurablePropApphook.ts +++ b/src/serialization/types/ConfigurablePropApphook.ts @@ -3,44 +3,25 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropApphook: core.serialization.ObjectSchema< serializers.ConfigurablePropApphook.Raw, Pipedream.ConfigurablePropApphook -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.interface.apphook"), - appProp: core.serialization.string(), - eventNames: core.serialization.list(core.serialization.string()).optional(), - remote: core.serialization.boolean().optional(), - static: core.serialization.list(core.serialization.unknown()).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + appProp: core.serialization.string(), + eventNames: core.serialization.list(core.serialization.string()).optional(), + remote: core.serialization.boolean().optional(), + static: core.serialization.list(core.serialization.unknown()).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropApphook { - export interface Raw { - type: "$.interface.apphook"; + export interface Raw extends ConfigurablePropBase.Raw { appProp: string; eventNames?: string[] | null; remote?: boolean | null; static?: unknown[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropBase.ts b/src/serialization/types/ConfigurablePropBase.ts new file mode 100644 index 0000000..3d06f35 --- /dev/null +++ b/src/serialization/types/ConfigurablePropBase.ts @@ -0,0 +1,36 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Pipedream from "../../api/index.js"; +import * as core from "../../core/index.js"; +import type * as serializers from "../index.js"; + +export const ConfigurablePropBase: core.serialization.ObjectSchema< + serializers.ConfigurablePropBase.Raw, + Pipedream.ConfigurablePropBase +> = core.serialization.object({ + name: core.serialization.string(), + label: core.serialization.string().optional(), + description: core.serialization.string().optional(), + optional: core.serialization.boolean().optional(), + disabled: core.serialization.boolean().optional(), + hidden: core.serialization.boolean().optional(), + remoteOptions: core.serialization.boolean().optional(), + useQuery: core.serialization.boolean().optional(), + reloadProps: core.serialization.boolean().optional(), + withLabel: core.serialization.boolean().optional(), +}); + +export declare namespace ConfigurablePropBase { + export interface Raw { + name: string; + label?: string | null; + description?: string | null; + optional?: boolean | null; + disabled?: boolean | null; + hidden?: boolean | null; + remoteOptions?: boolean | null; + useQuery?: boolean | null; + reloadProps?: boolean | null; + withLabel?: boolean | null; + } +} diff --git a/src/serialization/types/ConfigurablePropBoolean.ts b/src/serialization/types/ConfigurablePropBoolean.ts index 8838725..a8f2329 100644 --- a/src/serialization/types/ConfigurablePropBoolean.ts +++ b/src/serialization/types/ConfigurablePropBoolean.ts @@ -3,42 +3,23 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropBooleanOptionsItem } from "./ConfigurablePropBooleanOptionsItem.js"; import { ConfiguredPropValueBoolean } from "./ConfiguredPropValueBoolean.js"; export const ConfigurablePropBoolean: core.serialization.ObjectSchema< serializers.ConfigurablePropBoolean.Raw, Pipedream.ConfigurablePropBoolean -> = core.serialization.object({ - type: core.serialization.stringLiteral("boolean"), - default: ConfiguredPropValueBoolean.optional(), - options: core.serialization.list(ConfigurablePropBooleanOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + default: ConfiguredPropValueBoolean.optional(), + options: core.serialization.list(ConfigurablePropBooleanOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropBoolean { - export interface Raw { - type: "boolean"; + export interface Raw extends ConfigurablePropBase.Raw { default?: ConfiguredPropValueBoolean.Raw | null; options?: ConfigurablePropBooleanOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropDb.ts b/src/serialization/types/ConfigurablePropDb.ts index e9a11e0..c96bbdf 100644 --- a/src/serialization/types/ConfigurablePropDb.ts +++ b/src/serialization/types/ConfigurablePropDb.ts @@ -3,36 +3,13 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropDb: core.serialization.ObjectSchema< serializers.ConfigurablePropDb.Raw, Pipedream.ConfigurablePropDb -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.service.db"), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization.object({}).extend(ConfigurablePropBase); export declare namespace ConfigurablePropDb { - export interface Raw { - type: "$.service.db"; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; - } + export interface Raw extends ConfigurablePropBase.Raw {} } diff --git a/src/serialization/types/ConfigurablePropDiscord.ts b/src/serialization/types/ConfigurablePropDiscord.ts index b3875f6..ad07990 100644 --- a/src/serialization/types/ConfigurablePropDiscord.ts +++ b/src/serialization/types/ConfigurablePropDiscord.ts @@ -3,36 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropDiscord: core.serialization.ObjectSchema< serializers.ConfigurablePropDiscord.Raw, Pipedream.ConfigurablePropDiscord -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.discord.channel"), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + type: core.serialization.stringLiteral("$.discord.channel"), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropDiscord { - export interface Raw { + export interface Raw extends ConfigurablePropBase.Raw { type: "$.discord.channel"; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropDiscordChannel.ts b/src/serialization/types/ConfigurablePropDiscordChannel.ts index 05ef503..e04aa8d 100644 --- a/src/serialization/types/ConfigurablePropDiscordChannel.ts +++ b/src/serialization/types/ConfigurablePropDiscordChannel.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropDiscordChannel: core.serialization.ObjectSchema< serializers.ConfigurablePropDiscordChannel.Raw, Pipedream.ConfigurablePropDiscordChannel -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.discord.channel"), - appProp: core.serialization.string(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + appProp: core.serialization.string(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropDiscordChannel { - export interface Raw { - type: "$.discord.channel"; + export interface Raw extends ConfigurablePropBase.Raw { appProp: string; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropDiscordChannelArray.ts b/src/serialization/types/ConfigurablePropDiscordChannelArray.ts index 4108782..b77b6e1 100644 --- a/src/serialization/types/ConfigurablePropDiscordChannelArray.ts +++ b/src/serialization/types/ConfigurablePropDiscordChannelArray.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropDiscordChannelArray: core.serialization.ObjectSchema< serializers.ConfigurablePropDiscordChannelArray.Raw, Pipedream.ConfigurablePropDiscordChannelArray -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.discord.channel[]"), - appProp: core.serialization.string().optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + appProp: core.serialization.string().optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropDiscordChannelArray { - export interface Raw { - type: "$.discord.channel[]"; + export interface Raw extends ConfigurablePropBase.Raw { appProp?: string | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropHttp.ts b/src/serialization/types/ConfigurablePropHttp.ts index 41c2b00..aa2027c 100644 --- a/src/serialization/types/ConfigurablePropHttp.ts +++ b/src/serialization/types/ConfigurablePropHttp.ts @@ -3,38 +3,19 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; export const ConfigurablePropHttp: core.serialization.ObjectSchema< serializers.ConfigurablePropHttp.Raw, Pipedream.ConfigurablePropHttp -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.interface.http"), - customResponse: core.serialization.boolean().optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + customResponse: core.serialization.boolean().optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropHttp { - export interface Raw { - type: "$.interface.http"; + export interface Raw extends ConfigurablePropBase.Raw { customResponse?: boolean | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropInteger.ts b/src/serialization/types/ConfigurablePropInteger.ts index bd54031..17f9d56 100644 --- a/src/serialization/types/ConfigurablePropInteger.ts +++ b/src/serialization/types/ConfigurablePropInteger.ts @@ -3,46 +3,27 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropIntegerOptionsItem } from "./ConfigurablePropIntegerOptionsItem.js"; import { ConfiguredPropValueInteger } from "./ConfiguredPropValueInteger.js"; export const ConfigurablePropInteger: core.serialization.ObjectSchema< serializers.ConfigurablePropInteger.Raw, Pipedream.ConfigurablePropInteger -> = core.serialization.object({ - type: core.serialization.stringLiteral("integer"), - min: core.serialization.number().optional(), - max: core.serialization.number().optional(), - default: ConfiguredPropValueInteger.optional(), - options: core.serialization.list(ConfigurablePropIntegerOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + min: core.serialization.number().optional(), + max: core.serialization.number().optional(), + default: ConfiguredPropValueInteger.optional(), + options: core.serialization.list(ConfigurablePropIntegerOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropInteger { - export interface Raw { - type: "integer"; + export interface Raw extends ConfigurablePropBase.Raw { min?: number | null; max?: number | null; default?: ConfiguredPropValueInteger.Raw | null; options?: ConfigurablePropIntegerOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropIntegerArray.ts b/src/serialization/types/ConfigurablePropIntegerArray.ts index 15c2b46..fba4c20 100644 --- a/src/serialization/types/ConfigurablePropIntegerArray.ts +++ b/src/serialization/types/ConfigurablePropIntegerArray.ts @@ -3,46 +3,27 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropIntegerArrayOptionsItem } from "./ConfigurablePropIntegerArrayOptionsItem.js"; import { ConfiguredPropValueInteger } from "./ConfiguredPropValueInteger.js"; export const ConfigurablePropIntegerArray: core.serialization.ObjectSchema< serializers.ConfigurablePropIntegerArray.Raw, Pipedream.ConfigurablePropIntegerArray -> = core.serialization.object({ - type: core.serialization.stringLiteral("integer[]"), - min: core.serialization.number().optional(), - max: core.serialization.number().optional(), - default: core.serialization.list(ConfiguredPropValueInteger).optional(), - options: core.serialization.list(ConfigurablePropIntegerArrayOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + min: core.serialization.number().optional(), + max: core.serialization.number().optional(), + default: core.serialization.list(ConfiguredPropValueInteger).optional(), + options: core.serialization.list(ConfigurablePropIntegerArrayOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropIntegerArray { - export interface Raw { - type: "integer[]"; + export interface Raw extends ConfigurablePropBase.Raw { min?: number | null; max?: number | null; default?: ConfiguredPropValueInteger.Raw[] | null; options?: ConfigurablePropIntegerArrayOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropObject.ts b/src/serialization/types/ConfigurablePropObject.ts index 1a7480d..bec3516 100644 --- a/src/serialization/types/ConfigurablePropObject.ts +++ b/src/serialization/types/ConfigurablePropObject.ts @@ -3,42 +3,23 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropObjectOptionsItem } from "./ConfigurablePropObjectOptionsItem.js"; import { ConfiguredPropValueObject } from "./ConfiguredPropValueObject.js"; export const ConfigurablePropObject: core.serialization.ObjectSchema< serializers.ConfigurablePropObject.Raw, Pipedream.ConfigurablePropObject -> = core.serialization.object({ - type: core.serialization.stringLiteral("object"), - default: ConfiguredPropValueObject.optional(), - options: core.serialization.list(ConfigurablePropObjectOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + default: ConfiguredPropValueObject.optional(), + options: core.serialization.list(ConfigurablePropObjectOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropObject { - export interface Raw { - type: "object"; + export interface Raw extends ConfigurablePropBase.Raw { default?: ConfiguredPropValueObject.Raw | null; options?: ConfigurablePropObjectOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropSql.ts b/src/serialization/types/ConfigurablePropSql.ts index 227c8f8..d55ecea 100644 --- a/src/serialization/types/ConfigurablePropSql.ts +++ b/src/serialization/types/ConfigurablePropSql.ts @@ -3,6 +3,7 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropSqlAuth } from "./ConfigurablePropSqlAuth.js"; import { ConfigurablePropSqlOptionsItem } from "./ConfigurablePropSqlOptionsItem.js"; import { ConfiguredPropValueSql } from "./ConfiguredPropValueSql.js"; @@ -10,38 +11,18 @@ import { ConfiguredPropValueSql } from "./ConfiguredPropValueSql.js"; export const ConfigurablePropSql: core.serialization.ObjectSchema< serializers.ConfigurablePropSql.Raw, Pipedream.ConfigurablePropSql -> = core.serialization.object({ - type: core.serialization.stringLiteral("sql"), - auth: ConfigurablePropSqlAuth.optional(), - default: ConfiguredPropValueSql.optional(), - options: core.serialization.list(ConfigurablePropSqlOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + auth: ConfigurablePropSqlAuth.optional(), + default: ConfiguredPropValueSql.optional(), + options: core.serialization.list(ConfigurablePropSqlOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropSql { - export interface Raw { - type: "sql"; + export interface Raw extends ConfigurablePropBase.Raw { auth?: ConfigurablePropSqlAuth.Raw | null; default?: ConfiguredPropValueSql.Raw | null; options?: ConfigurablePropSqlOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropString.ts b/src/serialization/types/ConfigurablePropString.ts index 88036c1..4714884 100644 --- a/src/serialization/types/ConfigurablePropString.ts +++ b/src/serialization/types/ConfigurablePropString.ts @@ -3,44 +3,25 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropStringOptionsItem } from "./ConfigurablePropStringOptionsItem.js"; import { ConfiguredPropValueString } from "./ConfiguredPropValueString.js"; export const ConfigurablePropString: core.serialization.ObjectSchema< serializers.ConfigurablePropString.Raw, Pipedream.ConfigurablePropString -> = core.serialization.object({ - type: core.serialization.stringLiteral("string"), - secret: core.serialization.boolean().optional(), - default: ConfiguredPropValueString.optional(), - options: core.serialization.list(ConfigurablePropStringOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + secret: core.serialization.boolean().optional(), + default: ConfiguredPropValueString.optional(), + options: core.serialization.list(ConfigurablePropStringOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropString { - export interface Raw { - type: "string"; + export interface Raw extends ConfigurablePropBase.Raw { secret?: boolean | null; default?: ConfiguredPropValueString.Raw | null; options?: ConfigurablePropStringOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropStringArray.ts b/src/serialization/types/ConfigurablePropStringArray.ts index a9324f5..5991b02 100644 --- a/src/serialization/types/ConfigurablePropStringArray.ts +++ b/src/serialization/types/ConfigurablePropStringArray.ts @@ -3,44 +3,25 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropStringArrayOptionsItem } from "./ConfigurablePropStringArrayOptionsItem.js"; import { ConfiguredPropValueString } from "./ConfiguredPropValueString.js"; export const ConfigurablePropStringArray: core.serialization.ObjectSchema< serializers.ConfigurablePropStringArray.Raw, Pipedream.ConfigurablePropStringArray -> = core.serialization.object({ - type: core.serialization.stringLiteral("string[]"), - secret: core.serialization.boolean().optional(), - default: core.serialization.list(ConfiguredPropValueString).optional(), - options: core.serialization.list(ConfigurablePropStringArrayOptionsItem).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + secret: core.serialization.boolean().optional(), + default: core.serialization.list(ConfiguredPropValueString).optional(), + options: core.serialization.list(ConfigurablePropStringArrayOptionsItem).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropStringArray { - export interface Raw { - type: "string[]"; + export interface Raw extends ConfigurablePropBase.Raw { secret?: boolean | null; default?: ConfiguredPropValueString.Raw[] | null; options?: ConfigurablePropStringArrayOptionsItem.Raw[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropTimer.ts b/src/serialization/types/ConfigurablePropTimer.ts index 2ccc73e..33794fd 100644 --- a/src/serialization/types/ConfigurablePropTimer.ts +++ b/src/serialization/types/ConfigurablePropTimer.ts @@ -3,6 +3,7 @@ import type * as Pipedream from "../../api/index.js"; import * as core from "../../core/index.js"; import type * as serializers from "../index.js"; +import { ConfigurablePropBase } from "./ConfigurablePropBase.js"; import { ConfigurablePropTimerDefault } from "./ConfigurablePropTimerDefault.js"; import { ConfigurablePropTimerOption } from "./ConfigurablePropTimerOption.js"; import { ConfigurablePropTimerStatic } from "./ConfigurablePropTimerStatic.js"; @@ -10,38 +11,18 @@ import { ConfigurablePropTimerStatic } from "./ConfigurablePropTimerStatic.js"; export const ConfigurablePropTimer: core.serialization.ObjectSchema< serializers.ConfigurablePropTimer.Raw, Pipedream.ConfigurablePropTimer -> = core.serialization.object({ - type: core.serialization.stringLiteral("$.interface.timer"), - static: ConfigurablePropTimerStatic.optional(), - default: ConfigurablePropTimerDefault.optional(), - options: core.serialization.list(ConfigurablePropTimerOption.optional()).optional(), - name: core.serialization.string(), - label: core.serialization.string().optional(), - description: core.serialization.string().optional(), - optional: core.serialization.boolean().optional(), - disabled: core.serialization.boolean().optional(), - hidden: core.serialization.boolean().optional(), - remoteOptions: core.serialization.boolean().optional(), - useQuery: core.serialization.boolean().optional(), - reloadProps: core.serialization.boolean().optional(), - withLabel: core.serialization.boolean().optional(), -}); +> = core.serialization + .object({ + static: ConfigurablePropTimerStatic.optional(), + default: ConfigurablePropTimerDefault.optional(), + options: core.serialization.list(ConfigurablePropTimerOption.optional()).optional(), + }) + .extend(ConfigurablePropBase); export declare namespace ConfigurablePropTimer { - export interface Raw { - type: "$.interface.timer"; + export interface Raw extends ConfigurablePropBase.Raw { static?: ConfigurablePropTimerStatic.Raw | null; default?: ConfigurablePropTimerDefault.Raw | null; options?: (ConfigurablePropTimerOption.Raw | null | undefined)[] | null; - name: string; - label?: string | null; - description?: string | null; - optional?: boolean | null; - disabled?: boolean | null; - hidden?: boolean | null; - remoteOptions?: boolean | null; - useQuery?: boolean | null; - reloadProps?: boolean | null; - withLabel?: boolean | null; } } diff --git a/src/serialization/types/ConfigurablePropType.ts b/src/serialization/types/ConfigurablePropType.ts deleted file mode 100644 index e369a28..0000000 --- a/src/serialization/types/ConfigurablePropType.ts +++ /dev/null @@ -1,61 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -import type * as Pipedream from "../../api/index.js"; -import * as core from "../../core/index.js"; -import type * as serializers from "../index.js"; - -export const ConfigurablePropType: core.serialization.Schema< - serializers.ConfigurablePropType.Raw, - Pipedream.ConfigurablePropType -> = core.serialization.enum_([ - "$.airtable.baseId", - "$.airtable.fieldId", - "$.airtable.tableId", - "$.airtable.viewId", - "$.discord.channel", - "$.discord.channel[]", - "$.interface.apphook", - "$.interface.http", - "$.interface.timer", - "$.service.db", - "alert", - "any", - "app", - "boolean", - "data_store", - "dir", - "http_request", - "integer", - "integer[]", - "object", - "sql", - "string", - "string[]", -]); - -export declare namespace ConfigurablePropType { - export type Raw = - | "$.airtable.baseId" - | "$.airtable.fieldId" - | "$.airtable.tableId" - | "$.airtable.viewId" - | "$.discord.channel" - | "$.discord.channel[]" - | "$.interface.apphook" - | "$.interface.http" - | "$.interface.timer" - | "$.service.db" - | "alert" - | "any" - | "app" - | "boolean" - | "data_store" - | "dir" - | "http_request" - | "integer" - | "integer[]" - | "object" - | "sql" - | "string" - | "string[]"; -} diff --git a/src/serialization/types/DeployedComponent.ts b/src/serialization/types/DeployedComponent.ts index b15e59a..c800dc1 100644 --- a/src/serialization/types/DeployedComponent.ts +++ b/src/serialization/types/DeployedComponent.ts @@ -22,6 +22,7 @@ export const DeployedComponent: core.serialization.ObjectSchema< name: core.serialization.string(), nameSlug: core.serialization.property("name_slug", core.serialization.string()), callbackObservations: core.serialization.property("callback_observations", core.serialization.unknown().optional()), + emitOnDeploy: core.serialization.property("emit_on_deploy", core.serialization.boolean().optional()), }); export declare namespace DeployedComponent { @@ -38,5 +39,6 @@ export declare namespace DeployedComponent { name: string; name_slug: string; callback_observations?: unknown | null; + emit_on_deploy?: boolean | null; } } diff --git a/src/serialization/types/index.ts b/src/serialization/types/index.ts index b0d7929..4ebd911 100644 --- a/src/serialization/types/index.ts +++ b/src/serialization/types/index.ts @@ -19,6 +19,7 @@ export * from "./ConfigurablePropAny.js"; export * from "./ConfigurablePropAnyOptionsItem.js"; export * from "./ConfigurablePropApp.js"; export * from "./ConfigurablePropApphook.js"; +export * from "./ConfigurablePropBase.js"; export * from "./ConfigurablePropBoolean.js"; export * from "./ConfigurablePropBooleanOptionsItem.js"; export * from "./ConfigurablePropDb.js"; @@ -43,7 +44,6 @@ export * from "./ConfigurablePropTimer.js"; export * from "./ConfigurablePropTimerDefault.js"; export * from "./ConfigurablePropTimerOption.js"; export * from "./ConfigurablePropTimerStatic.js"; -export * from "./ConfigurablePropType.js"; export * from "./ConfiguredProps.js"; export * from "./ConfiguredPropValue.js"; export * from "./ConfiguredPropValueAny.js"; diff --git a/src/version.ts b/src/version.ts index 13d9985..7fc9811 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.2.0"; +export const SDK_VERSION = "2.2.1";