@ampeco/public-api-mcp 3.244.2 → 3.245.0

package/dist/generated/build-stats.json

@@ -1,13 +1,13 @@
 {
   "totalEndpoints": 640,
-  "originalSize": 5774967,
-  "optimizedSize": 1609217,
-  "reductionPercent": 72.13,
-  "buildDuration": 1481,
+  "originalSize": 5796134,
+  "optimizedSize": 1619628,
+  "reductionPercent": 72.06,
+  "buildDuration": 1326,
   "responseSchemas": {
     "total": 640,
     "withSchemas": 640,
-    "totalSchemaSize": 3295598,
-    "averageSchemaSize": 5149
+    "totalSchemaSize": 3303477,
+    "averageSchemaSize": 5162
   }
 }

package/dist/generated/endpoints.json

@@ -10966,7 +10966,7 @@
       "method": "PATCH",
       "operationId": "chargePointUpdate",
       "summary": "Charge Point / Update",
-      "description": "Update a charge point",
+      "description": "Update a charge point. The update is rejected with 409 while it would leave the charge point in a state its configuration forbids — for example removing the electricity rate while a reimbursement policy that resolves the rate from the charge point is attached. Replacing the electricity rate with another valid rate is allowed.",
       "tags": [
         "resource / charge points"
       ],
@@ -11010,7 +11010,7 @@
                 "electricityRateId": {
                   "type": "integer",
                   "nullable": true,
-                  "description": "If there is Electricity rate set to the Charge point the electricity cost for each charging session would be tracked. Dynamic electricity rates could not be selected, only ones created in the resource / electricity-rate."
+                  "description": "If there is Electricity rate set to the Charge point the electricity cost for each charging session would be tracked. Dynamic electricity rates could not be selected, only ones created in the resource / electricity-rate. Set to `null` to clear the reference. Clearing the rate is rejected with HTTP 409 while a reimbursement policy that resolves the rate from the charge point is attached. Replacing it with another valid rate is allowed."
                 },
                 "electricityCostReimbursementIntegrationId": {
                   "type": "integer",
@@ -11358,7 +11358,7 @@
                   "properties": {
                     "enabled": {
                       "type": "boolean",
-                      "description": "When `true`, same-operator users without a sharing invite for this charge point can authorise sessions, and the owner is reimbursed by the operator for public-access sessions. Accepted independently of `roamingPublishEnabled`. Preconditions: enabling requires all three of (1) a location with country and postal code, (2) the tariff group assigned to the charge point's EVSEs (`tariffGroupId`) contains at least one tariff, and (3) `reimbursementPolicyId` references an active operator-owned reimbursement policy. A request that enables public sharing while any precondition is missing returns HTTP 422 with a `publicSharing.enabled` error naming each missing precondition."
+                      "description": "When `true`, same-operator users without a sharing invite for this charge point can authorise sessions, and the owner is reimbursed by the operator for public-access sessions. Accepted independently of `roamingPublishEnabled`. Preconditions: enabling requires each of (1) a location with country and postal code, (2) the tariff group assigned to the charge point's EVSEs (`tariffGroupId`) contains at least one tariff, and (3) `reimbursementPolicyId` references an active operator-owned reimbursement policy. A request that enables public sharing while any of those three preconditions is missing returns HTTP 422 with a `publicSharing.enabled` error naming each missing precondition."
                     },
                     "roamingPublishEnabled": {
                       "type": "boolean",
@@ -11367,7 +11367,7 @@
                     "reimbursementPolicyId": {
                       "type": "integer",
                       "nullable": true,
-                      "description": "References the reimbursement policy used to reimburse the charge point owner for public-access sessions. Set to `null` to clear the reference."
+                      "description": "References the reimbursement policy used to reimburse the charge point owner for public-access sessions. Set to `null` to clear the reference. Selecting a policy that resolves the rate from the charge point requires the charge point to have an electricity rate assigned, whether or not the same request enables public sharing; that state conflict returns HTTP 409 rather than a validation error. Replacing the electricity rate with another valid rate is allowed."
                     }
                   },
                   "description": "Public access controls for a `personal` charge point. Only applicable to `personal` charge points and requires the `home-charging-reimbursement` feature."
@@ -11390,6 +11390,9 @@
         "404": {
           "description": "The record is not found"
         },
+        "409": {
+          "description": "The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried."
+        },
         "422": {
           "description": "The payload you provided is invalid"
         },
@@ -13048,7 +13051,7 @@
       "method": "POST",
       "operationId": "personalSmartChargingPreferencesUpdate",
       "summary": "Charge Point / Personal smart charging preferences / Update",
-      "description": "Update personal smart charging preferences",
+      "description": "Update personal smart charging preferences. Selecting the `charger_electricity_rate` type assigns the submitted `electricityRateId` to the charge point. Only two payloads remove the charge point's electricity rate, and both are subject to the 409 conflict described below. Sending `preferences.trackElectricityCosts` as `null` or as an empty object on `user_controlled_schedule` dissociates a rate that tracking electricity costs had created, while the request is handled. Leaving the charge point with no dynamic-price integration (`octopus_agile`, `octopus_go`, `nordpool`) while its current rate was created by one unlinks that rate asynchronously, after the response. Switching away from `charger_electricity_rate` to another type, and sending `enabled: false`, both leave the assigned rate in place. The update is rejected with 409 while removing the electricity rate would leave a reimbursement policy that resolves the rate from the charge point without a rate, whether the payload clears `preferences.trackElectricityCosts` or leaves no dynamic-price integration. The whole request is rejected: the submitted preferences are not stored, and the charge point keeps both its electricity rate and the dynamic-price integration the payload would have removed. Submitting `charger_electricity_rate` with a different `electricityRateId` replaces the rate and is allowed. The conflict clears only when the configuration changes: detach the policy, or keep an electricity rate on the charge point.",
       "tags": [
         "resource / charge points"
       ],
@@ -13685,6 +13688,9 @@
         "404": {
           "description": "The record is not found"
         },
+        "409": {
+          "description": "The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried."
+        },
         "422": {
           "description": "The payload you provided is invalid"
         },
@@ -19100,7 +19106,7 @@
       "method": "PUT",
       "operationId": "electricityRateUpdateDeprecated",
       "summary": "Electricity rate / Update",
-      "description": "Update a Electricity rate",
+      "description": "Update a Electricity rate. The update is rejected with 409 while another process is modifying the same rate; that conflict clears on its own and the request may be retried.",
       "deprecated": true,
       "tags": [
         "resource / electricity rates"
@@ -19309,7 +19315,7 @@
       "method": "DELETE",
       "operationId": "electricityRateDeleteDeprecated",
       "summary": "Electricity rate / Delete",
-      "description": "Delete a Electricity rate",
+      "description": "Delete a Electricity rate. Deletion is rejected with 409 while the rate is assigned to a charge point that has a reimbursement policy resolving the rate from the charge point. That conflict clears only when the configuration changes — either the policy is detached or the charge point is assigned another electricity rate; replacing the rate on the charge point is allowed.",
       "deprecated": true,
       "tags": [
         "resource / electricity rates"
@@ -19335,6 +19341,9 @@
         },
         "404": {
           "description": "The record is not found"
+        },
+        "409": {
+          "description": "The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried."
         }
       }
     },
@@ -19520,7 +19529,7 @@
       "method": "DELETE",
       "operationId": "electricityRateDelete",
       "summary": "Electricity rate / Delete",
-      "description": "Delete a Electricity rate",
+      "description": "Delete a Electricity rate. Deletion is rejected with 409 while the rate is assigned to a charge point that has a reimbursement policy resolving the rate from the charge point. That conflict clears only when the configuration changes — either the policy is detached or the charge point is assigned another electricity rate; replacing the rate on the charge point is allowed.",
       "tags": [
         "resource / electricity rates"
       ],
@@ -19545,6 +19554,9 @@
         },
         "404": {
           "description": "The record is not found"
+        },
+        "409": {
+          "description": "The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried."
         }
       }
     },
@@ -19553,7 +19565,7 @@
       "method": "PATCH",
       "operationId": "electricityRateUpdate",
       "summary": "Electricity rate / Update",
-      "description": "Update a Electricity rate",
+      "description": "Update a Electricity rate. The update is rejected with 409 while another process is modifying the same rate; that conflict clears on its own and the request may be retried.",
       "tags": [
         "resource / electricity rates"
       ],
@@ -38084,7 +38096,7 @@
                   "properties": {
                     "policyId": {
                       "type": "integer",
-                      "description": "The home-charging reimbursement policy attached to the invite. Must reference an active policy that belongs to the partner or has no partner. Omitted from the response when no policy is attached."
+                      "description": "The home-charging reimbursement policy attached to the invite. Must reference an active policy that belongs to the partner or has no partner. Omitted from the response when no policy is attached. When the policy resolves the electricity rate from the charge point, it is applied only to the invited user's charge points that have an electricity rate assigned. Charge points without one are skipped and the request still succeeds; assign an electricity rate to those charge points and re-apply the policy to cover them."
                     },
                     "restrictions": {
                       "type": "object",
@@ -38283,7 +38295,7 @@
                     "policyId": {
                       "type": "integer",
                       "nullable": true,
-                      "description": "The home-charging reimbursement policy ID to attach. Must reference an active policy that belongs to the partner or has no partner. Send `null` to detach any policy; omit the field to leave the current value unchanged."
+                      "description": "The home-charging reimbursement policy ID to attach. Must reference an active policy that belongs to the partner or has no partner. Send `null` to detach any policy; omit the field to leave the current value unchanged. When the policy resolves the electricity rate from the charge point, it is applied only to the invited user's charge points that have an electricity rate assigned. Charge points without one are skipped and the request still succeeds; assign an electricity rate to those charge points and re-apply the policy to cover them."
                     },
                     "restrictions": {
                       "type": "object",
@@ -40812,6 +40824,33 @@
                   "type": "string",
                   "description": "The Partner's business name is used when showing the name of the Partner to EV drivers and admin users. If not provided, the `name` will be used instead."
                 },
+                "reimbursement": {
+                  "type": "object",
+                  "properties": {
+                    "enabled": {
+                      "type": "boolean",
+                      "description": "Whether home-charging reimbursement is enabled for the Partner. Disabling it stops future reimbursement for the Partner. The reimbursement policies that are currently active for it remain attached but become ineligible, and the invites attached to them stop producing reimbursement records. Reimbursement records and reports that already exist are not affected."
+                    },
+                    "payoutMode": {
+                      "type": "string",
+                      "enum": [
+                        "operator_managed",
+                        "partner_managed"
+                      ],
+                      "description": "Determines who pays out the home-charging reimbursement to the drivers: - **operator_managed**: The operator handles the payouts on behalf of the Partner. - **partner_managed**: The Partner handles the payouts to their own drivers."
+                    },
+                    "cycle": {
+                      "type": "string",
+                      "enum": [
+                        "monthly",
+                        "quarterly",
+                        "annual"
+                      ],
+                      "description": "How often the home-charging reimbursement is calculated and reported: - **monthly**: Reimbursement is processed every month. - **quarterly**: Reimbursement is processed every three months. - **annual**: Reimbursement is processed every year."
+                    }
+                  },
+                  "description": "Home-charging reimbursement settings of the Partner. Submitting this object while the home-charging reimbursement feature is disabled for the operator is rejected with a `422` response."
+                },
                 "notifications": {
                   "type": "object",
                   "properties": {
@@ -41840,6 +41879,34 @@
                       "type": "string",
                       "description": "The Partner's business name is used when showing the name of the Partner to EV drivers and admin users."
                     },
+                    "reimbursement": {
+                      "type": "object",
+                      "properties": {
+                        "enabled": {
+                          "type": "boolean",
+                          "description": "Whether home-charging reimbursement is enabled for the Partner. Disabling it stops future reimbursement for the Partner. The reimbursement policies that are currently active for it remain attached but become ineligible, and the invites attached to them stop producing reimbursement records. Reimbursement records and reports that already exist are not affected."
+                        },
+                        "payoutMode": {
+                          "type": "string",
+                          "enum": [
+                            "operator_managed",
+                            "partner_managed"
+                          ],
+                          "description": "Determines who pays out the home-charging reimbursement to the drivers: - **operator_managed**: The operator handles the payouts on behalf of the Partner. - **partner_managed**: The Partner handles the payouts to their own drivers."
+                        },
+                        "cycle": {
+                          "type": "string",
+                          "enum": [
+                            "monthly",
+                            "quarterly",
+                            "annual"
+                          ],
+                          "nullable": true,
+                          "description": "How often the home-charging reimbursement is calculated and reported: - **monthly**: Reimbursement is processed every month. - **quarterly**: Reimbursement is processed every three months. - **annual**: Reimbursement is processed every year."
+                        }
+                      },
+                      "description": "Home-charging reimbursement settings of the Partner. Submitting this object while the home-charging reimbursement feature is disabled for the operator is rejected with a `422` response."
+                    },
                     "notifications": {
                       "type": "object",
                       "properties": {
@@ -48580,7 +48647,7 @@
                     "policy",
                     "charge_point"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The rate set by the owner on their personal charge point in the mobile app provides the rate. `electricityRateId` must not be set."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
                 }
               }
             }
@@ -48634,7 +48701,7 @@
                     "policy",
                     "charge_point"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The rate set by the owner on their personal charge point in the mobile app provides the rate. `electricityRateId` must not be set."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
                 },
                 "validityStartsOn": {
                   "type": "string",
@@ -48757,7 +48824,7 @@
       "method": "PATCH",
       "operationId": "reimbursementPolicyUpdate",
       "summary": "Reimbursement policy / Update",
-      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Update a reimbursement policy.",
+      "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Update a reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the `charge_point` rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy. Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing `partnerId` on a policy that is already assigned to partner invites or has active charge point attachments, which returns a `partnerId` validation error rather than a 409. Deactivated attachments do not block the change.",
       "tags": [
         "resource / reimbursement policies"
       ],
@@ -48778,7 +48845,7 @@
                     "policy",
                     "charge_point"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The rate set by the owner on their personal charge point in the mobile app provides the rate. `electricityRateId` must not be set."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy."
                 },
                 "validityStartsOn": {
                   "type": "string",
@@ -48825,6 +48892,9 @@
         "404": {
           "description": "The record is not found"
         },
+        "409": {
+          "description": "The request could not be completed due to a conflict with the current state of the resource. The operation may succeed if retried."
+        },
         "422": {
           "description": "The payload you provided is invalid"
         },
@@ -51884,6 +51954,11 @@
                       "description": "Filter sessions by roaming connection. Accepts one or more roaming connection IDs."
                     }
                   }
+                },
+                "customFields": {
+                  "type": "string",
+                  "example": "filter[customFields.invoiceReference]=INV-42",
+                  "description": "Filter sessions by custom fields defined for the session resource. Add one literal `customFields.<identifier>` key to the existing `filter` object for each criterion. The identifier suffix is administrator-defined and is not enumerated in this schema. Use a scalar for boolean, text, email, and URL fields. Boolean accepts booleans and integer `1` or `0`, as well as the strings `\"true\"`, `\"false\"`, `\"1\"`, and `\"0\"`. Text, email, and URL accept strings and use contains matching that is case- and accent-insensitive; backslashes, `%`, and `_` are treated literally rather than as pattern syntax. Use `from`, `to`, or both below the dotted key for number, date, and date-time fields. Both bounds are inclusive. Number bounds are decimal strings from `-99999999999999.999999` through `99999999999999.999999` with at most six decimal places; comparisons preserve submitted and stored decimal precision without rounding. Date bounds use `YYYY-MM-DD` and compare calendar dates without time-zone conversion. Date-time bounds use ISO 8601; offsets are normalized to UTC, and an omitted offset is interpreted as UTC. Multiple identifiers combine with AND. Empty scalar criteria and ranges whose bounds are empty are ignored. An identifier resolves only to its current active definition, so values belonging to a deleted definition never match if its identifier is reused. Unknown, inaccessible, tenant-disabled, resource-disabled, deleted, and otherwise unavailable identifiers all return the same non-disclosing `404` response. An active accessible custom field whose filtering is disabled returns `422` with `Custom field \"{identifier}\" is not filterable for resource \"{resource}\".` Malformed objects or values, a criterion shape that is invalid for the field type, and a range whose `from` bound is greater than its `to` bound return `422`. Examples: `filter[customFields.invoiceReference]=INV-42` and `filter[customFields.capacity][from]=10&filter[customFields.capacity][to]=20`. URL-encode the query keys and values when sending the request."
                 }
               }
             }
@@ -51928,8 +52003,11 @@
         "403": {
           "description": "You do not have permission to perform the action"
         },
+        "404": {
+          "description": "The requested custom field filter identifier is unavailable"
+        },
         "422": {
-          "description": "The payload you provided is invalid"
+          "description": "The request contains invalid criteria, including malformed or non-filterable custom field filters"
         },
         "429": {
           "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
@@ -52031,7 +52109,7 @@
       "path": "/public-api/resources/sessions/v1.0/{session}",
       "method": "PATCH",
       "operationId": "sessionUpdate",
-      "summary": "Session / update custom fields",
+      "summary": "Session / Update",
       "description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed. Update the applicable custom field values of a session without changing any other session properties.",
       "tags": [
         "resource / sessions"
@@ -71587,7 +71665,7 @@
   ],
   "info": {
     "title": "Public API",
-    "version": "3.244.2",
+    "version": "3.245.0",
     "description": "The Public API provides server-to-server integration capabilities for your EV charging platform.\n\n**Authentication.** Existing integrations continue to work unchanged — long-lived UUID admin tokens are sent in `Authorization: Bearer ...` with no exchange required. Two security schemes are documented for OpenAPI client tooling, both resulting in the same Bearer header at the wire level:\n   - `bearerAuth` — the token in the `Authorization: Bearer ...` header is either a long-lived UUID admin token (issued via the admin UI, used directly) or a short-lived access token previously obtained via OAuth.\n   - `oauth2ClientCredentials` - a `client_id` / `client_secret` pair should be exchanged for a short-lived access token at `/public-api/oauth/token` per RFC 6749 Section 4.4 (Client Credentials Grant), and the short-lived token should be used in the `Authorization: Bearer ...` header. The OAuth `client_secret` itself cannot be sent directly as a bearer token — it must be exchanged first.\n"
   },
   "servers": [
@@ -71601,18 +71679,18 @@
       }
     }
   ],
-  "buildTimestamp": "2026-09-04T13:58:39.395Z",
+  "buildTimestamp": "2026-09-08T11:33:02.856Z",
   "stats": {
     "totalEndpoints": 640,
-    "originalSize": 5774967,
-    "optimizedSize": 1609217,
-    "reductionPercent": 72.13,
-    "buildDuration": 1481,
+    "originalSize": 5796134,
+    "optimizedSize": 1619628,
+    "reductionPercent": 72.06,
+    "buildDuration": 1326,
     "responseSchemas": {
       "total": 640,
       "withSchemas": 640,
-      "totalSchemaSize": 3295598,
-      "averageSchemaSize": 5149
+      "totalSchemaSize": 3303477,
+      "averageSchemaSize": 5162
     }
   }
 }