@ogcio/building-blocks-sdk 0.2.94 → 0.2.96

package/dist/client/clients/journey/schema.d.ts

@@ -93,12 +93,16 @@ export interface paths {
         /**
          * Get journeys
          * @description Retrieve a paginated list of journeys with optional filtering by IDs, search terms, date range, and status
+         *
+         *     Required scopes: `journey:journey:read`
          */
         get: operations["getJourneys"];
         put?: never;
         /**
          * Create journey
          * @description Create a new journey with the specified configuration and steps
+         *
+         *     Required scopes: `journey:journey:write`
          */
         post: operations["createJourney"];
         delete?: never;
@@ -117,17 +121,23 @@ export interface paths {
         /**
          * Get journey by ID
          * @description Retrieve detailed information about a specific journey including all steps and connections
+         *
+         *     Required scopes: `journey:journey:read`
          */
         get: operations["getJourneyById"];
         /**
          * Update journey
          * @description Update an existing journey with new configuration and steps
+         *
+         *     Required scopes: `journey:journey:write`
          */
         put: operations["updateJourney"];
         post?: never;
         /**
          * Delete journey
          * @description Delete a journey with no existing runs
+         *
+         *     Required scopes: `journey:journey:delete`
          */
         delete: operations["deleteJourney"];
         options?: never;
@@ -135,6 +145,8 @@ export interface paths {
         /**
          * Update journey status
          * @description Update an existing journey status
+         *
+         *     Required scopes: `journey:journey:write`
          */
         patch: operations["updateJourneyStatus"];
         trace?: never;
@@ -189,6 +201,8 @@ export interface paths {
         /**
          * Get step connection by ID
          * @description Retrieve detailed information about a specific step connection
+         *
+         *     Required scopes: `journey:step:read`
          */
         get: operations["getStepConnectionById"];
         put?: never;
@@ -196,6 +210,8 @@ export interface paths {
         /**
          * Delete step connection
          * @description Delete a specific step connection by ID
+         *
+         *     Required scopes: `journey:step:write`
          */
         delete: operations["deleteStepConnection"];
         options?: never;
@@ -215,6 +231,8 @@ export interface paths {
         /**
          * Create step connection
          * @description Create a new connection between two journey steps
+         *
+         *     Required scopes: `journey:step:write`
          */
         post: operations["createStepConnection"];
         delete?: never;
@@ -233,17 +251,23 @@ export interface paths {
         /**
          * Get journey step by ID
          * @description Retrieve detailed information about a specific journey step
+         *
+         *     Required scopes: `journey:step:read`
          */
         get: operations["getJourneyStepById"];
         /**
          * Update journey step
          * @description Update an existing journey step with new configuration
+         *
+         *     Required scopes: `journey:step:write`
          */
         put: operations["updateJourneyStep"];
         post?: never;
         /**
          * Delete journey step
          * @description Delete a specific journey step by ID
+         *
+         *     Required scopes: `journey:step:write`
          */
         delete: operations["deleteJourneyStep"];
         options?: never;
@@ -263,6 +287,8 @@ export interface paths {
         /**
          * Create journey step
          * @description Create a new journey step with the specified configuration
+         *
+         *     Required scopes: `journey:step:write`
          */
         post: operations["createJourneyStep"];
         delete?: never;
@@ -281,6 +307,8 @@ export interface paths {
         /**
          * Get user runs
          * @description Retrieve all runs created by the authenticated user
+         *
+         *     Required scopes: `journey:run.self:read`
          */
         get: operations["getUserRuns"];
         put?: never;
@@ -301,6 +329,8 @@ export interface paths {
         /**
          * Get user run by ID
          * @description Retrieve detailed information about a specific run created by the authenticated user
+         *
+         *     Required scopes: `journey:run.self:read`
          */
         get: operations["getUserRunById"];
         put?: never;
@@ -321,6 +351,8 @@ export interface paths {
         /**
          * Get runs by journey ID
          * @description Retrieve all runs for a specific journey (public servant access)
+         *
+         *     Required scopes: `journey:run:read`
          */
         get: operations["getRunsByJourneyId"];
         put?: never;
@@ -341,6 +373,8 @@ export interface paths {
         /**
          * Get run by ID
          * @description Retrieve detailed information about a specific run (public servant access)
+         *
+         *     Required scopes: `journey:run:read`
          */
         get: operations["getRunById"];
         put?: never;
@@ -348,6 +382,8 @@ export interface paths {
         /**
          * Delete run
          * @description Delete a specific run by ID
+         *
+         *     Required scopes: `journey:run:delete`
          */
         delete: operations["deleteRun"];
         options?: never;
@@ -355,6 +391,8 @@ export interface paths {
         /**
          * Update run status
          * @description Update the status of a specific run
+         *
+         *     Required scopes: `journey:run:write`
          */
         patch: operations["updateRunStatus"];
         trace?: never;
@@ -369,6 +407,8 @@ export interface paths {
         /**
          * Get all runs
          * @description Retrieve all runs with pagination and filtering (public servant access)
+         *
+         *     Required scopes: `journey:run:read`
          */
         get: operations["getAllRuns"];
         put?: never;
@@ -389,6 +429,8 @@ export interface paths {
         /**
          * Get run tags
          * @description Retrieve available tags for runs based on filtering criteria
+         *
+         *     Required scopes: `journey:run:read`
          */
         get: operations["getRunTags"];
         put?: never;
@@ -411,6 +453,8 @@ export interface paths {
         /**
          * Create journey run
          * @description Create a new run for a specific journey
+         *
+         *     Required scopes: `journey:run.self:write`
          */
         post: operations["createJourneyRun"];
         delete?: never;
@@ -431,6 +475,8 @@ export interface paths {
         /**
          * Execute journey step
          * @description Execute a specific step in a journey run
+         *
+         *     Required scopes: `journey:run.self:write`
          */
         post: operations["executeJourneyStep"];
         delete?: never;
@@ -451,6 +497,8 @@ export interface paths {
         /**
          * Transition journey step
          * @description Transition from one step to another in a journey run
+         *
+         *     Required scopes: `journey:run.self:write`
          */
         post: operations["transitionJourneyStep"];
         delete?: never;
@@ -471,6 +519,8 @@ export interface paths {
         /**
          * Get journey summary
          * @description Retrieve a summary of a journey run including completion status and details
+         *
+         *     Required scopes: `journey:run.self:read`
          */
         post: operations["getJourneySummary"];
         delete?: never;
@@ -492,6 +542,8 @@ export interface paths {
         /**
          * Cleanup test resources
          * @description Clean up test resources for the organization (testing utility)
+         *
+         *     Required scopes: `test:e2e:resources_cleanup`
          */
         delete: operations["cleanupTestResources"];
         options?: never;
@@ -509,6 +561,8 @@ export interface paths {
         /**
          * List Audit Log Events
          * @description Retrieve a filtered list of audit log events for the organization. Supports filtering by event type, date range, and other criteria.
+         *
+         *     Required scopes: `journey:auditLog:read`
          */
         get: operations["listAuditLogEvents"];
         put?: never;
@@ -529,6 +583,8 @@ export interface paths {
         /**
          * Get Audit Log Event Types
          * @description Retrieve a list of available audit log event types for filtering and categorization.
+         *
+         *     Required scopes: `journey:auditLog:read`
          */
         get: operations["getAuditLogEventTypes"];
         put?: never;
@@ -549,6 +605,8 @@ export interface paths {
         /**
          * Get Audit Log Event by ID
          * @description Retrieve detailed information about a specific audit log event by its unique identifier.
+         *
+         *     Required scopes: `journey:auditLog:read`
          */
         get: operations["getAuditLogEventById"];
         put?: never;
@@ -569,6 +627,8 @@ export interface paths {
         /**
          * Export submissions for a journey
          * @description Export submissions for a journey
+         *
+         *     Required scopes: `journey:submission:read`
          */
         get: operations["exportSubmissions"];
         put?: never;
@@ -579,6 +639,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/external/user-submissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Gets the journey submissions of the user extracted from the jwt token
+         * @description Returns the journey submissions of the user who's identity is validated by the bearer token.
+         *
+         *     Required scopes: `journey:submission:external.read`
+         */
+        get: operations["getUserSubmissions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/external/user-submissions/{submissionId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Gets the submissions details. The user id linked to the submission needs to match the one on the jwt token
+         * @description Returns th journey submission details based on the submission ID.
+         *
+         *     Required scopes: `journey:submission:external.read`
+         */
+        get: operations["getUserSubmissionById"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2920,6 +3024,8 @@ export interface operations {
                 search?: string;
                 to?: string;
                 from?: string;
+                submissionFrom?: string;
+                submissionTo?: string;
                 tags?: string[] | string;
             };
             header?: never;
@@ -3021,6 +3127,8 @@ export interface operations {
                 search?: string;
                 to?: string;
                 from?: string;
+                submissionFrom?: string;
+                submissionTo?: string;
                 tags?: string[] | string;
             };
             header?: never;
@@ -3978,5 +4086,231 @@ export interface operations {
             };
         };
     };
+    getUserSubmissions: {
+        parameters: {
+            query?: {
+                offset?: number;
+                limit?: number;
+                search?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            id: string;
+                            title: {
+                                en: string;
+                                ga?: string;
+                            };
+                            description: {
+                                en: string;
+                                ga?: string;
+                            };
+                            organizationId: string;
+                            journeyId: string;
+                            status: "initiated" | "submitted" | "processing" | "completed" | "cancelled";
+                            createdAt: string;
+                            updatedAt: string;
+                        }[];
+                        metadata?: {
+                            links?: {
+                                self: {
+                                    href?: string;
+                                };
+                                next?: {
+                                    href?: string;
+                                };
+                                prev?: {
+                                    href?: string;
+                                };
+                                first: {
+                                    href?: string;
+                                };
+                                last: {
+                                    href?: string;
+                                };
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+        };
+    };
+    getUserSubmissionById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                submissionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            id: string;
+                            title: {
+                                en: string;
+                                ga?: string;
+                            };
+                            description: {
+                                en: string;
+                                ga?: string;
+                            };
+                            organizationId: string;
+                            journeyId: string;
+                            status: "initiated" | "submitted" | "processing" | "completed" | "cancelled";
+                            createdAt: string;
+                            updatedAt: string;
+                        };
+                        metadata?: {
+                            links?: {
+                                self: {
+                                    href?: string;
+                                };
+                                next?: {
+                                    href?: string;
+                                };
+                                prev?: {
+                                    href?: string;
+                                };
+                                first: {
+                                    href?: string;
+                                };
+                                last: {
+                                    href?: string;
+                                };
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+            /** @description Default Response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        code: string;
+                        detail: string;
+                        requestId: string;
+                        name: string;
+                        validation?: unknown;
+                        validationContext?: string;
+                    };
+                };
+            };
+        };
+    };
 }
 //# sourceMappingURL=schema.d.ts.map