@faable/auth-sdk 2.7.41 → 2.7.43

package/dist/api/api-types.d.ts

@@ -84,6 +84,8 @@ export type RoleMemberMetadata = components["schemas"]["RoleMemberMetadata"];
 export type RoleMetadata = components["schemas"]["RoleMetadata"];
 export type RoleMetadataCreate = components["schemas"]["RoleMetadataCreate"];
 export type RoleUpdate = components["schemas"]["RoleUpdate"];
+export type Session = components["schemas"]["Session"];
+export type SessionMetadata = components["schemas"]["SessionMetadata"];
 export type Team = components["schemas"]["Team"];
 export type TeamCreate = components["schemas"]["TeamCreate"];
 export type TeamMember = components["schemas"]["TeamMember"];

package/dist/api/generated-client.d.ts

@@ -2862,6 +2862,28 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             sent: number;
         }[];
     }>;
+    /**
+     * `GET /internal/usage/sms/range` — operationId: `internal/smsUsageRange`
+     *
+     * SMS a project sent in a time range (platform)
+     *
+     * Sum of the hourly counters of SMS and WhatsApp messages one project handed to the provider between `from` (first full hour after it) and `to`. At most 40 days back. Platform token with `read:usage`.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    internalSmsUsageRange(params?: OpQuery<"internal/smsUsageRange">): Promise<{
+        team: string;
+        from: string;
+        to: string;
+        sent: number;
+    }>;
     /**
      * `GET /log/{log_id}` — operationId: `log/get`
      *
@@ -4571,6 +4593,168 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
+    /**
+     * `GET /session/{session_id}` — operationId: `session/get`
+     *
+     * Get Session
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionGet(session_id: string, params?: OpQuery<"session/get">): Promise<{
+        id: string;
+        user: unknown;
+        sid: string;
+        status: "active" | "revoked";
+        ip?: string | undefined;
+        user_agent?: string | undefined;
+        client?: unknown;
+        connection?: unknown;
+        issuer?: string | undefined;
+        last_seen_at: string;
+        expires_at: string;
+        revoked_at?: string | undefined;
+        revoked_reason?: "user" | "admin" | "logout" | undefined;
+        account: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
+    /**
+     * `GET /session` — operationId: `session/list`
+     *
+     * List Sessions
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionList(params?: Omit<OpQuery<"session/list">, "cursor" | "next">): {
+        all: () => Promise<{
+            id: string;
+            user: unknown;
+            sid: string;
+            status: "active" | "revoked";
+            ip?: string | undefined;
+            user_agent?: string | undefined;
+            client?: unknown;
+            connection?: unknown;
+            issuer?: string | undefined;
+            last_seen_at: string;
+            expires_at: string;
+            revoked_at?: string | undefined;
+            revoked_reason?: "user" | "admin" | "logout" | undefined;
+            account: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string | undefined;
+        }[]>;
+        first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            user: unknown;
+            sid: string;
+            status: "active" | "revoked";
+            ip?: string | undefined;
+            user_agent?: string | undefined;
+            client?: unknown;
+            connection?: unknown;
+            issuer?: string | undefined;
+            last_seen_at: string;
+            expires_at: string;
+            revoked_at?: string | undefined;
+            revoked_reason?: "user" | "admin" | "logout" | undefined;
+            account: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string | undefined;
+        }>>;
+        pass: (params?: {
+            cursor?: string | undefined;
+            pageSize?: string | undefined;
+        } | undefined) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            user: unknown;
+            sid: string;
+            status: "active" | "revoked";
+            ip?: string | undefined;
+            user_agent?: string | undefined;
+            client?: unknown;
+            connection?: unknown;
+            issuer?: string | undefined;
+            last_seen_at: string;
+            expires_at: string;
+            revoked_at?: string | undefined;
+            revoked_reason?: "user" | "admin" | "logout" | undefined;
+            account: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string | undefined;
+        }>>;
+    };
+    /**
+     * `POST /session/{session_id}/revoke` — operationId: `session/revoke`
+     *
+     * Revoke a session
+     *
+     * Ends the session for good: the browser cookie behind it stops working, every refresh token issued through it is refused on its next use (`invalid_grant`), and the relying parties that took part in it are notified. Access and id tokens already issued keep working until they expire. The row stays, marked `revoked`, for the device history.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `session_already_revoked` (409) — The session was already revoked.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionRevoke(session_id: string): Promise<{
+        id: string;
+        user: unknown;
+        sid: string;
+        status: "active" | "revoked";
+        ip?: string | undefined;
+        user_agent?: string | undefined;
+        client?: unknown;
+        connection?: unknown;
+        issuer?: string | undefined;
+        last_seen_at: string;
+        expires_at: string;
+        revoked_at?: string | undefined;
+        revoked_reason?: "user" | "admin" | "logout" | undefined;
+        account: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
     /**
      * `POST /team/{team_id}/member` — operationId: `team/addMembers`
      *

package/dist/api/generated-client.js

@@ -1062,6 +1062,25 @@ export class GeneratedFaableAuthApi extends FaableApi {
     internalSmsUsage(params) {
         return this.fetcher.request({ method: "GET", url: `/internal/usage/sms`, params });
     }
+    /**
+     * `GET /internal/usage/sms/range` — operationId: `internal/smsUsageRange`
+     *
+     * SMS a project sent in a time range (platform)
+     *
+     * Sum of the hourly counters of SMS and WhatsApp messages one project handed to the provider between `from` (first full hour after it) and `to`. At most 40 days back. Platform token with `read:usage`.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    internalSmsUsageRange(params) {
+        return this.fetcher.request({ method: "GET", url: `/internal/usage/sms/range`, params });
+    }
     /**
      * `GET /log/{log_id}` — operationId: `log/get`
      *
@@ -1639,6 +1658,69 @@ export class GeneratedFaableAuthApi extends FaableApi {
     rolememberList(params) {
         return this.paginator({ url: `/rolemember`, params });
     }
+    /**
+     * `GET /session/{session_id}` — operationId: `session/get`
+     *
+     * Get Session
+     *
+     * @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionGet(session_id, params) {
+        requireId("session_id", session_id);
+        return this.fetcher.request({ method: "GET", url: `/session/${session_id}`, params });
+    }
+    /**
+     * `GET /session` — operationId: `session/list`
+     *
+     * List Sessions
+     *
+     * @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
+     * @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
+     * @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionList(params) {
+        return this.paginator({ url: `/session`, params });
+    }
+    /**
+     * `POST /session/{session_id}/revoke` — operationId: `session/revoke`
+     *
+     * Revoke a session
+     *
+     * Ends the session for good: the browser cookie behind it stops working, every refresh token issued through it is refused on its next use (`invalid_grant`), and the relying parties that took part in it are notified. Access and id tokens already issued keep working until they expire. The row stays, marked `revoked`, for the device history.
+     *
+     * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
+     * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
+     * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
+     * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
+     * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
+     * @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
+     * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
+     * @throws {FaableApiError} `session_already_revoked` (409) — The session was already revoked.
+     * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
+     * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
+     */
+    sessionRevoke(session_id) {
+        requireId("session_id", session_id);
+        return this.fetcher.post(`/session/${session_id}/revoke`, {});
+    }
     /**
      * `POST /team/{team_id}/member` — operationId: `team/addMembers`
      *