{ "openapi": "3.1.0", "info": { "title": "undrstand API", "version": "1.0.0" }, "servers": [ { "url": "https:\/\/api.undrstand.com\/api" } ], "security": [ { "http": [] } ], "paths": { "\/apps": { "get": { "operationId": "apps.index", "tags": [ "Apps" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } } ], "responses": { "200": { "description": "Paginated set of `AppResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AppResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "apps.store", "tags": [ "Apps" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AppStoreRequest" } } } }, "responses": { "201": { "description": "`AppResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AppResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/apps\/{app}": { "get": { "operationId": "apps.show", "tags": [ "Apps" ], "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`AppResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AppResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "patch": { "operationId": "apps.update", "tags": [ "Apps" ], "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AppUpdateRequest" } } } }, "responses": { "200": { "description": "`AppResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AppResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "apps.destroy", "tags": [ "Apps" ], "parameters": [ { "name": "app", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/login": { "post": { "operationId": "login.store", "summary": "Attempt to authenticate a new session", "tags": [ "AuthenticatedSession" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LoginRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": {} } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/logout": { "post": { "operationId": "logout", "summary": "Destroy an authenticated session", "tags": [ "AuthenticatedSession" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/captures": { "get": { "operationId": "captures.index", "tags": [ "Captures" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } } ], "responses": { "200": { "description": "Paginated set of `CaptureResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CaptureResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "captures.store", "tags": [ "Captures" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CaptureStoreRequest" } } } }, "responses": { "201": { "description": "`CaptureResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CaptureResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/captures\/{capture}": { "get": { "operationId": "captures.show", "tags": [ "Captures" ], "parameters": [ { "name": "capture", "in": "path", "required": true, "description": "The capture UUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`CaptureResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#\/components\/schemas\/CaptureResource" }, { "type": "object", "required": [ "segments" ] } ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "captures.destroy", "tags": [ "Captures" ], "parameters": [ { "name": "capture", "in": "path", "required": true, "description": "The capture UUID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/user\/confirm-password": { "post": { "operationId": "password.confirm.store", "summary": "Confirm the user's password", "tags": [ "ConfirmablePassword" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "password": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/confirmation-codes": { "post": { "operationId": "confirmationCodes.store", "summary": "Mails the signed-in user a code to confirm with \u2014 what an account without\na password is asked for where one with would be asked for its password.\nIt goes to the account's own address, so holding the session alone is not\nenough to answer it", "tags": [ "ConfirmationCodes" ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/confirmations": { "post": { "operationId": "confirmations.store", "summary": "Confirms the session with a mailed code. It leaves the very mark a confirmed\npassword does, so Fortify's user\/confirmed-password-status and the\nidentity.confirmed middleware cannot tell the two apart", "tags": [ "Confirmations" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ConfirmationStoreRequest" } } } }, "responses": { "204": { "description": "No content" }, "400": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only a session can be confirmed." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/user\/confirmed-password-status": { "get": { "operationId": "password.confirmation", "summary": "Get the password confirmation status", "tags": [ "ConfirmedPasswordStatus" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "confirmed": { "type": "boolean" } }, "required": [ "confirmed" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/confirmed-two-factor-authentication": { "post": { "operationId": "confirmedTwoFactorAuthentication.store", "summary": "Enable two factor authentication for the user", "tags": [ "ConfirmedTwoFactorAuthentication" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/correlations\/{correlation}": { "patch": { "operationId": "correlations.update", "tags": [ "Correlations" ], "parameters": [ { "name": "correlation", "in": "path", "required": true, "description": "The correlation UUID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CorrelationUpdateRequest" } } } }, "responses": { "200": { "description": "`CorrelationResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CorrelationResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/email\/verification-notification": { "post": { "operationId": "emailVerificationNotification.store", "summary": "Send a new email verification notification", "tags": [ "EmailVerificationNotification" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } }, "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/fcm-tokens\/me": { "post": { "operationId": "fcmTokens.store", "tags": [ "FcmTokens" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FcmTokenStoreRequest" } } } }, "responses": { "201": { "description": "" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/fcm-tokens\/me\/{fcmToken}": { "delete": { "operationId": "fcmTokens.destroy", "tags": [ "FcmTokens" ], "parameters": [ { "name": "fcmToken", "in": "path", "required": true, "description": "The fcm token token", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/feature-locks\/me\/{type}": { "get": { "operationId": "featureLocks.show", "tags": [ "FeatureLocks" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "The type ID", "schema": { "$ref": "#\/components\/schemas\/FeatureLockType" } }, { "name": "scope", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`FeatureLockResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/FeatureLockResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/feedback": { "post": { "operationId": "feedback.store", "tags": [ "Feedback" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "feedback": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "feedback" ] } } } }, "responses": { "204": { "description": "No content" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/health-check": { "get": { "operationId": "healthCheck.index", "tags": [ "HealthCheck" ], "responses": { "200": { "description": "`JsonResource`\n\n`PreserveKeysResource`", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JsonResource" } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PreserveKeysResource" } }, "required": [ "data" ] } ] } } } } }, "security": [] } }, "\/job-batches\/{jobBatch}": { "get": { "operationId": "jobBatches.show", "tags": [ "JobBatches" ], "parameters": [ { "name": "jobBatch", "in": "path", "required": true, "description": "The job batch ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "`JobBatchResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JobBatchResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/magic-links\/me": { "post": { "operationId": "magicLink.store", "tags": [ "MagicLink" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MagicLinkStoreRequest" } } } }, "responses": { "200": { "description": "`MagicLinkResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MagicLinkResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/magic-links\/login": { "get": { "operationId": "magic-link-login", "description": "Registered on the web middleware group rather than the API one \u2014 a session\nis the whole point, and the API group has none to write into.", "summary": "Follows a magic link: signs the user into the browser session the web\napplication runs on, then hands them to the screen the link named", "tags": [ "MagicLinkLogin" ], "parameters": [ { "name": "user_uuid", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\\/(?!\\\/)", "maxLength": 255 } }, { "name": "return_to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "uri" } }, { "name": "expires", "in": "query", "required": true, "description": "Laravel's own: it checked both before this request authorized.", "schema": { "type": "integer" } }, { "name": "signature", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/magic-links\/mails": { "post": { "operationId": "magicLinkMail.store", "description": "What is mailed depends on who asked, the way signing a new account in does:\nthe web application asks on a session and gets a link into itself; a client\nthat cannot hold one \u2014 the native app \u2014 gets a code to type in.", "summary": "Mails a login to whoever holds the address. The answer is the same whether\nanybody does or not, so the endpoint cannot be used to find out", "tags": [ "MagicLinkMail" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MagicLinkMailStoreRequest" } } } }, "responses": { "204": { "description": "No content" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/magic-links\/tokens": { "post": { "operationId": "magicLinkToken.store", "summary": "The native client's half of a login mail: the code typed in, a bearer token\nback. Refused the same way whatever was wrong \u2014 the address, the code, a\ncode already used, or an account that may not sign in at all \u2014 so nothing\nabout the account is given away", "tags": [ "MagicLinkToken" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MagicLinkTokenStoreRequest" } } } }, "responses": { "200": { "description": "`PersonalAccessTokenResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PersonalAccessTokenResource" } }, "required": [ "data" ] } } } }, "401": { "description": "" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/newsletter-subscribers": { "post": { "operationId": "newsletterSubscribers.store", "tags": [ "NewsletterSubscribers" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NewsletterSubscriberStoreRequest" } } } }, "responses": { "204": { "description": "No content" }, "500": { "description": "" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/oauth\/{provider}\/callback": { "get": { "operationId": "public.oAuthCallback", "tags": [ "OAuthCallback" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "description": "The provider ID", "schema": { "$ref": "#\/components\/schemas\/OAuthProvider" } }, { "name": "user", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`JsonResource`", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object" }, { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JsonResource" } }, "required": [ "data" ] } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/oauth\/{provider}\/access-token": { "post": { "operationId": "public.oAuthPersonalAccessToken", "tags": [ "OAuthPersonalAccessToken" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "description": "The provider ID", "schema": { "$ref": "#\/components\/schemas\/OAuthProvider" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OAuthAccessTokenRequest" } } } }, "responses": { "200": { "description": "`PersonalAccessTokenResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PersonalAccessTokenResource" } }, "required": [ "data" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "const": "oauth_user_exists" } }, "required": [ "error" ] }, { "type": "object", "properties": { "error": { "type": "string", "const": "invalid_access_token" } }, "required": [ "error" ] } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/oauth\/{provider}\/redirect": { "get": { "operationId": "public.oAuthRedirect", "tags": [ "OAuthRedirect" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "description": "The provider ID", "schema": { "$ref": "#\/components\/schemas\/OAuthProvider" } } ], "responses": { "200": { "description": "`OAuthResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/OAuthResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } }, "security": [] } }, "\/onboarding": { "patch": { "operationId": "onboarding.update", "tags": [ "Onboarding" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OnboardingUpdateRequest" } } } }, "responses": { "200": { "description": "`OnboardingResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/OnboardingResource" } }, "required": [ "data" ] } } } }, "400": { "description": "" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/patterns": { "get": { "operationId": "patterns.index", "tags": [ "Patterns" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } } ], "responses": { "200": { "description": "Paginated set of `PatternResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PatternResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/patterns\/{pattern}": { "get": { "operationId": "patterns.show", "tags": [ "Patterns" ], "parameters": [ { "name": "pattern", "in": "path", "required": true, "description": "The pattern UUID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`PatternResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#\/components\/schemas\/PatternResource" }, { "type": "object", "required": [ "captures", "correlations", "flows" ] } ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "patch": { "operationId": "patterns.update", "tags": [ "Patterns" ], "parameters": [ { "name": "pattern", "in": "path", "required": true, "description": "The pattern UUID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PatternUpdateRequest" } } } }, "responses": { "200": { "description": "`PatternResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#\/components\/schemas\/PatternResource" }, { "type": "object", "required": [ "captures", "correlations", "flows" ] } ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/personal-access-tokens\/me": { "delete": { "operationId": "personalAccessTokens.destroy", "summary": "Revoke the token the request came in on. A session caller signs out through\nFortify's \/logout instead", "tags": [ "PersonalAccessTokens" ], "responses": { "204": { "description": "No content" }, "400": { "description": "" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/plan-limits\/me\/{feature}": { "get": { "operationId": "planLimits.show", "tags": [ "PlanLimits" ], "parameters": [ { "name": "feature", "in": "path", "required": true, "description": "The feature ID", "schema": { "$ref": "#\/components\/schemas\/Feature" } } ], "responses": { "200": { "description": "`PlanLimitResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PlanLimitResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/profile-information": { "put": { "operationId": "user-profile-information.update", "summary": "Update the user's profile information", "tags": [ "ProfileInformation" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/two-factor-recovery-codes": { "get": { "operationId": "recoveryCode.index", "summary": "Get the two factor authentication recovery codes for authenticated user", "tags": [ "RecoveryCode" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ {}, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0 } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "two-factor.regenerate-recovery-codes", "summary": "Generate a fresh set of two factor authentication recovery codes", "tags": [ "RecoveryCode" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/register": { "post": { "operationId": "register.store", "summary": "Create a new registered user", "tags": [ "RegisteredUser" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "remember": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "\/stripe\/webhook": { "post": { "operationId": "stripe.webhook", "tags": [ "StripeWebhook" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "\/subscription-module-previews\/{module}": { "get": { "operationId": "subscriptionModulePreviews.show", "tags": [ "SubscriptionModulePreviews" ], "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`SubscriptionModulePreviewResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionModulePreviewResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/subscription-modules": { "get": { "operationId": "subscriptionModules.index", "tags": [ "SubscriptionModules" ], "responses": { "200": { "description": "Array of `BillingModuleResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingModuleResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "subscriptionModules.store", "tags": [ "SubscriptionModules" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionModuleStoreRequest" } } } }, "responses": { "201": { "description": "`SubscriptionModuleActivationResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionModuleActivationResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/subscription-modules\/{module}": { "delete": { "operationId": "subscriptionModules.destroy", "tags": [ "SubscriptionModules" ], "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/subscription-plan-previews\/{plan}": { "get": { "operationId": "subscriptionPlanPreviews.show", "tags": [ "SubscriptionPlanPreviews" ], "parameters": [ { "name": "plan", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billing_period", "in": "query", "required": true, "schema": { "$ref": "#\/components\/schemas\/BillingPeriod" } } ], "responses": { "200": { "description": "`SubscriptionModulePreviewResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionModulePreviewResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/subscriptions\/me": { "get": { "operationId": "subscriptions.show", "tags": [ "Subscriptions" ], "responses": { "200": { "description": "`SubscriptionResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "subscriptions.store", "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionStoreRequest" } } } }, "responses": { "200": { "description": "`CheckoutResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CheckoutResource" } }, "required": [ "data" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "There already is an active subscription." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/subscriptions\/{subscription}": { "put": { "operationId": "subscriptions.update", "description": "What it buys is changed the same way: a plan and a billing period switch it at\nthe processor, which prorates the difference straight away.", "summary": "A subscription's cancellation is a state, not a separate resource \u2014 the\nprocessor keeps the record and schedules the end for the period boundary. So\ncancelling and resuming are both updates to the subscription's status:\n`canceled` schedules the cancellation, `active` undoes a scheduled one. Both\nare no-ops if already in the requested state", "tags": [ "Subscriptions" ], "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionUpdateRequest" } } } }, "responses": { "200": { "description": "`SubscriptionResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/timeline": { "get": { "operationId": "timeline.index", "tags": [ "Timeline" ], "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Array of `TimelineDayResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TimelineDayResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/two-factor-challenge": { "post": { "operationId": "two-factor.login.store", "summary": "Attempt to authenticate a new session using the two factor authentication code", "tags": [ "TwoFactorAuthenticatedSession" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TwoFactorLoginRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": {} } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/user\/two-factor-authentication": { "post": { "operationId": "twoFactorAuthentication.store", "summary": "The one action that cannot take a FormRequest: it overrides Fortify's controller,\nwhose signature types the bare Request. Narrowing a parameter in a subclass breaks\nthe inherited contract, so the type has to stay as the parent declares it", "tags": [ "TwoFactorAuthentication" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "force": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "twoFactorAuthentication.destroy", "summary": "Disable two factor authentication for the user", "tags": [ "TwoFactorAuthentication" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/personal-access-tokens\/two-factor-challenges": { "post": { "operationId": "twoFactorPersonalAccessToken.store", "tags": [ "TwoFactorPersonalAccessToken" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TwoFactorPersonalAccessTokenStoreRequest" } } } }, "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/user\/two-factor-qr-code": { "get": { "operationId": "twoFactorQrCode.show", "summary": "Get the SVG element for the user's two factor authentication QR code", "tags": [ "TwoFactorQrCode" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "svg": { "type": "string" }, "url": { "type": "string" } }, "required": [ "svg", "url" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0 } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/user\/two-factor-secret-key": { "get": { "operationId": "two-factor.secret-key", "summary": "Get the current user's two factor authentication setup \/ secret key", "tags": [ "TwoFactorSecretKey" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "secretKey": {} }, "required": [ "secretKey" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/notifications\/me": { "get": { "operationId": "userNotifications.index", "tags": [ "UserNotifications" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } } ], "responses": { "200": { "description": "Array of `NotificationResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NotificationResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "userNotificationsBulk.destroy", "summary": "Clears the bell: everything the signed-in user was ever told, read or not", "tags": [ "UserNotificationsBulk" ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/notifications\/{notification}": { "patch": { "operationId": "userNotifications.update", "tags": [ "UserNotifications" ], "parameters": [ { "name": "notification", "in": "path", "required": true, "description": "The notification ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationUpdateRequest" } } } }, "responses": { "200": { "description": "`NotificationResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationResource" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "userNotifications.destroy", "tags": [ "UserNotifications" ], "parameters": [ { "name": "notification", "in": "path", "required": true, "description": "The notification ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/notifications\/me\/read": { "patch": { "operationId": "userNotificationsBulk.update", "tags": [ "UserNotificationsBulk" ], "responses": { "200": { "description": "Array of `NotificationResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NotificationResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/settings\/me": { "get": { "operationId": "userSettings.index", "tags": [ "UserSettings" ], "responses": { "200": { "description": "Array of `SettingResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SettingResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "userSettingsBulk.update", "tags": [ "UserSettingsBulk" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserSettingBulkUpdateRequest" } } } }, "responses": { "200": { "description": "Array of `SettingResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SettingResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/settings\/me\/{key}": { "put": { "operationId": "userSettings.update", "summary": "One setting, named by the client, with create-or-update semantics: the web\napplication changes one at a time. The bulk controller is what the mobile\napp writes with", "tags": [ "UserSettings" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`SettingResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SettingResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/users": { "post": { "operationId": "users.store", "summary": "Registers an account and signs it in on the spot: a session for a first-party\nclient, a bearer token \u2014 handed back under `meta` \u2014 for anything else", "tags": [ "Users" ], "responses": { "200": { "description": "`UserResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/UserResource" }, "meta": { "type": "object", "properties": { "token": { "type": [ "string", "null" ] } }, "required": [ "token" ] } }, "required": [ "data", "meta" ] } } } } }, "security": [] } }, "\/users\/me": { "get": { "operationId": "users.show", "tags": [ "Users" ], "parameters": [ { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`UserResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/UserResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "put": { "operationId": "users.update", "tags": [ "Users" ], "responses": { "200": { "description": "`UserResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/UserResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "users.destroy", "tags": [ "Users" ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/email\/verify\/{id}\/{hash}": { "get": { "operationId": "verification.verify", "summary": "Mark the authenticated user's email address as verified", "tags": [ "VerifyEmail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AppResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "redirect_uris": { "type": "array", "items": { "type": "string" } }, "website_url": { "type": [ "string", "null" ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "confidential": { "type": "boolean" }, "secret": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "redirect_uris", "website_url", "scopes", "confidential", "secret", "created_at", "updated_at" ], "title": "AppResource" }, "AppStoreRequest": { "type": "object", "description": "Registering an OAuth app. Redirect URIs are https, or http on localhost\nwhile developing; custom schemes are not taken. Scopes are a subset of\nthe six the API knows, never `mcp:use`.", "properties": { "name": { "type": "string", "maxLength": 100 }, "redirect_uris": { "type": "array", "items": { "type": "string", "maxLength": 2000 }, "minItems": 1, "maxItems": 10 }, "website_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2000 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "captures:read", "captures:write", "patterns:read", "patterns:review", "settings:read", "settings:write" ] }, "minItems": 1, "uniqueItems": true }, "confidential": { "type": [ "boolean", "null" ] } }, "required": [ "name", "redirect_uris", "scopes" ], "title": "AppStoreRequest" }, "AppUpdateRequest": { "type": "object", "description": "Changing an app: any of name, redirect URIs, website URL and scopes.\nWhether it is confidential is fixed at registration.", "properties": { "name": { "type": "string", "maxLength": 100 }, "redirect_uris": { "type": "array", "items": { "type": "string", "maxLength": 2000 }, "minItems": 1, "maxItems": 10 }, "website_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2000 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "captures:read", "captures:write", "patterns:read", "patterns:review", "settings:read", "settings:write" ] }, "minItems": 1, "uniqueItems": true } }, "title": "AppUpdateRequest" }, "BillingModule": { "type": "string", "description": "The add-ons sold on top of a plan, each backed by a price of its own at the web payment processor (see cashier.prices). Not to be confused with Module, the key-value store's partition. Scaffold: replace Example with what the app sells, or leave the enum without cases when it sells nothing beyond its plans.\n", "enum": [ "example" ], "title": "BillingModule" }, "BillingModuleResource": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string", "const": "Example" }, "description": { "type": "string", "const": "What the example module adds." }, "is_active": { "type": "string" } }, "required": [ "key", "name", "description", "is_active" ], "title": "BillingModuleResource" }, "BillingPeriod": { "type": "string", "enum": [ "month", "year" ], "title": "BillingPeriod" }, "CaptureOrigin": { "type": "string", "description": "Where a capture's text came from. Each origin is an ingestion adapter that turns its source into `original`; only raw text exists so far.\n", "enum": [ "text" ], "title": "CaptureOrigin" }, "CaptureResource": { "type": "object", "properties": { "id": { "type": "string" }, "original": { "type": "string" }, "translated": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "origin": { "$ref": "#\/components\/schemas\/CaptureOrigin" }, "occurred_at": { "type": "string", "format": "date-time" }, "status": { "$ref": "#\/components\/schemas\/CaptureStatus" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "segments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SegmentResource" } } }, "required": [ "id", "original", "translated", "language", "origin", "occurred_at", "status", "created_at" ], "title": "CaptureResource" }, "CaptureStatus": { "type": "string", "description": "Where a capture is in the pipeline. A client posts text, then polls this until it is `processed` and the segments are there to read.\n", "enum": [ "queued", "processing", "processed", "failed" ], "title": "CaptureStatus" }, "CaptureStoreRequest": { "type": "object", "properties": { "original": { "type": "string", "maxLength": 50000 }, "occurred_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "original" ], "title": "CaptureStoreRequest" }, "CaptureSummaryResource": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "occurred_at": { "type": "string" } }, "required": [ "id", "status", "occurred_at" ], "title": "CaptureSummaryResource" }, "CaptureTagResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/TagType" }, "name": { "type": "string" }, "category": { "type": [ "string", "null" ] } }, "required": [ "id", "type", "name", "category" ], "title": "CaptureTagResource" }, "CheckoutResource": { "type": "object", "properties": { "checkout_url": { "type": "string" } }, "required": [ "checkout_url" ], "title": "CheckoutResource" }, "ConfirmationStoreRequest": { "type": "object", "description": "Confirming with the code out of a confirmation mail. The code is the whole\nproof; this request only makes sure one was sent.", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "title": "ConfirmationStoreRequest" }, "CorrelationResource": { "type": "object", "properties": { "id": { "type": "string" }, "tag": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/TagType" }, "name": { "type": "string" } }, "required": [ "id", "type", "name" ] }, "impact": { "$ref": "#\/components\/schemas\/Impact" }, "amount": { "type": "integer" }, "status": { "$ref": "#\/components\/schemas\/CorrelationStatus" } }, "required": [ "id", "tag", "impact", "amount", "status" ], "title": "CorrelationResource" }, "CorrelationStatus": { "type": "string", "description": "Whether the user has reviewed a correlation. Detected is what counting found; accepted and rejected are the user's word. A rejected one is never counted again.\n", "enum": [ "detected", "accepted", "rejected" ], "title": "CorrelationStatus" }, "CorrelationUpdateRequest": { "type": "object", "description": "The user's review of a correlation: accepted or rejected. Detected is\nwhat counting says, never what a client may set.", "properties": { "status": { "type": "string", "enum": [ "accepted", "rejected" ] } }, "required": [ "status" ], "title": "CorrelationUpdateRequest" }, "FcmTokenStoreRequest": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "title": "FcmTokenStoreRequest" }, "Feature": { "type": "string", "description": "Every capability the app gates on a plan. Replace `Example` with the features of the app that is built on top of this base.\n", "enum": [ "example" ], "title": "Feature" }, "FeatureLockResource": { "type": "object", "properties": { "type": { "type": "string" }, "scope": { "type": "string" }, "locked_until": { "type": "string" }, "upgrade_plan": { "type": "string" } }, "required": [ "type", "scope", "locked_until", "upgrade_plan" ], "title": "FeatureLockResource" }, "FeatureLockType": { "type": "string", "description": "Always needs to have the exact same value as a `Feature` else the system won't work. The reason for not using `Feature` directly, is that not every `Feature` needs a lock. Some are only used for access and not limits.\n", "enum": [ "example" ], "title": "FeatureLockType" }, "FlowResource": { "type": "object", "properties": { "id": { "type": "string" }, "segment_id": { "type": "string" }, "trigger": { "type": "string" }, "feeling": { "type": "string" }, "behaviour": { "type": "string" } }, "required": [ "id", "segment_id", "trigger", "feeling", "behaviour" ], "title": "FlowResource" }, "Impact": { "type": "string", "description": "How often a pattern shows up: the weight of its combination against the detection thresholds. Low is \"sometimes\", moderate \"regularly\", high \"often\".\n", "enum": [ "low", "moderate", "high" ], "title": "Impact" }, "JobBatchResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "total_jobs": { "type": "integer" }, "pending_jobs": { "type": "integer" } }, "required": [ "id", "name", "total_jobs", "pending_jobs" ], "title": "JobBatchResource" }, "JsonResource": { "type": "string", "title": "JsonResource" }, "LoginRequest": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "remember": { "type": "string" } }, "required": [ "email", "password" ], "title": "LoginRequest" }, "MagicLinkMailStoreRequest": { "type": "object", "description": "Asking for a login mail. Anybody may ask: whether the address is held by an\naccount is not in the answer.", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "path": { "type": [ "string", "null" ], "description": "A path within the web application and nothing else: it is appended to\nthe configured base URL, so a value starting with a second slash\n(\"evil.example\") would read as another host altogether.", "pattern": "^\\\/(?!\\\/)", "maxLength": 255 } }, "required": [ "email" ], "title": "MagicLinkMailStoreRequest" }, "MagicLinkResource": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "title": "MagicLinkResource" }, "MagicLinkStoreRequest": { "type": "object", "properties": { "path": { "type": "string", "description": "A path within the web application and nothing else: it is appended to\nthe configured base URL, so a value starting with a second slash\n(\"evil.example\") would read as another host altogether.", "pattern": "^\\\/(?!\\\/)", "maxLength": 255 } }, "required": [ "path" ], "title": "MagicLinkStoreRequest" }, "MagicLinkTokenStoreRequest": { "type": "object", "description": "Trading the code out of a login mail for a bearer token. The code is the\nwhole authorization; this request only makes sure one was sent.", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "code": { "type": "string" } }, "required": [ "email", "code" ], "title": "MagicLinkTokenStoreRequest" }, "NewsletterSubscriberStoreRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "list": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "default", "waiting_for_android" ] } } }, "required": [ "email" ], "title": "NewsletterSubscriberStoreRequest" }, "NotificationResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "data": { "type": "array", "items": {} }, "read_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "data", "read_at", "updated_at", "created_at" ], "title": "NotificationResource" }, "NotificationUpdateRequest": { "type": "object", "properties": { "read_at": { "type": [ "string", "null" ], "format": "date-time" } }, "title": "NotificationUpdateRequest" }, "OAuthAccessTokenRequest": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "access_token": { "type": "string" } }, "required": [ "access_token" ], "title": "OAuthAccessTokenRequest" }, "OAuthProvider": { "type": "string", "enum": [ "apple", "facebook", "google" ], "title": "OAuthProvider" }, "OAuthResource": { "type": "object", "properties": { "redirect_url": { "type": "string" } }, "required": [ "redirect_url" ], "title": "OAuthResource" }, "OnboardingResource": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "title": "OnboardingResource" }, "OnboardingStatus": { "type": "string", "enum": [ "unfinished", "finished" ], "title": "OnboardingStatus" }, "OnboardingUpdateRequest": { "type": "object", "properties": { "status": { "$ref": "#\/components\/schemas\/OnboardingStatus" } }, "required": [ "status" ], "title": "OnboardingUpdateRequest" }, "PatternResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sentiment": { "$ref": "#\/components\/schemas\/Sentiment" }, "impact": { "$ref": "#\/components\/schemas\/Impact" }, "urgent": { "type": "boolean" }, "status": { "$ref": "#\/components\/schemas\/PatternStatus" }, "description": { "type": [ "string", "null" ] }, "feelings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "captures_count": { "type": "integer", "description": "Every loader counts them (PatternService); no fallback query here." }, "last_detected_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "captures": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CaptureSummaryResource" } }, "correlations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CorrelationResource" } }, "flows": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FlowResource" } } }, "required": [ "id", "name", "sentiment", "impact", "urgent", "status", "description", "feelings", "captures_count", "last_detected_at", "closed_at", "created_at" ], "title": "PatternResource" }, "PatternStatus": { "type": "string", "description": "What the user has said about a pattern. Detected until they review it; a rejected pattern is never detected again and its category is kept out of extraction.\n", "enum": [ "detected", "accepted", "rejected" ], "title": "PatternStatus" }, "PatternSummaryResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sentiment": { "type": "string" }, "impact": { "type": "string" } }, "required": [ "id", "name", "sentiment", "impact" ], "title": "PatternSummaryResource" }, "PatternUpdateRequest": { "type": "object", "description": "The user's review of a pattern: accepted or rejected. Detected is what\nthe analysis says, never what a client may set.", "properties": { "status": { "type": "string", "enum": [ "accepted", "rejected" ] } }, "required": [ "status" ], "title": "PatternUpdateRequest" }, "PersonalAccessTokenResource": { "anyOf": [ { "type": "object", "properties": { "token": { "type": "string" }, "two_factor": { "type": "string" } }, "required": [ "token", "two_factor" ] }, { "type": "object", "properties": { "token": { "type": "string" }, "two_factor": { "type": "boolean" } }, "required": [ "token", "two_factor" ] } ], "title": "PersonalAccessTokenResource" }, "Plan": { "type": "string", "enum": [ "free", "premium" ], "title": "Plan" }, "PlanLimitResource": { "type": "object", "properties": { "feature_domain": { "type": "string" }, "time_unit": { "type": "string" }, "limit": { "type": "string" }, "remaining_item_count": { "type": "string" }, "item_count": { "type": "string" } }, "required": [ "feature_domain", "time_unit", "limit", "remaining_item_count", "item_count" ], "title": "PlanLimitResource" }, "PreserveKeysResource": { "type": "string", "title": "PreserveKeysResource" }, "SegmentResource": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CaptureTagResource" } } }, "required": [ "id", "position", "text" ], "title": "SegmentResource" }, "Sentiment": { "type": "string", "enum": [ "positive", "negative" ], "title": "Sentiment" }, "SettingResource": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "type": {}, "value": {}, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "value", "created_at" ], "title": "SettingResource" }, "SpecialPlan": { "type": "string", "enum": [ "team", "friends_and_family", "tester" ], "title": "SpecialPlan" }, "SubscriptionModuleActivationResource": { "type": "object", "properties": { "module": { "type": "string" }, "status": { "type": "string", "const": "active" } }, "required": [ "module", "status" ], "title": "SubscriptionModuleActivationResource" }, "SubscriptionModulePreviewResource": { "type": "object", "properties": { "recurring": { "type": "string" }, "prorated_now": { "type": "string" } }, "required": [ "recurring", "prorated_now" ], "title": "SubscriptionModulePreviewResource" }, "SubscriptionModuleStoreRequest": { "type": "object", "properties": { "module": { "$ref": "#\/components\/schemas\/BillingModule" } }, "required": [ "module" ], "title": "SubscriptionModuleStoreRequest" }, "SubscriptionResource": { "type": "object", "properties": { "entitlements": { "type": "array", "items": {} }, "plan": { "$ref": "#\/components\/schemas\/Plan" }, "is_active": { "type": "string" }, "subscribed": { "type": "string" }, "has_special_plan": { "type": "string", "description": "Granted rather than bought: a plan with nothing to pay or cancel." }, "can_manage_billing": { "type": "string", "description": "Whether whoever asks may change it. A screen decides what to offer on this\nrather than on a role: who pays is not always who holds one." }, "payment_processor": { "type": "string" }, "payment_processor_data": { "type": "string", "description": "The web processor's own record; Apple keeps everything on its side." } }, "required": [ "entitlements", "plan", "is_active", "subscribed", "has_special_plan", "can_manage_billing", "payment_processor" ], "title": "SubscriptionResource" }, "SubscriptionStoreRequest": { "type": "object", "properties": { "plan": { "type": "string", "description": "The paid plan, for an app that sells more than one. Left out, the full\naccess plan is bought.", "const": "premium" }, "billing_period": { "$ref": "#\/components\/schemas\/BillingPeriod" }, "modules": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingModule" } } }, "required": [ "billing_period" ], "title": "SubscriptionStoreRequest" }, "SubscriptionUpdateRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "canceled" ] }, "plan": { "type": "string", "const": "premium" }, "billing_period": { "$ref": "#\/components\/schemas\/BillingPeriod" } }, "title": "SubscriptionUpdateRequest" }, "TagType": { "type": "string", "description": "What a tag is. The three the engine counts on (trigger, feeling, behaviour) are the method-neutral shape every method reads; the rest give a pattern its context. Fixed: user-defined types are out of v1.\n", "enum": [ "trigger", "positive_feeling", "negative_feeling", "good_behaviour", "bad_behaviour", "person", "location", "activity" ], "title": "TagType" }, "TimelineDayResource": { "type": "object", "properties": { "date": { "type": "string" }, "captures": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CaptureSummaryResource" } }, "patterns": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PatternSummaryResource" } } }, "required": [ "date", "captures", "patterns" ], "title": "TimelineDayResource" }, "TwoFactorLoginRequest": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "recovery_code": { "type": [ "string", "null" ] } }, "title": "TwoFactorLoginRequest" }, "TwoFactorPersonalAccessTokenStoreRequest": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ], "title": "TwoFactorPersonalAccessTokenStoreRequest" }, "UserResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "special_plan": { "anyOf": [ { "$ref": "#\/components\/schemas\/SpecialPlan" }, { "type": "null" } ] }, "is_admin": { "type": "boolean", "description": "Whether they run the product itself, which is what opens the\nscreens that are nobody's account in particular." }, "email_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "locale": { "type": [ "string", "null" ] }, "provider_id": { "type": [ "string", "null" ] }, "provider_name": { "anyOf": [ { "$ref": "#\/components\/schemas\/OAuthProvider" }, { "type": "null" } ] } }, "required": [ "id", "name", "first_name", "last_name", "email", "special_plan", "is_admin", "email_verified_at", "locale", "provider_id", "provider_name" ], "title": "UserResource" }, "UserSettingBulkUpdateRequest": { "type": "object", "properties": { "timezone": { "type": "string" }, "app_locale": { "type": "string", "enum": [ "en", "nl" ] }, "send_reminder_notifications": { "type": "boolean" }, "app_last_used_or_dismissed_at": { "type": "string", "format": "date-time" } }, "title": "UserSettingBulkUpdateRequest" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }