@epilot/sdk 2.12.2 → 2.13.1

package/definitions/metering.json

@@ -104,7 +104,7 @@
                             "properties": {
                               "last_reading": {
                                 "type": "string",
-                                "example": "2022-10-10",
+                                "example": "2022-10-10T00:00:00.000Z",
                                 "description": "The timestamp of the last reading"
                               },
                               "current_consumption": {
@@ -2035,7 +2035,7 @@
               },
               "calibration_date": {
                 "type": "string",
-                "example": "2022-10-10",
+                "example": "2022-10-10T00:00:00.000Z",
                 "description": "The calibration date of the meter"
               },
               "contract": {
@@ -2151,7 +2151,7 @@
           "timestamp": {
             "type": "string",
             "description": "If the value is not provided, the system will be set with the time the request is processed.",
-            "example": "2022-10-10",
+            "example": "2022-10-10T00:00:00.000Z",
             "format": "date-time"
           },
           "source": {
@@ -2387,7 +2387,7 @@
           "timestamp": {
             "type": "string",
             "description": "If the value is not provided, the system will be set with the time the request is processed.",
-            "example": "2022-10-10",
+            "example": "2022-10-10T00:00:00.000Z",
             "format": "date-time"
           },
           "source": {
@@ -2466,7 +2466,7 @@
               },
               "forecast_as_of": {
                 "type": "string",
-                "example": "2022-12-10",
+                "example": "2022-12-10T00:00:00.000Z",
                 "description": "The date as of which the forecast reading value is applicable"
               },
               "current_consumption": {
@@ -2476,7 +2476,7 @@
               },
               "last_reading": {
                 "type": "string",
-                "example": "2022-10-10",
+                "example": "2022-10-10T00:00:00.000Z",
                 "description": "The timestamp of the last reading"
               },
               "conversion_factor": {

package/definitions/user-runtime.json

@@ -1 +1 @@
-{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUserSettings","get","/v2/users/me/settings"],["getUserSettingsScope","get","/v2/users/me/settings/{scope}",[["scope","p",true]]],["getUserSetting","get","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["putUserSetting","put","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]],1],["deleteUserSetting","delete","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["listUsersV2","get","/v2/users",[["query","q"],["limit","q"],["offset","q"]]],["getUserV2","get","/v2/users/{id}",[["id","p",true]]],["updateUserV2","patch","/v2/users/{id}",[["id","p",true]],1],["deleteUserV2","delete","/v2/users/{id}",[["id","p",true]]],["inviteUser","post","/v2/users/invite",null,1],["resendUserInvitation","post","/v2/users/invite:resendEmail",null,1],["sendUserPasswordReset","post","/v2/users:sendPasswordReset",null,1],["getGroupsForUser","get","/v2/users/{id}/groups",[["id","p",true]]],["getGroups","get","/v1/groups",[["query","q"],["limit","q"],["offset","q"],["hydrate","q"]]],["createGroup","post","/v1/groups",null,1],["getGroup","get","/v1/groups/{id}",[["id","p",true],["hydrate","q"]]],["updateGroup","patch","/v1/groups/{id}",[["id","p",true]],1],["deleteGroup","delete","/v1/groups/{id}",[["id","p",true]]],["advanceUserAssignment","post","/v1/groups/{id}/user:next",[["id","p",true]]],["createNavigation","post","/v2/user/navigations",null,1],["getNavigation","get","/v2/user/navigations/{id}",[["id","p",true]]],["verifyEmailWithToken","post","/v2/users/public/verifyEmail",[["token","q",true]],1],["requestPasswordReset","post","/v2/users/public/requestPasswordReset",null,1],["checkInviteToken","get","/v2/users/public/checkToken",[["token","q",true]]],["activateUser","post","/v2/users/public/activate",[["token","q",true]],1],["rejectInvite","delete","/v2/users/public/reject",[["token","q",true]]],["getUserLoginParametersV2","get","/v2/users/public/username/{username}:getLoginParameters",[["username","p",true]]],["beginPasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBegin",null,1],["beginDiscoverablePasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBeginDiscoverable"],["resolveDiscoverableCredential","post","/v2/users/public/passkeys:resolveCredential",null,1],["beginPasskeyRegistration","post","/v2/users/me/passkeys:registerBegin",null,1],["completePasskeyRegistration","post","/v2/users/me/passkeys:registerComplete",null,1],["listPasskeys","get","/v2/users/me/passkeys"],["deletePasskey","delete","/v2/users/me/passkeys/{credentialId}",[["credentialId","p",true]]],["switchOrganization","post","/v2/users/switchOrganization",null,1],["getMe","get","/v1/users/me"],["listUsers","get","/v1/users",[["org_ids","q",false,"form",false],["query","q"],["limit","q"],["offset","q"]]],["getUser","get","/v1/users/{id}",[["id","p",true]]],["getUserLoginParameters","get","/v1/users/username/{username}:getLoginParameters",[["username","p",true]]]]}
+{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUserSettings","get","/v2/users/me/settings"],["getUserSettingsScope","get","/v2/users/me/settings/{scope}",[["scope","p",true]]],["getUserSetting","get","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["putUserSetting","put","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]],1],["deleteUserSetting","delete","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["listUsersV2","get","/v2/users",[["query","q"],["limit","q"],["offset","q"]]],["getUserV2","get","/v2/users/{id}",[["id","p",true]]],["updateUserV2","patch","/v2/users/{id}",[["id","p",true]],1],["deleteUserV2","delete","/v2/users/{id}",[["id","p",true]]],["inviteUser","post","/v2/users/invite",null,1],["resendUserInvitation","post","/v2/users/invite:resendEmail",null,1],["sendUserPasswordReset","post","/v2/users:sendPasswordReset",null,1],["getGroupsForUser","get","/v2/users/{id}/groups",[["id","p",true]]],["getGroups","get","/v1/groups",[["query","q"],["limit","q"],["offset","q"],["hydrate","q"]]],["createGroup","post","/v1/groups",null,1],["getGroup","get","/v1/groups/{id}",[["id","p",true],["hydrate","q"]]],["updateGroup","patch","/v1/groups/{id}",[["id","p",true]],1],["deleteGroup","delete","/v1/groups/{id}",[["id","p",true]]],["advanceUserAssignment","post","/v1/groups/{id}/user:next",[["id","p",true]]],["createNavigation","post","/v2/user/navigations",null,1],["getNavigation","get","/v2/user/navigations/{id}",[["id","p",true]]],["verifyEmailWithToken","post","/v2/users/public/verifyEmail",[["token","q",true]],1],["requestPasswordReset","post","/v2/users/public/requestPasswordReset",null,1],["resetPassword","post","/v2/users/public/resetPassword",null,1],["checkInviteToken","get","/v2/users/public/checkToken",[["token","q",true]]],["activateUser","post","/v2/users/public/activate",[["token","q",true]],1],["rejectInvite","delete","/v2/users/public/reject",[["token","q",true]]],["getUserLoginParametersV2","get","/v2/users/public/username/{username}:getLoginParameters",[["username","p",true]]],["beginPasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBegin",null,1],["beginDiscoverablePasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBeginDiscoverable"],["resolveDiscoverableCredential","post","/v2/users/public/passkeys:resolveCredential",null,1],["beginPasskeyRegistration","post","/v2/users/me/passkeys:registerBegin",null,1],["completePasskeyRegistration","post","/v2/users/me/passkeys:registerComplete",null,1],["listPasskeys","get","/v2/users/me/passkeys"],["deletePasskey","delete","/v2/users/me/passkeys/{credentialId}",[["credentialId","p",true]]],["switchOrganization","post","/v2/users/switchOrganization",null,1],["getMe","get","/v1/users/me"],["listUsers","get","/v1/users",[["org_ids","q",false,"form",false],["query","q"],["limit","q"],["offset","q"]]],["getUser","get","/v1/users/{id}",[["id","p",true]]],["getUserLoginParameters","get","/v1/users/username/{username}:getLoginParameters",[["username","p",true]]]]}

package/definitions/user.json

@@ -1046,6 +1046,117 @@
         }
       }
     },
+    "/v2/users/public/resetPassword": {
+      "post": {
+        "operationId": "resetPassword",
+        "summary": "resetPassword",
+        "description": "Set a new password using a reset token from the password reset email.\nThe token is single-use and time-limited.\n",
+        "security": [],
+        "x-rate-limit": {
+          "limit": 10
+        },
+        "tags": [
+          "User V2"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "email",
+                  "token",
+                  "password"
+                ],
+                "properties": {
+                  "email": {
+                    "type": "string",
+                    "description": "Email address of the account",
+                    "example": "test@example.com"
+                  },
+                  "token": {
+                    "type": "string",
+                    "description": "Reset token from the password reset email"
+                  },
+                  "password": {
+                    "type": "string",
+                    "description": "The new password"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Password reset successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "success"
+                  ],
+                  "properties": {
+                    "success": {
+                      "type": "boolean",
+                      "example": true
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid or expired reset link, or password does not meet the requirements",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "error",
+                    "message"
+                  ],
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "description": "Discriminator distinguishing token errors from policy errors",
+                      "enum": [
+                        "INVALID_RESET_LINK",
+                        "PASSWORD_POLICY"
+                      ]
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "Password does not meet the requirements"
+                    },
+                    "violations": {
+                      "type": "array",
+                      "description": "Itemized password-policy violation codes (only present when error is PASSWORD_POLICY)",
+                      "items": {
+                        "type": "string",
+                        "enum": [
+                          "too_short",
+                          "missing_lowercase",
+                          "missing_uppercase",
+                          "missing_number",
+                          "missing_symbol"
+                        ]
+                      },
+                      "example": [
+                        "too_short",
+                        "missing_uppercase"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v2/users/public/checkToken": {
       "get": {
         "operationId": "checkInviteToken",
@@ -1998,6 +2109,19 @@
             "format": "date-time",
             "readOnly": true
           },
+          "password_reset_token_hash": {
+            "description": "Internal: sha256 hash of the active password-reset token. Server-set, never returned in responses.",
+            "type": "string",
+            "nullable": true,
+            "readOnly": true
+          },
+          "password_reset_token_expires_at": {
+            "description": "Internal: expiry for the active password-reset token (ISO 8601). Server-set, never returned in responses.",
+            "type": "string",
+            "nullable": true,
+            "format": "date-time",
+            "readOnly": true
+          },
           "department": {
             "type": "string",
             "description": "User's department",
@@ -2130,6 +2254,17 @@
               "deleted_opportunity": true
             }
           },
+          "in_app_notification_setting": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Per-notification-type in-app delivery preferences (notification type key -> enabled). Written by the my-account notification settings UI and honored by svc-notification-api at delivery time. Absent or partial keys fall back to each notification type's configured default. Mirrors email_notification_setting for the in-app channel.",
+            "example": {
+              "integration_critical_error": true,
+              "integration_error_threshold": true,
+              "assigned_opportunity": true,
+              "assigned_task": true
+            }
+          },
           "properties": {
             "type": "array",
             "items": {
@@ -2149,6 +2284,17 @@
                 "value"
               ]
             }
+          },
+          "tags": {
+            "type": "array",
+            "description": "User tags/labels assigned for classification (e.g. label slugs)",
+            "nullable": true,
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "non-billable"
+            ]
           }
         }
       },

package/definitions/webhooks.json

@@ -1498,7 +1498,8 @@
         ],
         "properties": {
           "status_code": {
-            "type": "string"
+            "type": "string",
+            "description": "The HTTP status returned by the customer endpoint (or the upstream gateway). ABSENT for epilot-internal errors (code INTERNAL_ERROR / INTERNAL_RESPONSE_TOO_LARGE), which are not customer HTTP outcomes; PRESENT only for real HTTP/upstream results. When the response was delivered but too large to record, a recovered delivered status may still be present."
           },
           "message": {
             "type": "string"
@@ -1507,7 +1508,8 @@
             "type": "object"
           },
           "code": {
-            "type": "string"
+            "type": "string",
+            "description": "Machine-readable classification of the outcome. Known values: OAuthTokenExchangeError (OAuth token exchange / upstream gateway failure), DataLimitExceeded (legacy oversized-response marker), INTERNAL_RESPONSE_TOO_LARGE (request delivered but the response was too large for epilot to record), INTERNAL_ERROR (epilot-internal processing failure — not a customer HTTP outcome)."
           },
           "status": {
             "type": "string",
@@ -1678,7 +1680,8 @@
             "type": "object",
             "properties": {
               "status_code": {
-                "type": "integer"
+                "type": "integer",
+                "description": "The HTTP status returned by the customer endpoint (or the upstream gateway). ABSENT for epilot-internal errors (code INTERNAL_ERROR / INTERNAL_RESPONSE_TOO_LARGE), which are not customer HTTP outcomes; PRESENT only for real HTTP/upstream results. When the response was delivered but too large to record, a recovered delivered status may still be present."
               },
               "message": {
                 "type": "string"
@@ -1687,7 +1690,8 @@
                 "type": "object"
               },
               "code": {
-                "type": "string"
+                "type": "string",
+                "description": "Machine-readable classification of the outcome. Known values: OAuthTokenExchangeError (OAuth token exchange / upstream gateway failure), DataLimitExceeded (legacy oversized-response marker), INTERNAL_RESPONSE_TOO_LARGE (request delivered but the response was too large for epilot to record), INTERNAL_ERROR (epilot-internal processing failure — not a customer HTTP outcome)."
               }
             }
           },

package/definitions/workflow-definition-runtime.json

@@ -1 +1 @@
-{"s":"https://workflows-definition.sls.epilot.io","o":[["getMaxAllowedLimit","get","/v1/workflows/limits/max-allowed"],["getDefinitions","get","/v1/workflows/definitions"],["createDefinition","post","/v1/workflows/definitions",null,1],["listFlowTemplates","get","/v2/flows/templates",[["trigger_type","q"],["trigger_source_id","q"],["trigger_schema","q"]]],["createFlowTemplate","post","/v2/flows/templates",null,1],["searchFlowTemplates","post","/v2/flows/templates:search",null,1],["getFlowTemplate","get","/v2/flows/templates/{flowId}",[["flowId","p",true]]],["updateFlowTemplate","put","/v2/flows/templates/{flowId}",[["flowId","p",true]],1],["deleteFlowTemplate","delete","/v2/flows/templates/{flowId}",[["flowId","p",true]]],["duplicateFlowTemplate","post","/v2/flows/templates/{flowId}/duplicate",[["flowId","p",true]]],["getDefinition","get","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]]],["updateDefinition","put","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]],1],["deleteDefinition","delete","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]]],["getAllClosingReasons","get","/v1/workflows/closing-reasons",[["includeInactive","q"]]],["createClosingReason","post","/v1/workflows/closing-reasons",null,1],["getClosingReason","get","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["updateClosingReason","patch","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]],1],["deleteClosingReason","delete","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["getClosingReasonV1","get","/v1/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["changeReasonStatus","patch","/v1/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]],1],["getWorkflowClosingReasons","get","/v1/workflows/definitions/{definitionId}/closing-reasons",[["definitionId","p",true]]],["setWorkflowClosingReasons","patch","/v1/workflows/definitions/{definitionId}/closing-reasons",[["definitionId","p",true]],1]],"v":"3.0.0"}
+{"s":"","o":[["getMaxAllowedLimit","get","/v1/workflows/limits/max-allowed"],["getDefinitions","get","/v1/workflows/definitions"],["createDefinition","post","/v1/workflows/definitions",null,1],["listFlowTemplates","get","/v2/flows/templates",[["trigger_type","q"],["trigger_source_id","q"],["trigger_schema","q"]]],["createFlowTemplate","post","/v2/flows/templates",[["EnforceLimitsParam"]],1],["searchFlowTemplates","post","/v2/flows/templates:search",null,1],["getFlowTemplate","get","/v2/flows/templates/{flowId}",[["flowId","p",true]]],["updateFlowTemplate","put","/v2/flows/templates/{flowId}",[["flowId","p",true],["EnforceLimitsParam"]],1],["deleteFlowTemplate","delete","/v2/flows/templates/{flowId}",[["flowId","p",true]]],["duplicateFlowTemplate","post","/v2/flows/templates/{flowId}/duplicate",[["flowId","p",true]]],["getDefinition","get","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]]],["updateDefinition","put","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]],1],["deleteDefinition","delete","/v1/workflows/definitions/{definitionId}",[["definitionId","p",true]]],["getAllClosingReasons","get","/v1/workflows/closing-reasons",[["includeInactive","q"]]],["createClosingReason","post","/v1/workflows/closing-reasons",null,1],["getClosingReason","get","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["updateClosingReason","patch","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]],1],["deleteClosingReason","delete","/v2/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["getClosingReasonV1","get","/v1/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]]],["changeReasonStatus","patch","/v1/workflows/closing-reasons/{reasonId}",[["reasonId","p",true]],1],["getWorkflowClosingReasons","get","/v1/workflows/definitions/{definitionId}/closing-reasons",[["definitionId","p",true]]],["setWorkflowClosingReasons","patch","/v1/workflows/definitions/{definitionId}/closing-reasons",[["definitionId","p",true]],1]],"v":"3.0.0","cp":{"EnforceLimitsParam":["enforce_limits","q"]}}