Skip to content

chore(customer-portal-client): export endpoints (MO-2626) #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ajamuar merged 1 commit into from
Jul 6, 2026
Merged

chore(customer-portal-client): export endpoints (MO-2626) #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/customer-portal-client-entity-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@epilot/customer-portal-client": minor
---

Update customer-portal export endpoints to the column-config contract (MO-2626)

- `createExport` (`POST /v1/portal/exports`) — now takes a JSON body with required `schema` and ordered `columns` (new `PortalDataExportColumn` schema: key, localized header, source path/attribute, formatter, enum_labels), plus optional `search`, `expand_over` and `language`. Replaces the earlier draft that only accepted a `language` query param.
- `getExport` (`GET /v1/portal/exports/{jobId}`) — unchanged; poll status (`queued`/`running`/`ready`/`failed`/`expired`) and pick up the short-lived `downloadUrl` when ready.
11 changes: 5 additions & 6 deletions clients/customer-portal-client/src/openapi-runtime.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,12 @@
"/v1/portal/exports": {
"post": {
"operationId": "createExport",
"parameters": [
{
"in": "query",
"name": "language",
"required": false
"requestBody": {
"required": true,
"content": {
"application/json": {}
}
],
},
"responses": {}
}
},
Expand Down
150 changes: 139 additions & 11 deletions clients/customer-portal-client/src/openapi.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1170,6 +1170,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -1691,6 +1697,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -6170,6 +6182,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -6783,6 +6801,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -7098,6 +7122,63 @@ declare namespace Components {
grants?: Grant[];
pages?: Page[];
}
/**
* One column of the portal data export CSV.
*/
export interface PortalDataExportColumn {
/**
* Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.
*
* example:
* vertragsnummer
*/
key: string;
/**
* Localized header label, keyed by language (de, en).
* example:
* {
* "de": "Vertragsnummer",
* "en": "Contract number"
* }
*/
header: {
[name: string]: string;
};
/**
* Where the value comes from: relation hops from the anchor entity plus the attribute to read on the resolved entity. An empty path means the anchor itself.
*
*/
source: {
/**
* Relation hops from the anchor entity (max 3).
* example:
* [
* "customer"
* ]
*/
path?: string[];
/**
* Attribute to read on the resolved entity.
* example:
* customer_number
*/
attribute: string;
/**
* Which part of an address-typed attribute to render.
*/
address_field?: "full" | "street" | "street_number" | "postal_code" | "city" | "additional_info" | "country";
};
formatter?: "text" | "date" | "money_cents" | "enum" | "address";
/**
* Localized value maps for the enum formatter, keyed by language then raw value.
*
*/
enum_labels?: {
[name: string]: {
[name: string]: string;
};
};
}
/**
* ID of the portal
* example:
Expand Down Expand Up @@ -8282,6 +8363,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -8863,6 +8950,12 @@ declare namespace Components {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -9752,11 +9845,31 @@ declare namespace Paths {
}
}
namespace CreateExport {
namespace Parameters {
export type Language = "de" | "en";
}
export interface QueryParameters {
language?: Parameters.Language;
export interface RequestBody {
/**
* Entity schema to export (must be an allowed portal entity).
*/
schema: string;
/**
* Search parameters, same shape the entity list queries with.
*/
search?: {
q?: string;
q_fields?: string[];
filters?: {
[key: string]: any;
}[];
filters_context?: {
[key: string]: any;
}[];
sort?: any;
};
/**
* Ordered column definitions; order is the CSV column order.
*/
columns: /* One column of the portal data export CSV. */ Components.Schemas.PortalDataExportColumn[];
expand_over?: string;
language?: "de" | "en";
}
namespace Responses {
export interface $202 {
Expand Down Expand Up @@ -11915,6 +12028,12 @@ declare namespace Paths {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -12527,6 +12646,12 @@ declare namespace Paths {
* true
*/
require_symbols?: boolean;
/**
* Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan.
* example:
* 3
*/
password_history_size?: number;
};
};
/**
Expand Down Expand Up @@ -15861,11 +15986,12 @@ export interface OperationMethods {
/**
* createExport - createExport
*
* Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.
* Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.
*
*/
'createExport'(
parameters?: Parameters<Paths.CreateExport.QueryParameters> | null,
data?: any,
parameters?: Parameters<UnknownParamsObject> | null,
data?: Paths.CreateExport.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreateExport.Responses.$202>
/**
Expand Down Expand Up @@ -17563,11 +17689,12 @@ export interface PathsDictionary {
/**
* createExport - createExport
*
* Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.
* Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.
*
*/
'post'(
parameters?: Parameters<Paths.CreateExport.QueryParameters> | null,
data?: any,
parameters?: Parameters<UnknownParamsObject> | null,
data?: Paths.CreateExport.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreateExport.Responses.$202>
}
Expand Down Expand Up @@ -19535,6 +19662,7 @@ export type PageRequest = Components.Schemas.PageRequest;
export type PaymentWidget = Components.Schemas.PaymentWidget;
export type PortalConfig = Components.Schemas.PortalConfig;
export type PortalConfigV3 = Components.Schemas.PortalConfigV3;
export type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
export type PortalId = Components.Schemas.PortalId;
export type PortalUser = Components.Schemas.PortalUser;
export type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
Expand Down
Loading
Loading