@epilot/sdk 2.0.0-alpha.0

package/dist/submission.d-e9MPrbY1.d.cts

@@ -0,0 +1,470 @@
+import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
+
+/* eslint-disable */
+/* Auto-copied from submission-client */
+/* eslint-disable */
+
+
+
+declare namespace Components {
+    namespace Schemas {
+        export interface OptIn {
+            /**
+             * example:
+             * EMAIL_MARKETING
+             */
+            topic?: string;
+            /**
+             * Consent identifier
+             * example:
+             * example@email.com
+             */
+            identifier?: string;
+            meta?: {
+                [name: string]: any;
+            };
+        }
+        /**
+         * S3 Reference from File API
+         */
+        export interface S3Reference {
+            /**
+             * example:
+             * epilot-user-content
+             */
+            bucket: string;
+            /**
+             * example:
+             * temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+             */
+            key: string;
+        }
+        /**
+         * The submission entity to create
+         * example:
+         * {
+         *   "_schema": "submission",
+         *   "description": "Submission created via API",
+         *   "contact_first_name": "First",
+         *   "contact_last_name": "Last",
+         *   "contact_email": "example@submission.com",
+         *   "request": "I would like to know more about electric vehicles",
+         *   "files": [
+         *     {
+         *       "s3ref": {
+         *         "bucket": "epilot-user-content",
+         *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+         *       },
+         *       "filename": "document.pdf"
+         *     }
+         *   ]
+         * }
+         */
+        export interface SubmissionEntity {
+            [name: string]: any;
+            _schema: "submission";
+            /**
+             * Readable description of the submission. Will be used as the title if passed
+             */
+            description?: string;
+            /**
+             * Files to attach to Submission Entity as a relation (s3refs from File API)
+             *
+             */
+            files?: {
+                [name: string]: any;
+                s3ref: /* S3 Reference from File API */ S3Reference;
+                /**
+                 * Override the file name
+                 */
+                filename?: string;
+                /**
+                 * List of tags for File entities
+                 */
+                _tags?: string[];
+                /**
+                 * List of relation labels for File attachments
+                 */
+                relation_tags?: string[];
+            }[];
+        }
+        export interface SubmissionNonce {
+            nonce: string;
+            submission_id: string;
+            organization_id: string;
+            ttl?: number;
+        }
+        /**
+         * Holds content and meta information
+         */
+        export interface SubmissionPayload {
+            /**
+             * organization id – defaults to token value
+             * example:
+             * 123
+             */
+            organization_id?: string;
+            /**
+             * journey submit uid
+             * example:
+             * 123
+             */
+            journey_submit_id?: string;
+            /**
+             * type of source, e.g. journey or frontend
+             * example:
+             * journey
+             */
+            source_type: string;
+            /**
+             * identifier for source e.g. journey ID or frontend ID
+             * example:
+             * ce99875f-fba9-4fe2-a8f9-afaf52059051
+             */
+            source_id: string;
+            /**
+             * Opt-ins to create from submission
+             *
+             */
+            opt_ins?: [
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?,
+                OptIn?
+            ];
+            /**
+             * Entities to create from submission
+             *
+             */
+            entities: [
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?,
+                /**
+                 * The submission entity to create
+                 * example:
+                 * {
+                 *   "_schema": "submission",
+                 *   "description": "Submission created via API",
+                 *   "contact_first_name": "First",
+                 *   "contact_last_name": "Last",
+                 *   "contact_email": "example@submission.com",
+                 *   "request": "I would like to know more about electric vehicles",
+                 *   "files": [
+                 *     {
+                 *       "s3ref": {
+                 *         "bucket": "epilot-user-content",
+                 *         "key": "temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
+                 *       },
+                 *       "filename": "document.pdf"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                SubmissionEntity?
+            ];
+            /**
+             * Related Ivy Opportunity Ids
+             */
+            _ivy_opportunity_ids?: [
+                string,
+                ...string[]
+            ];
+        }
+    }
+}
+declare namespace Paths {
+    namespace CreateSubmission {
+        export type RequestBody = /* Holds content and meta information */ Components.Schemas.SubmissionPayload;
+        namespace Responses {
+            export interface $201 {
+            }
+        }
+    }
+    namespace GetNonce {
+        namespace Parameters {
+            export type NonceId = string;
+        }
+        export interface PathParameters {
+            nonce_id: Parameters.NonceId;
+        }
+        namespace Responses {
+            export interface $200 {
+                nonce: string;
+                submission_id: string;
+                organization_id: string;
+                ttl?: number;
+                /**
+                 * example:
+                 * true
+                 */
+                exists?: boolean;
+            }
+        }
+    }
+}
+
+
+interface OperationMethods {
+  /**
+   * createSubmission - createSubmission
+   * 
+   * Creates a submission from a public facing Journey
+   * 
+   */
+  'createSubmission'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateSubmission.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateSubmission.Responses.$201>
+  /**
+   * getNonce - Check if a nonce was already used (aka exists in storage)
+   * 
+   * Returns { exists: boolean } along some meta data
+   */
+  'getNonce'(
+    parameters?: Parameters<Paths.GetNonce.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetNonce.Responses.$200>
+}
+
+interface PathsDictionary {
+  ['/v1/submission/submissions']: {
+    /**
+     * createSubmission - createSubmission
+     * 
+     * Creates a submission from a public facing Journey
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateSubmission.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateSubmission.Responses.$201>
+  }
+  ['/v1/submission/nonce/{nonce_id}']: {
+    /**
+     * getNonce - Check if a nonce was already used (aka exists in storage)
+     * 
+     * Returns { exists: boolean } along some meta data
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetNonce.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetNonce.Responses.$200>
+  }
+}
+
+type Client = OpenAPIClient<OperationMethods, PathsDictionary>
+
+
+type OptIn = Components.Schemas.OptIn;
+type S3Reference = Components.Schemas.S3Reference;
+type SubmissionEntity = Components.Schemas.SubmissionEntity;
+type SubmissionNonce = Components.Schemas.SubmissionNonce;
+type SubmissionPayload = Components.Schemas.SubmissionPayload;
+
+export type { Client as C, OperationMethods as O, PathsDictionary as P, S3Reference as S, OptIn as a, SubmissionEntity as b, SubmissionNonce as c, SubmissionPayload as d };