@ogcio/building-blocks-sdk 0.2.17 → 0.2.19

package/src/client/clients/profile/open-api-definition.json

@@ -1609,8 +1609,9 @@
     },
     "/api/v1/profiles/imports": {
       "get": {
+        "operationId": "listProfileImports",
         "tags": [
-          "profiles"
+          "Profiles"
         ],
         "description": "List profile imports with pagination",
         "parameters": [
@@ -1982,61 +1983,101 @@
                   "type": "object",
                   "properties": {
                     "data": {
-                      "type": "array",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "email": {
-                            "allOf": [
-                              {
+                      "type": "object",
+                      "properties": {
+                        "organisationId": {
+                          "type": "string"
+                        },
+                        "status": {
+                          "type": "string"
+                        },
+                        "createdAt": {
+                          "format": "date-time",
+                          "type": "string"
+                        },
+                        "metadata": {
+                          "type": "object",
+                          "properties": {
+                            "filename": {
+                              "type": "string"
+                            },
+                            "mimetype": {
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "filename",
+                            "mimetype"
+                          ]
+                        },
+                        "details": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "email": {
+                                "allOf": [
+                                  {
+                                    "minLength": 1,
+                                    "type": "string"
+                                  },
+                                  {
+                                    "format": "email",
+                                    "type": "string"
+                                  }
+                                ]
+                              },
+                              "firstName": {
                                 "minLength": 1,
                                 "type": "string"
                               },
-                              {
-                                "format": "email",
+                              "lastName": {
+                                "minLength": 1,
+                                "type": "string"
+                              },
+                              "city": {
+                                "type": "string"
+                              },
+                              "address": {
+                                "type": "string"
+                              },
+                              "phone": {
+                                "type": "string"
+                              },
+                              "dateOfBirth": {
+                                "format": "date",
+                                "type": "string"
+                              },
+                              "ppsn": {
+                                "type": "string"
+                              },
+                              "preferredLanguage": {
+                                "type": "string",
+                                "enum": [
+                                  "en",
+                                  "ga"
+                                ],
+                                "default": "en"
+                              },
+                              "status": {
                                 "type": "string"
                               }
+                            },
+                            "required": [
+                              "email",
+                              "firstName",
+                              "lastName",
+                              "status"
                             ]
-                          },
-                          "firstName": {
-                            "minLength": 1,
-                            "type": "string"
-                          },
-                          "lastName": {
-                            "minLength": 1,
-                            "type": "string"
-                          },
-                          "city": {
-                            "type": "string"
-                          },
-                          "address": {
-                            "type": "string"
-                          },
-                          "phone": {
-                            "type": "string"
-                          },
-                          "dateOfBirth": {
-                            "format": "date",
-                            "type": "string"
-                          },
-                          "ppsn": {
-                            "type": "string"
-                          },
-                          "preferredLanguage": {
-                            "type": "string",
-                            "enum": [
-                              "en",
-                              "ga"
-                            ],
-                            "default": "en"
                           }
-                        },
-                        "required": [
-                          "email",
-                          "firstName",
-                          "lastName"
-                        ]
-                      }
+                        }
+                      },
+                      "required": [
+                        "organisationId",
+                        "status",
+                        "metadata",
+                        "details"
+                      ]
                     },
                     "metadata": {
                       "type": "object",

package/src/client/clients/profile/schema.ts

@@ -171,134 +171,7 @@ export interface paths {
             cookie?: never;
         };
         /** @description List profile imports with pagination */
-        get: {
-            parameters: {
-                query?: {
-                    organizationId?: string;
-                    source?: "csv" | "json";
-                    /** @description If set, the endpoint searches for profile imports with this value in the metadata.filename */
-                    search?: string;
-                    /** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
-                    offset?: string;
-                    /** @description Indicates the maximum number (100) of items that will be returned in a single request */
-                    limit?: string;
-                };
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Default Response */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            data: {
-                                /** Format: uuid */
-                                id: string;
-                                organisationId?: string;
-                                status: string;
-                                source: "csv" | "json";
-                                metadata?: {
-                                    filename: string;
-                                    mimetype: string;
-                                };
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                            }[];
-                            metadata?: {
-                                /** @description Object containing the links to the related endpoints */
-                                links?: {
-                                    self: {
-                                        /** @description URL pointing to the request itself */
-                                        href?: string;
-                                    };
-                                    next?: {
-                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
-                                        href?: string;
-                                    };
-                                    prev?: {
-                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
-                                        href?: string;
-                                    };
-                                    first: {
-                                        /** @description URL pointing to the first page of results in a paginated response */
-                                        href?: string;
-                                    };
-                                    last: {
-                                        /** @description URL pointing to the first page of results in a paginated response */
-                                        href?: string;
-                                    };
-                                    /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
-                                    pages: {
-                                        [key: string]: {
-                                            href?: string;
-                                        };
-                                    };
-                                };
-                                /** @description Number representing the total number of available items */
-                                totalCount?: number;
-                            };
-                        };
-                    };
-                };
-                /** @description Default Response */
-                "4XX": {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @description Code used to categorize the error */
-                            code: string;
-                            /** @description Description of the error */
-                            detail: string;
-                            /** @description Unique request id. This one will be used to troubleshoot the problems */
-                            requestId: string;
-                            /** @description Name of the error type */
-                            name: string;
-                            /** @description List of the validation errors */
-                            validation?: {
-                                fieldName: string;
-                                message: string;
-                            }[];
-                            validationContext?: string;
-                            statusCode: number;
-                        };
-                    };
-                };
-                /** @description Default Response */
-                "5XX": {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @description Code used to categorize the error */
-                            code: string;
-                            /** @description Description of the error */
-                            detail: string;
-                            /** @description Unique request id. This one will be used to troubleshoot the problems */
-                            requestId: string;
-                            /** @description Name of the error type */
-                            name: string;
-                            /** @description List of the validation errors */
-                            validation?: {
-                                fieldName: string;
-                                message: string;
-                            }[];
-                            validationContext?: string;
-                            statusCode: number;
-                        };
-                    };
-                };
-            };
-        };
+        get: operations["listProfileImports"];
         put?: never;
         post?: never;
         delete?: never;
@@ -939,6 +812,134 @@ export interface operations {
             };
         };
     };
+    listProfileImports: {
+        parameters: {
+            query?: {
+                organizationId?: string;
+                source?: "csv" | "json";
+                /** @description If set, the endpoint searches for profile imports with this value in the metadata.filename */
+                search?: string;
+                /** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
+                offset?: string;
+                /** @description Indicates the maximum number (100) of items that will be returned in a single request */
+                limit?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            organisationId?: string;
+                            status: string;
+                            source: "csv" | "json";
+                            metadata?: {
+                                filename: string;
+                                mimetype: string;
+                            };
+                            /** Format: date-time */
+                            createdAt: string;
+                            /** Format: date-time */
+                            updatedAt: string;
+                        }[];
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                next?: {
+                                    /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                prev?: {
+                                    /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "5XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+        };
+    };
     getProfileImportDetails: {
         parameters: {
             query?: never;
@@ -958,21 +959,32 @@ export interface operations {
                 content: {
                     "application/json": {
                         data: {
-                            email: string;
-                            firstName: string;
-                            lastName: string;
-                            city?: string;
-                            address?: string;
-                            phone?: string;
-                            /** Format: date */
-                            dateOfBirth?: string;
-                            ppsn?: string;
-                            /**
-                             * @default en
-                             * @enum {string}
-                             */
-                            preferredLanguage: "en" | "ga";
-                        }[];
+                            organisationId: string;
+                            status: string;
+                            /** Format: date-time */
+                            createdAt?: string;
+                            metadata: {
+                                filename: string;
+                                mimetype: string;
+                            };
+                            details: {
+                                email: string;
+                                firstName: string;
+                                lastName: string;
+                                city?: string;
+                                address?: string;
+                                phone?: string;
+                                /** Format: date */
+                                dateOfBirth?: string;
+                                ppsn?: string;
+                                /**
+                                 * @default en
+                                 * @enum {string}
+                                 */
+                                preferredLanguage: "en" | "ga";
+                                status: string;
+                            }[];
+                        };
                         metadata?: {
                             /** @description Object containing the links to the related endpoints */
                             links?: {