@pollination-solutions/pollination-sdk 1.3.0 → 1.4.2

package/dist/esm/models/daglinked-output-alias.d.ts

@@ -0,0 +1,57 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { IOAliasHandler } from './ioalias-handler';
+/**
+ * An Alias for Linked Outputs.  A linked output alias will be translated to an object in the UI and stay linked to it.
+ * @export
+ * @interface DAGLinkedOutputAlias
+ */
+export interface DAGLinkedOutputAlias {
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Optional description for output.
+     * @type {string}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'description'?: string;
+    /**
+     * List of process actions to process the input or output value.
+     * @type {Array<IOAliasHandler>}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'handler': Array<IOAliasHandler>;
+    /**
+     * Output name.
+     * @type {string}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'name': string;
+    /**
+     * Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe.
+     * @type {Array<string>}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'platform': Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGLinkedOutputAlias
+     */
+    'type'?: string;
+}

package/dist/esm/models/daglinked-output-alias.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagnumber-input-alias.d.ts

@@ -0,0 +1,75 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { IOAliasHandler } from './ioalias-handler';
+/**
+ * An alias number input.  You can add additional validation by defining a JSONSchema specification.  See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information.
+ * @export
+ * @interface DAGNumberInputAlias
+ */
+export interface DAGNumberInputAlias {
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGNumberInputAlias
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Default value to use for an input if a value was not supplied.
+     * @type {number}
+     * @memberof DAGNumberInputAlias
+     */
+    'default'?: number;
+    /**
+     * Optional description for input.
+     * @type {string}
+     * @memberof DAGNumberInputAlias
+     */
+    'description'?: string;
+    /**
+     * List of process actions to process the input or output value.
+     * @type {Array<IOAliasHandler>}
+     * @memberof DAGNumberInputAlias
+     */
+    'handler': Array<IOAliasHandler>;
+    /**
+     * Input name.
+     * @type {string}
+     * @memberof DAGNumberInputAlias
+     */
+    'name': string;
+    /**
+     * Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe.
+     * @type {Array<string>}
+     * @memberof DAGNumberInputAlias
+     */
+    'platform': Array<string>;
+    /**
+     * A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided.
+     * @type {boolean}
+     * @memberof DAGNumberInputAlias
+     */
+    'required'?: boolean;
+    /**
+     * An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec.
+     * @type {object}
+     * @memberof DAGNumberInputAlias
+     */
+    'spec'?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGNumberInputAlias
+     */
+    'type'?: string;
+}

package/dist/esm/models/dagnumber-input-alias.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagnumber-input.d.ts

@@ -0,0 +1,69 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DAGArrayInputAliasInner } from './dagarray-input-alias-inner';
+/**
+ * A number input.  You can add additional validation by defining a JSONSchema specification.  See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information.
+ * @export
+ * @interface DAGNumberInput
+ */
+export interface DAGNumberInput {
+    /**
+     * A list of aliases for this input in different platforms.
+     * @type {Array<DAGArrayInputAliasInner>}
+     * @memberof DAGNumberInput
+     */
+    'alias'?: Array<DAGArrayInputAliasInner>;
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGNumberInput
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Default value to use for an input if a value was not supplied.
+     * @type {number}
+     * @memberof DAGNumberInput
+     */
+    'default'?: number;
+    /**
+     * Optional description for input.
+     * @type {string}
+     * @memberof DAGNumberInput
+     */
+    'description'?: string;
+    /**
+     * Input name.
+     * @type {string}
+     * @memberof DAGNumberInput
+     */
+    'name': string;
+    /**
+     * A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided.
+     * @type {boolean}
+     * @memberof DAGNumberInput
+     */
+    'required'?: boolean;
+    /**
+     * An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec.
+     * @type {object}
+     * @memberof DAGNumberInput
+     */
+    'spec'?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGNumberInput
+     */
+    'type'?: string;
+}

package/dist/esm/models/dagnumber-input.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagnumber-output-alias.d.ts

@@ -0,0 +1,70 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { From } from './from';
+import type { IOAliasHandler } from './ioalias-handler';
+/**
+ * DAG alias number output.  This output loads the content from a file as a floating number.
+ * @export
+ * @interface DAGNumberOutputAlias
+ */
+export interface DAGNumberOutputAlias {
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGNumberOutputAlias
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Optional description for output.
+     * @type {string}
+     * @memberof DAGNumberOutputAlias
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {From}
+     * @memberof DAGNumberOutputAlias
+     */
+    'from': From;
+    /**
+     * List of process actions to process the input or output value.
+     * @type {Array<IOAliasHandler>}
+     * @memberof DAGNumberOutputAlias
+     */
+    'handler': Array<IOAliasHandler>;
+    /**
+     * Output name.
+     * @type {string}
+     * @memberof DAGNumberOutputAlias
+     */
+    'name': string;
+    /**
+     * Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe.
+     * @type {Array<string>}
+     * @memberof DAGNumberOutputAlias
+     */
+    'platform': Array<string>;
+    /**
+     * A boolean to indicate if an artifact output is required. A False value makes the artifact optional.
+     * @type {boolean}
+     * @memberof DAGNumberOutputAlias
+     */
+    'required'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGNumberOutputAlias
+     */
+    'type'?: string;
+}

package/dist/esm/models/dagnumber-output-alias.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagnumber-output.d.ts

@@ -0,0 +1,64 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DAGArrayOutputAliasInner } from './dagarray-output-alias-inner';
+import type { From } from './from';
+/**
+ * DAG number output.  This output loads the content from a file as a floating number.
+ * @export
+ * @interface DAGNumberOutput
+ */
+export interface DAGNumberOutput {
+    /**
+     * A list of additional processes for loading this output on different platforms.
+     * @type {Array<DAGArrayOutputAliasInner>}
+     * @memberof DAGNumberOutput
+     */
+    'alias'?: Array<DAGArrayOutputAliasInner>;
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGNumberOutput
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Optional description for output.
+     * @type {string}
+     * @memberof DAGNumberOutput
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {From}
+     * @memberof DAGNumberOutput
+     */
+    'from': From;
+    /**
+     * Output name.
+     * @type {string}
+     * @memberof DAGNumberOutput
+     */
+    'name': string;
+    /**
+     * A boolean to indicate if an artifact output is required. A False value makes the artifact optional.
+     * @type {boolean}
+     * @memberof DAGNumberOutput
+     */
+    'required'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGNumberOutput
+     */
+    'type'?: string;
+}

package/dist/esm/models/dagnumber-output.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagoutputs-inner.d.ts

@@ -0,0 +1,71 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DAGArrayOutputAliasInner } from './dagarray-output-alias-inner';
+import type { From } from './from';
+import type { ItemType } from './item-type';
+/**
+ *
+ * @export
+ * @interface DAGOutputsInner
+ */
+export interface DAGOutputsInner {
+    /**
+     * A list of additional processes for loading this output on different platforms.
+     * @type {Array<DAGArrayOutputAliasInner>}
+     * @memberof DAGOutputsInner
+     */
+    'alias'?: Array<DAGArrayOutputAliasInner>;
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGOutputsInner
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * Optional description for output.
+     * @type {string}
+     * @memberof DAGOutputsInner
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {From}
+     * @memberof DAGOutputsInner
+     */
+    'from': From;
+    /**
+     * Output name.
+     * @type {string}
+     * @memberof DAGOutputsInner
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGOutputsInner
+     */
+    'type'?: string;
+    /**
+     * A boolean to indicate if an artifact output is required. A False value makes the artifact optional.
+     * @type {boolean}
+     * @memberof DAGOutputsInner
+     */
+    'required'?: boolean;
+    /**
+     * Type of items in this array. All the items in an array must be from the same type.
+     * @type {ItemType}
+     * @memberof DAGOutputsInner
+     */
+    'items_type'?: ItemType;
+}

package/dist/esm/models/dagoutputs-inner.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagpath-input-alias.d.ts

@@ -0,0 +1,82 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Default } from './default';
+import type { IOAliasHandler } from './ioalias-handler';
+/**
+ * A file or a folder input.  Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder.  Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed.  You can add additional validation by defining a JSONSchema specification.  See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information.  .. code-block:: python      # a file with maximum 50 characters with an ``epw`` extension.      \"schema\": {         \"type\": \"string\",         \"maxLength\": 50,         \"pattern\": \"(?i)(^.*\\.epw$)\"     }
+ * @export
+ * @interface DAGPathInputAlias
+ */
+export interface DAGPathInputAlias {
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGPathInputAlias
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {Default}
+     * @memberof DAGPathInputAlias
+     */
+    'default'?: Default;
+    /**
+     * Optional description for input.
+     * @type {string}
+     * @memberof DAGPathInputAlias
+     */
+    'description'?: string;
+    /**
+     * Optional list of extensions for path. The check for extension is case-insensitive. The extension will only be validated for file inputs.
+     * @type {Array<string>}
+     * @memberof DAGPathInputAlias
+     */
+    'extensions'?: Array<string>;
+    /**
+     * List of process actions to process the input or output value.
+     * @type {Array<IOAliasHandler>}
+     * @memberof DAGPathInputAlias
+     */
+    'handler': Array<IOAliasHandler>;
+    /**
+     * Input name.
+     * @type {string}
+     * @memberof DAGPathInputAlias
+     */
+    'name': string;
+    /**
+     * Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe.
+     * @type {Array<string>}
+     * @memberof DAGPathInputAlias
+     */
+    'platform': Array<string>;
+    /**
+     * A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided.
+     * @type {boolean}
+     * @memberof DAGPathInputAlias
+     */
+    'required'?: boolean;
+    /**
+     * An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec.
+     * @type {object}
+     * @memberof DAGPathInputAlias
+     */
+    'spec'?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGPathInputAlias
+     */
+    'type'?: string;
+}

package/dist/esm/models/dagpath-input-alias.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/dagpath-input.d.ts

@@ -0,0 +1,76 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DAGArrayInputAliasInner } from './dagarray-input-alias-inner';
+import type { Default } from './default';
+/**
+ * A file or a folder input.  Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder.  Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed.  You can add additional validation by defining a JSONSchema specification.  See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information.  .. code-block:: python      # a file with maximum 50 characters with an ``epw`` extension.      \"schema\": {         \"type\": \"string\",         \"maxLength\": 50,         \"pattern\": \"(?i)(^.*\\.epw$)\"     }
+ * @export
+ * @interface DAGPathInput
+ */
+export interface DAGPathInput {
+    /**
+     * A list of aliases for this input in different platforms.
+     * @type {Array<DAGArrayInputAliasInner>}
+     * @memberof DAGPathInput
+     */
+    'alias'?: Array<DAGArrayInputAliasInner>;
+    /**
+     * An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.
+     * @type {{ [key: string]: string; }}
+     * @memberof DAGPathInput
+     */
+    'annotations'?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {Default}
+     * @memberof DAGPathInput
+     */
+    'default'?: Default;
+    /**
+     * Optional description for input.
+     * @type {string}
+     * @memberof DAGPathInput
+     */
+    'description'?: string;
+    /**
+     * Optional list of extensions for path. The check for extension is case-insensitive. The extension will only be validated for file inputs.
+     * @type {Array<string>}
+     * @memberof DAGPathInput
+     */
+    'extensions'?: Array<string>;
+    /**
+     * Input name.
+     * @type {string}
+     * @memberof DAGPathInput
+     */
+    'name': string;
+    /**
+     * A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided.
+     * @type {boolean}
+     * @memberof DAGPathInput
+     */
+    'required'?: boolean;
+    /**
+     * An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec.
+     * @type {object}
+     * @memberof DAGPathInput
+     */
+    'spec'?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof DAGPathInput
+     */
+    'type'?: string;
+}