ocpplab 0.1.2

package/dist/cjs/api/resources/locationChargerCommands/client/Client.d.ts

@@ -0,0 +1,343 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Ocpplab from "../../../index.js";
+export declare namespace LocationChargerCommandsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Send the same charger runtime command for all or some chargers in one location.
+ */
+export declare class LocationChargerCommandsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<LocationChargerCommandsClient.Options>;
+    constructor(options: LocationChargerCommandsClient.Options);
+    /**
+     * Start transaction commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationStartTransactionRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStartTransaction({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         id_tag: "TAG-RFID-001",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStartTransaction({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         id_tag: "TAG-RFID-001",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationStartTransaction(request: Ocpplab.LocationStartTransactionRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationStartTransaction;
+    /**
+     * Stop transaction commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationStopTransactionRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStopTransaction({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a"
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStopTransaction({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         transaction_id: "txn-123"
+     *     })
+     */
+    locationStopTransaction(request: Ocpplab.LocationStopTransactionRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationStopTransaction;
+    /**
+     * Unlock connector commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationUnlockConnectorRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationUnlockConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationUnlockConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationUnlockConnector(request: Ocpplab.LocationUnlockConnectorRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationUnlockConnector;
+    /**
+     * Power update commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationPowerUpdateRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationPowerUpdate({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         power_w: 11000,
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationPowerUpdate({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         power_w: 11000,
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationPowerUpdate(request: Ocpplab.LocationPowerUpdateRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationPowerUpdate;
+    /**
+     * Plug connector events for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationPlugConnectorRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationPlugConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationPlugConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationPlugConnector(request: Ocpplab.LocationPlugConnectorRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationPlugConnector;
+    /**
+     * Unplug connector events for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationUnplugConnectorRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationUnplugConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationUnplugConnector({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationUnplugConnector(request: Ocpplab.LocationUnplugConnectorRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationUnplugConnector;
+    /**
+     * Automatic transaction start commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationAutoStartTransactionRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStartSession({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         id_tag: "TAG-RFID-001",
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStartSession({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         id_tag: "TAG-RFID-001",
+     *         connector_id: 1
+     *     })
+     */
+    locationStartSession(request: Ocpplab.LocationAutoStartTransactionRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationStartSession;
+    /**
+     * Automatic transaction stop commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationAutoStopTransactionRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStopSession({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationStopSession({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         connector_id: 1,
+     *         charger_ids: ["dep-123", "dep-124"]
+     *     })
+     */
+    locationStopSession(request: Ocpplab.LocationAutoStopTransactionRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationStopSession;
+    /**
+     * Authorize id tag commands for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationAuthorizeIdTagRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationAuthorizeIdTag({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         id_tag: "TAG-RFID-001"
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationAuthorizeIdTag({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         id_tag: "TAG-RFID-001"
+     *     })
+     */
+    locationAuthorizeIdTag(request: Ocpplab.LocationAuthorizeIdTagRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationAuthorizeIdTag;
+    /**
+     * Ev requests energy events for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationEvRequestsEnergyRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationEvRequestsEnergy({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationEvRequestsEnergy({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationEvRequestsEnergy(request: Ocpplab.LocationEvRequestsEnergyRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationEvRequestsEnergy;
+    /**
+     * Ev stops energy events for one or more chargers in the selected location. When `charger_ids` is omitted or null, all chargers in the location are targeted.
+     *
+     * @param {Ocpplab.LocationEvStopsEnergyRequest} request
+     * @param {LocationChargerCommandsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.BadRequestError}
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     * @throws {@link Ocpplab.NotFoundError}
+     * @throws {@link Ocpplab.UnprocessableEntityError}
+     * @throws {@link Ocpplab.InternalServerError}
+     *
+     * @example
+     *     await client.locationChargerCommands.locationEvStopsEnergy({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     *
+     * @example
+     *     await client.locationChargerCommands.locationEvStopsEnergy({
+     *         location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+     *         charger_ids: ["dep-123", "dep-124"],
+     *         evse_id: 1,
+     *         connector_id: 1
+     *     })
+     */
+    locationEvStopsEnergy(request: Ocpplab.LocationEvStopsEnergyRequest, requestOptions?: LocationChargerCommandsClient.RequestOptions): core.HttpResponsePromise<Ocpplab.LocationCommandResponse>;
+    private __locationEvStopsEnergy;
+}