@pushwoosh/rpc-v2-http-api-data 0.2.289 → 0.2.290

package/api_tokens.d.ts

@@ -1,6 +1,8 @@
 import { RpcMethod } from './commonTypes';
 export type ApiTokensService_Create = RpcMethod<CreateApiTokenRequest, CreateApiTokenResponse>;
 export type ApiTokensService_Get = RpcMethod<GetApiTokenRequest, GetApiTokenResponse>;
+export type ApiTokensService_GetUsage = RpcMethod<GetApiTokenUsageRequest, GetApiTokenUsageResponse>;
+export type ApiTokensService_GetUsageSummary = RpcMethod<GetApiTokenUsageSummaryRequest, GetApiTokenUsageSummaryResponse>;
 export type ApiTokensService_List = RpcMethod<ListApiTokensRequest, ListApiTokensResponse>;
 export type ApiTokensService_Update = RpcMethod<UpdateApiTokenRequest, UpdateApiTokenResponse>;
 export type ApiTokensService_Delete = RpcMethod<DeleteApiTokenRequest, DeleteApiTokenResponse>;
@@ -13,6 +15,10 @@ export interface ApiTokensService {
     Create: ApiTokensService_Create;
     /** Returns one API token by its token code, including type and the resolved application/group restrictions. Use after list_api_tokens to inspect a single token's scope. */
     Get: ApiTokensService_Get;
+    /** Returns the calls made with one API token: time, caller address, API method, application, message code and outcome. Use to answer "who sent this message and from where", including transactional sends that never reach message history. */
+    GetUsage: ApiTokensService_GetUsage;
+    /** Returns the token card summary: when and from where the token was last used, and how many calls it was refused over the last 7 and 30 days. */
+    GetUsageSummary: ApiTokensService_GetUsageSummary;
     /** Lists the account's API tokens with paging, ordering and optional name search. Use to browse issued tokens or find a token code before get/update/delete. */
     List: ApiTokensService_List;
     /** Updates an API token's name and/or restriction scope by token code, overwriting the stored restrictions. Use to rename a token or change which applications, groups and modify rights it carries. */
@@ -191,3 +197,51 @@ export type GrantDeviceDataModificationRightAllRequest = {
     selectAll?: boolean;
 };
 export type GrantDeviceDataModificationRightAllResponse = {};
+/** One recorded call made with an API token. */
+export type ApiTokenUsage = {
+    /** When the call happened. */
+    timestamp: Date;
+    /** Address the call came from, as our edge resolved it. */
+    clientIp: string;
+    /** API method that was called, e.g. /json/1.3/createMessage. */
+    method: string;
+    /** Application the call touched, empty when the method is not application-scoped. */
+    applicationCode: string;
+    /** Public message code of the send; the key to find transactional sends, which have no message id. */
+    messageCode: string;
+    /** Number of recipients the send reached; filled by the completion row, zero on the request row. */
+    audienceSize: number;
+    /** Outcome: ok, denied_ip, denied_acl or completed. */
+    result: string;
+    /** Origin the call was made via, e.g. api, live activity api. */
+    createdVia: string;
+};
+export type GetApiTokenUsageRequest = {
+    /** API token code. */
+    code?: string;
+    /** Start of the time window (inclusive); omit for no lower bound. */
+    startTime?: Date;
+    /** End of the time window (inclusive); omit for no upper bound. */
+    endTime?: Date;
+    /** Outcome to filter by: ok, denied_ip, denied_acl or completed; e.g. denied_ip lists calls refused by address only. */
+    result?: string;
+    /** Page number, starting from 1. */
+    page?: number;
+    /** Rows per page; defaults to 50. */
+    perPage?: number;
+};
+export type GetApiTokenUsageResponse = {
+    usage: ApiTokenUsage[];
+};
+export type GetApiTokenUsageSummaryRequest = {
+    /** API token code. */
+    code?: string;
+};
+export type GetApiTokenUsageSummaryResponse = {
+    /** Last recorded call, absent when the token has not been used within the journal retention. */
+    lastUsed: ApiTokenUsage;
+    /** Calls the token was refused over the last 7 days: both denied_ip (caller address is not on the token allowlist) and denied_acl (token has no rights on the application). */
+    deniedLast_7Days: number;
+    /** The same count over the last 30 days. */
+    deniedLast_30Days: number;
+};

package/data.js

@@ -4517,6 +4517,18 @@ export const data = {
                 "method": "get",
                 "path": "/api/api_tokens/{code}"
             },
+            "GetUsage": {
+                "request": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageRequest",
+                "response": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageResponse",
+                "method": "get",
+                "path": "/api/api_tokens/{code}/usage"
+            },
+            "GetUsageSummary": {
+                "request": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryRequest",
+                "response": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryResponse",
+                "method": "get",
+                "path": "/api/api_tokens/{code}/usage/summary"
+            },
             "List": {
                 "request": "pushwoosh.rpc_v2.api_tokens.ListApiTokensRequest",
                 "response": "pushwoosh.rpc_v2.api_tokens.ListApiTokensResponse",
@@ -4908,6 +4920,89 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.api_tokens.ApiTokenUsage": {
+        "type": "I",
+        "fields": {
+            "timestamp": {
+                "type": "Date"
+            },
+            "clientIp": {
+                "type": "string"
+            },
+            "method": {
+                "type": "string"
+            },
+            "applicationCode": {
+                "type": "string"
+            },
+            "messageCode": {
+                "type": "string"
+            },
+            "audienceSize": {
+                "type": "number"
+            },
+            "result": {
+                "type": "string"
+            },
+            "createdVia": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "startTime": {
+                "type": "Date"
+            },
+            "endTime": {
+                "type": "Date"
+            },
+            "result": {
+                "type": "string"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usage": {
+                "type": "pushwoosh.rpc_v2.api_tokens.ApiTokenUsage",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryResponse": {
+        "type": "I",
+        "fields": {
+            "lastUsed": {
+                "type": "pushwoosh.rpc_v2.api_tokens.ApiTokenUsage"
+            },
+            "deniedLast_7Days": {
+                "type": "number"
+            },
+            "deniedLast_30Days": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.app_inbox_presets.appInboxPresetsService": {
         "type": "S",
         "key": "appInboxPresets",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.289",
+  "version": "0.2.290",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",