@faable/auth-sdk 2.6.17 → 2.6.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2165,6 +2165,19 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2165
2165
  updatedAt?: string | undefined;
2166
2166
  }>>;
2167
2167
  };
2168
+ /**
2169
+ * `GET /internal/usage/sms` — operationId: `internal/smsUsage`
2170
+ *
2171
+ * SMS sent per tenant in a month (platform)
2172
+ */
2173
+ internalSmsUsage(params?: OpQuery<"internal/smsUsage">): Promise<{
2174
+ month: string;
2175
+ rows: {
2176
+ account_id: string;
2177
+ team: string | null;
2178
+ sent: number;
2179
+ }[];
2180
+ }>;
2168
2181
  /**
2169
2182
  * `GET /log/{log_id}` — operationId: `log/get`
2170
2183
  *
@@ -412,6 +412,14 @@ export class GeneratedFaableAuthApi extends FaableApi {
412
412
  identityList(params) {
413
413
  return this.paginator({ url: `/identity`, params });
414
414
  }
415
+ /**
416
+ * `GET /internal/usage/sms` — operationId: `internal/smsUsage`
417
+ *
418
+ * SMS sent per tenant in a month (platform)
419
+ */
420
+ internalSmsUsage(params) {
421
+ return this.fetcher.request({ method: "GET", url: `/internal/usage/sms`, params });
422
+ }
415
423
  /**
416
424
  * `GET /log/{log_id}` — operationId: `log/get`
417
425
  *
@@ -148,6 +148,26 @@ export interface paths {
148
148
  patch?: never;
149
149
  trace?: never;
150
150
  };
151
+ "/internal/usage/sms": {
152
+ parameters: {
153
+ query?: never;
154
+ header?: never;
155
+ path?: never;
156
+ cookie?: never;
157
+ };
158
+ /**
159
+ * SMS sent per tenant in a month (platform)
160
+ * @description Per-account count of recovery/verification SMS sent in the given month, read from the monthly quota counters. Consumed by the billing usage job. Platform token with `read:usage`.
161
+ */
162
+ get: operations["internal/smsUsage"];
163
+ put?: never;
164
+ post?: never;
165
+ delete?: never;
166
+ options?: never;
167
+ head?: never;
168
+ patch?: never;
169
+ trace?: never;
170
+ };
151
171
  "/connection": {
152
172
  parameters: {
153
173
  query?: never;
@@ -5775,6 +5795,36 @@ export interface operations {
5775
5795
  };
5776
5796
  };
5777
5797
  };
5798
+ "internal/smsUsage": {
5799
+ parameters: {
5800
+ query: {
5801
+ /** @description YYYY-MM, UTC. Defaults to the current month. */
5802
+ month: string;
5803
+ };
5804
+ header?: never;
5805
+ path?: never;
5806
+ cookie?: never;
5807
+ };
5808
+ requestBody?: never;
5809
+ responses: {
5810
+ /** @description Default Response */
5811
+ 200: {
5812
+ headers: {
5813
+ [name: string]: unknown;
5814
+ };
5815
+ content: {
5816
+ "application/json": {
5817
+ month: string;
5818
+ rows: {
5819
+ account_id: string;
5820
+ team: string | null;
5821
+ sent: number;
5822
+ }[];
5823
+ };
5824
+ };
5825
+ };
5826
+ };
5827
+ };
5778
5828
  "connection/list": {
5779
5829
  parameters: {
5780
5830
  query?: {
package/dist/version.js CHANGED
@@ -9,13 +9,13 @@
9
9
  // login pages could not import the SDK at all. Same pattern as auth-js.
10
10
  //
11
11
  // The sentinels MUST stay byte-identical to the `from` values in `.releaserc`.
12
- export const version = "2.6.17";
12
+ export const version = "2.6.18";
13
13
  // Short git SHA of the released commit. The version dates a build; this names
14
14
  // the exact tree, so a canonical log line or an audit entry leads straight to
15
15
  // `git show <sha>`. Deliberately NOT hex: an unreleased build (dev, a local
16
16
  // link) cannot be mistaken for a real commit — auth only records values that
17
17
  // look like a SHA, and this one never will.
18
- export const commit = "bcc574e";
18
+ export const commit = "5c6ffbe";
19
19
  // What this SDK writes in `x-faable-client`. Exported for a consumer that
20
20
  // builds a strategy on its own (outside `FaableAuthApi`) and still wants the
21
21
  // token request attributed — a bare `authClientCredentials` stamps only what
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/auth-sdk",
3
- "version": "2.6.17",
3
+ "version": "2.6.18",
4
4
  "author": "Marc Pomar <marc@faable.com>",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/spec/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "@faablecloud/auth",
5
5
  "description": "Auth Platform made by Faable. Manage Users and Roles",
6
- "version": "2.18.0",
6
+ "version": "2.19.0",
7
7
  "license": {
8
8
  "name": "private",
9
9
  "url": "https://faable.com/docs/platform/privacy-policy"
@@ -10158,6 +10158,83 @@
10158
10158
  }
10159
10159
  }
10160
10160
  },
10161
+ "/internal/usage/sms": {
10162
+ "get": {
10163
+ "operationId": "internal/smsUsage",
10164
+ "summary": "SMS sent per tenant in a month (platform)",
10165
+ "tags": [
10166
+ "account"
10167
+ ],
10168
+ "description": "Per-account count of recovery/verification SMS sent in the given month, read from the monthly quota counters. Consumed by the billing usage job. Platform token with `read:usage`.",
10169
+ "parameters": [
10170
+ {
10171
+ "schema": {
10172
+ "type": "string",
10173
+ "pattern": "^\\d{4}-\\d{2}$"
10174
+ },
10175
+ "in": "query",
10176
+ "name": "month",
10177
+ "required": true,
10178
+ "description": "YYYY-MM, UTC. Defaults to the current month."
10179
+ }
10180
+ ],
10181
+ "security": [
10182
+ {
10183
+ "bearerAuth": []
10184
+ }
10185
+ ],
10186
+ "responses": {
10187
+ "200": {
10188
+ "description": "Default Response",
10189
+ "content": {
10190
+ "application/json": {
10191
+ "schema": {
10192
+ "type": "object",
10193
+ "required": [
10194
+ "month",
10195
+ "rows"
10196
+ ],
10197
+ "properties": {
10198
+ "month": {
10199
+ "type": "string"
10200
+ },
10201
+ "rows": {
10202
+ "type": "array",
10203
+ "items": {
10204
+ "type": "object",
10205
+ "required": [
10206
+ "account_id",
10207
+ "team",
10208
+ "sent"
10209
+ ],
10210
+ "properties": {
10211
+ "account_id": {
10212
+ "type": "string"
10213
+ },
10214
+ "team": {
10215
+ "anyOf": [
10216
+ {
10217
+ "type": "string"
10218
+ },
10219
+ {
10220
+ "type": "null"
10221
+ }
10222
+ ]
10223
+ },
10224
+ "sent": {
10225
+ "type": "integer"
10226
+ }
10227
+ }
10228
+ }
10229
+ }
10230
+ }
10231
+ }
10232
+ }
10233
+ }
10234
+ }
10235
+ }
10236
+ }
10237
+ },
10161
10238
  "/connection": {
10162
10239
  "get": {
10163
10240
  "operationId": "connection/list",