Skip to content

feat(customer-portal-client): add createPortalUserEntity and patch entity endpoints #408

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
flixlix merged 2 commits into from
Jun 30, 2026
Merged

feat(customer-portal-client): add createPortalUserEntity and patch entity endpoints #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a036bc3
feat(customer-portal-client): add createPortalUserEntity and patch en…
flixlix Jun 30, 2026
2444e6e
chore(customer-portal-client): regenerate TS types for new entity end…
flixlix Jun 30, 2026
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
45 changes: 45 additions & 0 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 @@ -1750,6 +1750,51 @@
"responses": {}
}
},
"/v2/portal/entity/{slug}": {
"post": {
"operationId": "createPortalUserEntity",
"deprecated": true,
"parameters": [
{
"in": "path",
"name": "slug",
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {}
}
},
"responses": {}
}
},
"/v2/portal/entity/{slug}/{id}": {
"patch": {
"operationId": "patchPortalUserEntity",
"deprecated": true,
"parameters": [
{
"in": "path",
"name": "slug",
"required": true
},
{
"in": "path",
"name": "id",
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {}
}
},
"responses": {}
}
},
"/v2/portal/can-trigger-portal-flow": {
"post": {
"operationId": "canTriggerPortalFlow",
Expand Down
104 changes: 104 additions & 0 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 @@ -9267,6 +9267,30 @@ declare namespace Paths {
export type $500 = Components.Responses.InternalServerError;
}
}
namespace CreatePortalUserEntity {
namespace Parameters {
/**
* example:
* asset
*/
export type Slug = "asset";
}
export interface PathParameters {
slug: /**
* example:
* asset
*/
Parameters.Slug;
}
export type RequestBody = Components.Schemas.Entity;
namespace Responses {
export type $201 = /* Response for entity get request */ Components.Schemas.EntityResponse;
export type $400 = Components.Responses.InvalidRequest;
export type $401 = Components.Responses.Unauthorized;
export type $403 = Components.Responses.Forbidden;
export type $500 = Components.Responses.InternalServerError;
}
}
namespace CreateUser {
namespace Parameters {
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
Expand Down Expand Up @@ -13593,6 +13617,38 @@ declare namespace Paths {
export type $500 = Components.Responses.InternalServerError;
}
}
namespace PatchPortalUserEntity {
namespace Parameters {
export type Id = /**
* Entity ID
* example:
* 5da0a718-c822-403d-9f5d-20d4584e0528
*/
Components.Schemas.EntityId /* uuid */;
/**
* example:
* asset
*/
export type Slug = "asset";
}
export interface PathParameters {
slug: /**
* example:
* asset
*/
Parameters.Slug;
id: Parameters.Id;
}
export type RequestBody = Components.Schemas.Entity;
namespace Responses {
export type $200 = /* Response for entity get request */ Components.Schemas.EntityResponse;
export type $400 = Components.Responses.InvalidRequest;
export type $401 = Components.Responses.Unauthorized;
export type $403 = Components.Responses.Forbidden;
export type $404 = Components.Responses.NotFound;
export type $500 = Components.Responses.InternalServerError;
}
}
namespace PortalProxyExecute {
export interface RequestBody {
/**
Expand Down Expand Up @@ -16092,6 +16148,28 @@ export interface OperationMethods {
data?: Paths.SearchPortalUserEntities.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
/**
* createPortalUserEntity - createPortalUserEntity
*
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
* Create a single entity on behalf of a portal user. The schema slug is passed in the path and must be one of the supported (experimental) schemas; field-level permissions are enforced by the caller's role grants. The request body is the entity to create (its attributes); the created entity is automatically related to the caller's contact.
*/
'createPortalUserEntity'(
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
data?: Paths.CreatePortalUserEntity.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
/**
* patchPortalUserEntity - patchPortalUserEntity
*
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
* Partially update a single entity on behalf of a portal user. The schema slug and entity id are passed in the path; the schema must be one of the supported (experimental) schemas. Field-level permissions are enforced by the caller's role grants (use null to clear a field, e.g. external_id). The target entity must already be owned by the caller's contact.
*/
'patchPortalUserEntity'(
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
data?: Paths.PatchPortalUserEntity.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
/**
* canTriggerPortalFlow - canTriggerPortalFlow
*
Expand Down Expand Up @@ -17850,6 +17928,32 @@ export interface PathsDictionary {
config?: AxiosRequestConfig
): OperationResponse<Paths.SearchPortalUserEntities.Responses.$200>
}
['/v2/portal/entity/{slug}']: {
/**
* createPortalUserEntity - createPortalUserEntity
*
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
* Create a single entity on behalf of a portal user. The schema slug is passed in the path and must be one of the supported (experimental) schemas; field-level permissions are enforced by the caller's role grants. The request body is the entity to create (its attributes); the created entity is automatically related to the caller's contact.
*/
'post'(
parameters?: Parameters<Paths.CreatePortalUserEntity.PathParameters> | null,
data?: Paths.CreatePortalUserEntity.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.CreatePortalUserEntity.Responses.$201>
}
['/v2/portal/entity/{slug}/{id}']: {
/**
* patchPortalUserEntity - patchPortalUserEntity
*
* **EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.
* Partially update a single entity on behalf of a portal user. The schema slug and entity id are passed in the path; the schema must be one of the supported (experimental) schemas. Field-level permissions are enforced by the caller's role grants (use null to clear a field, e.g. external_id). The target entity must already be owned by the caller's contact.
*/
'patch'(
parameters?: Parameters<Paths.PatchPortalUserEntity.PathParameters> | null,
data?: Paths.PatchPortalUserEntity.RequestBody,
config?: AxiosRequestConfig
): OperationResponse<Paths.PatchPortalUserEntity.Responses.$200>
}
['/v2/portal/can-trigger-portal-flow']: {
/**
* canTriggerPortalFlow - canTriggerPortalFlow
Expand Down
150 changes: 150 additions & 0 deletions clients/customer-portal-client/src/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7034,6 +7034,156 @@
}
}
},
"/v2/portal/entity/{slug}": {
"post": {
"operationId": "createPortalUserEntity",
"summary": "createPortalUserEntity",
"description": "**EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.\nCreate a single entity on behalf of a portal user. The schema slug is passed in the path and must be one of the supported (experimental) schemas; field-level permissions are enforced by the caller's role grants. The request body is the entity to create (its attributes); the created entity is automatically related to the caller's contact.",
"deprecated": true,
"tags": [
"ECP"
],
"security": [
{
"PortalAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "slug",
"description": "Entity schema slug to create. Limited to the supported (experimental) schemas, currently `asset`.",
"required": true,
"schema": {
"type": "string",
"enum": [
"asset"
],
"example": "asset"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Entity"
},
"example": {
"title": "PV Inverter",
"manufacturer": "SMA",
"external_id": "device-123"
}
}
}
},
"responses": {
"201": {
"description": "The entity has been created successfully for the portal user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/v2/portal/entity/{slug}/{id}": {
"patch": {
"operationId": "patchPortalUserEntity",
"summary": "patchPortalUserEntity",
"description": "**EXPERIMENTAL — do not rely on this endpoint.** It is unstable, currently limited to the `asset` schema, and may change or be removed without notice; third parties must not build on it yet.\nPartially update a single entity on behalf of a portal user. The schema slug and entity id are passed in the path; the schema must be one of the supported (experimental) schemas. Field-level permissions are enforced by the caller's role grants (use null to clear a field, e.g. external_id). The target entity must already be owned by the caller's contact.",
"deprecated": true,
"tags": [
"ECP"
],
"security": [
{
"PortalAuth": []
}
],
"parameters": [
{
"in": "path",
"name": "slug",
"description": "Entity schema slug to update. Limited to the supported (experimental) schemas, currently `asset`.",
"required": true,
"schema": {
"type": "string",
"enum": [
"asset"
],
"example": "asset"
}
},
{
"in": "path",
"name": "id",
"description": "ID of the entity to update. Must already be owned by the caller's contact.",
"required": true,
"schema": {
"$ref": "#/components/schemas/EntityId"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Entity"
},
"example": {
"external_id": null
}
}
}
},
"responses": {
"200": {
"description": "The entity has been updated successfully for the portal user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/v2/portal/can-trigger-portal-flow": {
"post": {
"operationId": "canTriggerPortalFlow",
Expand Down
Loading