@pushwoosh/rpc-v2-http-api-data 0.2.64 → 0.2.66

package/integrations.d.ts

@@ -29,49 +29,92 @@ export type IntegrationsService_TestGoogleBQConnection = RpcMethod<TestGoogleBQC
 export type IntegrationsService_ListGoogleBQDatasets = RpcMethod<ListGoogleBQDatasetsRequest, ListGoogleBQDatasetsResponse>;
 export type IntegrationsService_ListGoogleBQTables = RpcMethod<ListGoogleBQTablesRequest, ListGoogleBQTablesResponse>;
 export interface IntegrationsService {
-    /** lists configuration for each output integration (declared in Integration enums) */
+    /** Lists which output integrations (webhook, Segment, Piano, HubSpot, Shopify, Stripe, Meta, Google BigQuery, inbound webhook) are configured for an application code XXXXX-XXXXX. Use for an at-a-glance configured/not-configured overview before fetching a specific integration's configuration. */
     ListIntegrationsConfiguration: IntegrationsService_ListIntegrationsConfiguration;
-    /** webhook */
+    /**
+     * webhook
+     * Returns the outbound webhook integration configuration for an application code XXXXX-XXXXX: target URL, auth header, subscribed and available events, transport and filters. Use to inspect the outbound webhook that forwards PW events to a third-party endpoint (not the inbound webhook).
+     */
     GetWebhookConfiguration: IntegrationsService_GetWebhookConfiguration;
+    /** Creates or overwrites the outbound webhook integration for an application code XXXXX-XXXXX (URL, auth header, event subscriptions, transport, filters). Use to point PW event delivery at a third-party endpoint; re-sending replaces the stored configuration. */
     CreateWebhookConfiguration: IntegrationsService_CreateWebhookConfiguration;
-    /** segment */
+    /**
+     * segment
+     * Returns the Twilio Segment integration configuration for an application code XXXXX-XXXXX: write key plus subscribed and available events. Use to inspect which PW events are forwarded to Segment.
+     */
     GetSegmentConfiguration: IntegrationsService_GetSegmentConfiguration;
+    /** Creates or overwrites the Twilio Segment integration for an application code XXXXX-XXXXX (write key and subscribed events). Use to set up or update event forwarding to Segment; re-sending replaces the stored configuration. */
     CreateSegmentConfiguration: IntegrationsService_CreateSegmentConfiguration;
-    /** piano */
+    /**
+     * piano
+     * Returns the Piano integration configuration for an application code XXXXX-XXXXX: collection domain, site id, API key, subscribed/available events and unique-event grouping settings. Use to inspect the Piano analytics connection.
+     */
     GetPianoConfiguration: IntegrationsService_GetPianoConfiguration;
+    /** Creates or overwrites the Piano integration for an application code XXXXX-XXXXX (collection domain, site id, API key, events and unique-event grouping). Use to set up or update the Piano connection; re-sending replaces the stored configuration. */
     CreatePianoConfiguration: IntegrationsService_CreatePianoConfiguration;
-    /** available only for piano to importing segments from piano to PW */
+    /** Imports a Piano audience segment into Pushwoosh for an application code XXXXX-XXXXX by its Piano segment key. Reaches Piano to pull the segment; use only for Piano-connected applications. */
     ImportSegmentPiano: IntegrationsService_ImportSegmentPiano;
-    /** hubspot */
+    /**
+     * hubspot
+     * Returns the HubSpot integration OAuth configuration for an application code XXXXX-XXXXX: access token, refresh token, connected user id and last-updated time. Use to inspect the HubSpot connection status.
+     */
     GetHubspotConfiguration: IntegrationsService_GetHubspotConfiguration;
-    /** shopify */
+    /**
+     * shopify
+     * Returns the Shopify integration configuration for an application code XXXXX-XXXXX: shop domain, device API key and whether it is the main application. Use to inspect the Shopify connection.
+     */
     GetShopifyConfiguration: IntegrationsService_GetShopifyConfiguration;
-    /** stripe */
+    /**
+     * stripe
+     * Builds the Stripe OAuth authorization URL to start connecting a Stripe account, given a redirect URI. Use to begin the Stripe connect flow; the user visits the URL and returns via connect_stripe_integration.
+     */
     GetStripeAuthURL: IntegrationsService_GetStripeAuthURL;
+    /** Completes the Stripe OAuth flow by exchanging the returned authorization code for tokens and storing the Stripe connection for an application code XXXXX-XXXXX. Call after the user finishes the get_stripe_auth_url redirect; the code is single-use. */
     HandleStripeAuthCallback: IntegrationsService_HandleStripeAuthCallback;
+    /** Returns the connected Stripe account for the current account: business name and email. Use to check whether Stripe is connected and to which account. */
     GetStripeConfiguration: IntegrationsService_GetStripeConfiguration;
+    /** Removes the Stripe integration connection for the current account. Use to disconnect Stripe; the stored tokens are revoked and cannot be restored without reconnecting. */
     DeleteStripeConfiguration: IntegrationsService_DeleteStripeConfiguration;
-    /** meta */
+    /**
+     * meta
+     * Builds the Meta (Facebook) OAuth authorization URL to start connecting a Meta account, given a redirect URI. Use to begin the Meta connect flow; the user returns via connect_meta_integration.
+     */
     GetMetaAuthURL: IntegrationsService_GetMetaAuthURL;
+    /** Completes the Meta OAuth flow by exchanging the authorization code for tokens and storing the Meta connection for an application code XXXXX-XXXXX. Call after the get_meta_auth_url redirect; the code is single-use. */
     HandleMetaAuthCallback: IntegrationsService_HandleMetaAuthCallback;
+    /** Returns the Meta integration configuration for the current account: connected ad accounts with status, token validity and the audience tag mapping. Use to inspect the current Meta connection state. */
     GetMetaConfiguration: IntegrationsService_GetMetaConfiguration;
+    /** Removes the entire Meta integration connection for the current account, including all connected ad accounts and tag mapping. Use to fully disconnect Meta; not recoverable without reconnecting. */
     DeleteMetaConfiguration: IntegrationsService_DeleteMetaConfiguration;
+    /** Disconnects the given Meta ad accounts by id while keeping the overall Meta connection. Use to remove specific ad accounts; to drop the whole connection use delete_meta_integration. */
     DisconnectMetaAdAccounts: IntegrationsService_DisconnectMetaAdAccounts;
+    /** Refreshes the Meta connection for a single ad account id, re-validating its access token with Meta. Use when an ad account shows an invalid or expired token. */
     RefreshMetaConnection: IntegrationsService_RefreshMetaConnection;
+    /** Lists the Meta ad accounts available to the connected Meta account, each with connection status and business info. Use to discover ad accounts before connecting them with connect_meta_ad_accounts. */
     ListMetaAdAccounts: IntegrationsService_ListMetaAdAccounts;
+    /** Connects the given Meta ad accounts by id, returning the connected ids and any that require accepting Meta terms of service first. Use after list_meta_ad_accounts to activate selected ad accounts. */
     ConnectMetaAdAccounts: IntegrationsService_ConnectMetaAdAccounts;
+    /** Overwrites the mapping between Pushwoosh tags and Meta custom-audience fields for the current account. Use to define which PW tags sync to Meta audiences; replaces the entire mapping. */
     SetMetaTagMapping: IntegrationsService_SetMetaTagMapping;
-    /** google_bq */
+    /**
+     * google_bq
+     * Returns the Google BigQuery integration configuration for an application code XXXXX-XXXXX: GCP project, dataset, region, service-account email and export settings (enabled, event types, table). Use to inspect the BigQuery export setup.
+     */
     GetGoogleBQConfiguration: IntegrationsService_GetGoogleBQConfiguration;
+    /** Creates or overwrites the Google BigQuery integration for an application code XXXXX-XXXXX (connection credentials and event-export settings). Use to set up or update BigQuery export; re-sending replaces the stored configuration. */
     CreateGoogleBQConfiguration: IntegrationsService_CreateGoogleBQConfiguration;
+    /** Removes the Google BigQuery integration for an application code XXXXX-XXXXX. Use to disconnect BigQuery export; the stored service-account credentials are deleted. */
     DeleteGoogleBQConfiguration: IntegrationsService_DeleteGoogleBQConfiguration;
+    /** Validates Google BigQuery credentials for an application code XXXXX-XXXXX by connecting to BigQuery, returning ok plus an error code/message. Pass inline credentials to test before saving, or leave them empty to validate the stored configuration. */
     TestGoogleBQConnection: IntegrationsService_TestGoogleBQConnection;
     /**
      * POST + body: '*' is deliberate — the request carries the Service Account
      * JSON when listing pre-save, and we don't want a PEM key on the URL (access
      * logs, browser history, proxy logs, URL length limits).
+     * Lists Google BigQuery datasets for an application code XXXXX-XXXXX, optionally using inline credentials (both project id and service-account JSON required) instead of the stored ones. Use to populate a destination-dataset picker before saving the integration.
      */
     ListGoogleBQDatasets: IntegrationsService_ListGoogleBQDatasets;
+    /** Lists tables and views in a Google BigQuery dataset for an application code XXXXX-XXXXX. Use after list_google_bq_datasets to pick a destination table for export. */
     ListGoogleBQTables: IntegrationsService_ListGoogleBQTables;
 }
 /** Integration contains all available integration for clients (to update props) */
@@ -213,13 +256,16 @@ export type GetShopifyConfigurationResponse = {
 };
 /** Stripe messages */
 export type GetStripeAuthURLRequest = {
+    /** URI Stripe redirects back to after authorization */
     redirectUri?: string;
 };
 export type GetStripeAuthURLResponse = {
     authUrl: string;
 };
 export type HandleStripeAuthCallbackRequest = {
+    /** single-use OAuth authorization code returned by Stripe */
     code?: string;
+    /** application code (format XXXXX-XXXXX) */
     applicationCode?: string;
 };
 export type HandleStripeAuthCallbackResponse = {};
@@ -232,14 +278,18 @@ export type DeleteStripeConfigurationRequest = {};
 export type DeleteStripeConfigurationResponse = {};
 /** Meta messages */
 export type GetMetaAuthURLRequest = {
+    /** URI Meta redirects back to after authorization */
     redirectUri?: string;
 };
 export type GetMetaAuthURLResponse = {
     authUrl: string;
 };
 export type HandleMetaAuthCallbackRequest = {
+    /** single-use OAuth authorization code returned by Meta */
     code?: string;
+    /** redirect URI used to obtain the code (must match) */
     redirectUri?: string;
+    /** application code (format XXXXX-XXXXX) */
     applicationCode?: string;
 };
 export type HandleMetaAuthCallbackResponse = {};
@@ -263,10 +313,12 @@ export type GetMetaConfigurationResponse = {
 export type DeleteMetaConfigurationRequest = {};
 export type DeleteMetaConfigurationResponse = {};
 export type DisconnectMetaAdAccountsRequest = {
+    /** Meta ad account ids to disconnect */
     adAccountIds?: string[];
 };
 export type DisconnectMetaAdAccountsResponse = {};
 export type RefreshMetaConnectionRequest = {
+    /** Meta ad account id whose connection to refresh */
     adAccountId?: string;
 };
 export type RefreshMetaConnectionResponse = {};
@@ -281,6 +333,7 @@ export type ListMetaAdAccountsResponse = {
     adAccounts: ListMetaAdAccountsResponse_MetaAdAccount[];
 };
 export type ConnectMetaAdAccountsRequest = {
+    /** Meta ad account ids to connect */
     adAccountIds?: string[];
 };
 export type ConnectMetaAdAccountsResponse_TosRequired = {
@@ -292,6 +345,7 @@ export type ConnectMetaAdAccountsResponse = {
     tosRequired: ConnectMetaAdAccountsResponse_TosRequired[];
 };
 export type SetMetaTagMappingRequest = {
+    /** Pushwoosh tag name -> Meta custom-audience field */
     tagMapping?: Record<string, string>;
 };
 export type GetGoogleBQConfigurationRequest = {

package/internal_alerts.d.ts

@@ -8,17 +8,27 @@ export type InternalAlertsService_List = RpcMethod<ListRequest, ListResponse>;
 export type InternalAlertsService_UpdateStatus = RpcMethod<UpdateStatusRequest, UpdateStatusResponse>;
 export type InternalAlertsService_GetHighestSeverity = RpcMethod<GetHighestSeverityRequest, GetHighestSeverityResponse>;
 export interface InternalAlertsService {
+    /** Lists in-product alerts for the authenticated account, filtered by type, status and severity, with paging and ordering. Use to show the account's notification/alert feed before marking any as read via update_alert_statuses. */
     List: InternalAlertsService_List;
+    /** Sets the status (e.g. read/unread) of one or more alerts identified by uuid for the authenticated account. Use to mark alerts read or dismissed; all listed uuids must belong to the account or the call fails. */
     UpdateStatus: InternalAlertsService_UpdateStatus;
+    /** Returns the highest alert severity present for the account, optionally restricted to alerts of a given status. Use to drive a single badge/indicator without fetching the full list via list_alerts. */
     GetHighestSeverity: InternalAlertsService_GetHighestSeverity;
 }
 export type ListRequest = {
+    /** Optional filter: return only alerts of this type. */
     type?: pushwoosh_accounts_alerts_v1_AlertType;
+    /** Optional filter: return only alerts in this status (e.g. read/unread). */
     status?: pushwoosh_accounts_alerts_v1_AlertStatus;
+    /** Optional filter: return only alerts of this severity. */
     severity?: pushwoosh_accounts_alerts_v1_AlertSeverity;
+    /** Zero-based page index. */
     page?: number;
+    /** Page size. */
     perPage?: number;
+    /** Field to order the alerts by. */
     orderBy?: pushwoosh_accounts_alerts_v1_OrderBy;
+    /** Ascending or descending order. */
     orderDirection?: pushwoosh_accounts_alerts_v1_OrderDirection;
 };
 export type Alert = {
@@ -42,14 +52,18 @@ export type ListResponse = {
     total: number;
 };
 export type UpdateStatusRequest_AlertStatusUpdate = {
+    /** UUID of the alert to update. */
     uuid: string;
+    /** New status to set on the alert (e.g. read/unread). */
     status: pushwoosh_accounts_alerts_v1_AlertStatus;
 };
 export type UpdateStatusRequest = {
+    /** Alerts to update; every uuid must belong to the authenticated account. */
     alerts?: UpdateStatusRequest_AlertStatusUpdate[];
 };
 export type UpdateStatusResponse = {};
 export type GetHighestSeverityRequest = {
+    /** Optional filter: consider only alerts in this status (e.g. read/unread). */
     status?: pushwoosh_accounts_alerts_v1_AlertStatus;
 };
 export type GetHighestSeverityResponse = {

package/ios_categories.d.ts

@@ -5,21 +5,27 @@ export type IOSCategoriesService_Create = RpcMethod<CreateIOSCategoryRequest, Cr
 export type IOSCategoriesService_Update = RpcMethod<UpdateIOSCategoryRequest, UpdateIOSCategoryResponse>;
 export type IOSCategoriesService_Delete = RpcMethod<DeleteIOSCategoryRequest, DeleteIOSCategoryResponse>;
 export interface IOSCategoriesService {
+    /** Lists an application's iOS notification action categories (each a named set of action buttons), newest first, with paging and an optional name/identifier search. Use to browse categories or find an identifier before get/update/delete. */
     List: IOSCategoriesService_List;
+    /** Returns one iOS notification category by its identifier within an application, including its action buttons. Use after list_ios_categories to inspect a single category. */
     Get: IOSCategoriesService_Get;
+    /** Creates a new iOS notification action category with its buttons in an application. Fails if the identifier already exists for the application; use update_ios_category to change an existing one. */
     Create: IOSCategoriesService_Create;
+    /** Overwrites an existing iOS notification category's name and action buttons, addressed by application and identifier. Use to edit a category; the identifier itself is not changed. */
     Update: IOSCategoriesService_Update;
+    /** Deletes an iOS notification category by application and identifier. Removing a category cannot be undone; a missing identifier is treated as a no-op. */
     Delete: IOSCategoriesService_Delete;
 }
 export type ListIOSCategoriesRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListIOSCategoriesRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListIOSCategoriesRequest = {
+    /** Application code (XXXXX-XXXXX) whose iOS categories to list. */
     application?: string;
     orderBy?: ListIOSCategoriesRequest_OrderBy;
     orderDirection?: ListIOSCategoriesRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Case-insensitive substring matched against both category name and identifier. */
     searchByName?: string;
 };
 export type IOSCategory = {
@@ -41,15 +47,19 @@ export type ListIOSCategoriesResponse = {
     total: number;
 };
 export type GetIOSCategoryRequest = {
+    /** Application code (XXXXX-XXXXX) that owns the category. */
     application?: string;
+    /** Category identifier, unique within the application. */
     identifier?: string;
 };
 export type GetIOSCategoryResponse = {
     preset: IOSCategory;
 };
 export type CreateIOSCategoryRequest = {
+    /** Application code (XXXXX-XXXXX) to create the category in. */
     application?: string;
     name?: string;
+    /** Category identifier, must be unique within the application; if empty, the created record ID is used. */
     identifier?: string;
     buttons?: IOSCategoryButton[];
 };
@@ -57,7 +67,9 @@ export type CreateIOSCategoryResponse = {
     preset: IOSCategory;
 };
 export type UpdateIOSCategoryRequest = {
+    /** Application code (XXXXX-XXXXX) that owns the category. */
     application?: string;
+    /** Category identifier, unique within the application. */
     identifier?: string;
     name?: string;
     buttons?: IOSCategoryButton[];
@@ -66,7 +78,9 @@ export type UpdateIOSCategoryResponse = {
     preset: IOSCategory;
 };
 export type DeleteIOSCategoryRequest = {
+    /** Application code (XXXXX-XXXXX) that owns the category. */
     application?: string;
+    /** Category identifier, unique within the application. */
     identifier?: string;
 };
 export type DeleteIOSCategoryResponse = {};

package/kakao_presets.d.ts

@@ -7,17 +7,25 @@ export type KakaoPresetsService_Delete = RpcMethod<DeleteKakaoPresetRequest, Del
 export type KakaoPresetsService_Clone = RpcMethod<CloneKakaoPresetRequest, CloneKakaoPresetResponse>;
 export type KakaoPresetsService_SubmitForApproval = RpcMethod<SubmitForApprovalKakaoPresetRequest, SubmitForApprovalKakaoPresetResponse>;
 export interface KakaoPresetsService {
+    /** Lists Kakao (KakaoTalk) message-template presets for an application, with paging and optional name/category filters, refreshing each preset's approval status live from the SureM/Kakao server. Use to browse Kakao presets or find a preset code before fetching or editing one. */
     List: KakaoPresetsService_List;
+    /** Returns one Kakao preset by its preset code, refreshing its approval status and template from the SureM/Kakao server. Use after list_kakao_presets to inspect a single preset. */
     Get: KakaoPresetsService_Get;
+    /** Creates a Kakao message-template preset in an application and registers the template on the SureM/Kakao server. Use to author a new KakaoTalk template; the template field is a KakaoTemplate JSON document. */
     Create: KakaoPresetsService_Create;
+    /** Overwrites a Kakao preset's name, categories and template and pushes the new template to the SureM/Kakao server. Allowed only while the preset is not yet submitted or approved; use to edit a draft before submitting for approval. */
     Update: KakaoPresetsService_Update;
+    /** Deletes a Kakao preset and removes its template from the SureM/Kakao server. Blocked for approved presets and presets used in a journey; use to remove a draft or rejected preset. */
     Delete: KakaoPresetsService_Delete;
+    /** Clones an existing Kakao preset into a target application, creating a new preset with a new code and registering its template on the SureM/Kakao server. Use to duplicate a KakaoTemplate instead of re-authoring it. */
     Clone: KakaoPresetsService_Clone;
+    /** Submits a Kakao preset's template to the SureM/Kakao server for KakaoTalk approval review. Use once the template is final; fails if the preset is already submitted or approved. */
     SubmitForApproval: KakaoPresetsService_SubmitForApproval;
 }
 export type ListKakaoPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListKakaoPresetsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListKakaoPresetsRequest = {
+    /** application code (XXXXX-XXXXX) whose Kakao presets to list */
     application?: string;
     orderBy?: ListKakaoPresetsRequest_OrderBy;
     orderDirection?: ListKakaoPresetsRequest_OrderDirection;
@@ -45,42 +53,52 @@ export type ListKakaoPresetsResponse = {
     total: number;
 };
 export type GetKakaoPresetRequest = {
+    /** Kakao preset code */
     code?: string;
 };
 export type GetKakaoPresetResponse = {
     preset: KakaoPreset;
 };
 export type CreateKakaoPresetRequest = {
+    /** application code (XXXXX-XXXXX) to create the preset in */
     application?: string;
     name?: string;
     categories?: string[];
+    /** KakaoTemplate as a JSON document */
     template?: string;
 };
 export type CreateKakaoPresetResponse = {
     preset: KakaoPreset;
 };
 export type UpdateKakaoPresetRequest = {
+    /** Kakao preset code to update */
     code?: string;
     name?: string;
     categories?: string[];
+    /** KakaoTemplate as a JSON document */
     template?: string;
 };
 export type UpdateKakaoPresetResponse = {
     preset: KakaoPreset;
 };
 export type DeleteKakaoPresetRequest = {
+    /** Kakao preset code to delete */
     code?: string;
 };
 export type DeleteKakaoPresetResponse = {};
 export type CloneKakaoPresetRequest = {
+    /** source Kakao preset code to clone from */
     kakaoPresetCode?: string;
+    /** application code (XXXXX-XXXXX) to place the clone in */
     applicationCode?: string;
 };
 export type CloneKakaoPresetResponse = {
     kakaoPresetCode: string;
 };
 export type SubmitForApprovalKakaoPresetRequest = {
+    /** Kakao preset code to submit for approval */
     code?: string;
+    /** application code (XXXXX-XXXXX) the preset belongs to */
     application?: string;
 };
 export type SubmitForApprovalKakaoPresetResponse = {};

package/line_presets.d.ts

@@ -6,24 +6,31 @@ export type linePresetsService_Update = RpcMethod<UpdateLinePresetRequest, Updat
 export type linePresetsService_Delete = RpcMethod<DeleteLinePresetRequest, DeleteLinePresetResponse>;
 export type linePresetsService_Clone = RpcMethod<CloneLinePresetRequest, CloneLinePresetResponse>;
 export interface linePresetsService {
+    /** Lists LINE message presets (reusable content/flex templates for the LINE channel) of an application, with paging, ordering and optional name/code or category filtering. Use to browse presets or find a preset code before get, update, clone or delete. */
     List: linePresetsService_List;
+    /** Returns a single LINE preset by its preset code, including localized content and localized flex templates. Use after list_line_presets to inspect one preset in full. */
     Get: linePresetsService_Get;
+    /** Creates a new LINE preset in an application from localized content or localized flex templates, assigning a fresh preset code. Each call makes a new preset; use update_line_preset to change an existing one. */
     Create: linePresetsService_Create;
+    /** Overwrites an existing LINE preset identified by preset code with the supplied name, categories and localized content or templates. Use to edit a preset in place; create_line_preset makes a new one instead. */
     Update: linePresetsService_Update;
+    /** Permanently deletes a LINE preset by its preset code. Blocked if the preset is still referenced by a running or paused journey; the removal cannot be undone. */
     Delete: linePresetsService_Delete;
+    /** Copies an existing LINE preset into a target application, producing a new preset with its own code. Use to reuse a preset across applications; each call yields a new copy. */
     Clone: linePresetsService_Clone;
 }
 export type ListLinePresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
 export type ListLinePresetsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListLinePresetsRequest = {
+    /** Application code (XXXXX-XXXXX) whose LINE presets to list. */
     application?: string;
     orderBy?: ListLinePresetsRequest_OrderBy;
     orderDirection?: ListLinePresetsRequest_OrderDirection;
     page?: number;
     perPage?: number;
-    /** like %name% */
+    /** Free-text substring matched against preset name OR preset code (case-insensitive). */
     searchByName?: string;
-    /** in ['category'] */
+    /** Keep only presets tagged with any of these category names. */
     searchByCategory?: string[];
 };
 export type Template_kind_image = {
@@ -71,39 +78,47 @@ export type ListLinePresetsResponse = {
     total: number;
 };
 export type GetLinePresetRequest = {
+    /** LINE preset code to fetch. */
     code?: string;
 };
 export type GetLinePresetResponse = {
     preset: LinePreset;
 };
 export type CreateLinePresetRequest = {
+    /** Application code (XXXXX-XXXXX) the new preset belongs to. */
     application?: string;
     name?: string;
     categories?: string[];
-    /** content map {"en": "content"...} */
+    /** Per-locale plain content, keyed by language code, e.g. {"en": "content"}. Provide this or localized_template. */
     localizedContent?: Record<string, string>;
+    /** Per-locale LINE flex template (image, image carousel or raw), keyed by language code. Provide this or localized_content. */
     localizedTemplate?: Record<string, Template>;
 };
 export type CreateLinePresetResponse = {
     preset: LinePreset;
 };
 export type UpdateLinePresetRequest = {
+    /** LINE preset code to update. */
     code?: string;
     name?: string;
     categories?: string[];
-    /** content map {"en": "content"...} */
+    /** Per-locale plain content, keyed by language code, e.g. {"en": "content"}. Provide this or localized_template. */
     localizedContent?: Record<string, string>;
+    /** Per-locale LINE flex template (image, image carousel or raw), keyed by language code. Provide this or localized_content. */
     localizedTemplate?: Record<string, Template>;
 };
 export type UpdateLinePresetResponse = {
     preset: LinePreset;
 };
 export type DeleteLinePresetRequest = {
+    /** LINE preset code to delete. */
     code?: string;
 };
 export type DeleteLinePresetResponse = {};
 export type CloneLinePresetRequest = {
+    /** Code of the source LINE preset to copy. */
     linePresetCode?: string;
+    /** Application code (XXXXX-XXXXX) the copy is created in. */
     applicationCode?: string;
 };
 export type CloneLinePresetResponse = {

package/media_files.d.ts

@@ -4,22 +4,13 @@ export type MediaFilesService_CreateVariant = RpcMethod<CreateVariantRequest, Cr
 export type MediaFilesService_Delete = RpcMethod<DeleteMediaFileRequest, DeleteMediaFileResponse>;
 export type MediaFilesService_GetUsage = RpcMethod<GetMediaFilesUsageRequest, GetMediaFilesUsageResponse>;
 export interface MediaFilesService {
+    /** Lists an application's media image files newest-first, with paging and an optional filename substring search. Returns only originals by default; pass parent_uuid to instead list the cropped variants of that original. */
     List: MediaFilesService_List;
-    /**
-     * CreateVariant creates a cropped variant of an existing image for the given
-     * aspect ratio. The variant references the original via parent_uuid. Calling
-     * it again with the same original and ratio returns the existing variant.
-     */
+    /** Creates a cropped variant of an existing original image (by uuid) for the given aspect ratio, storing it in S3 as a child of the original. Idempotent per original and ratio: calling again with the same original and ratio returns the existing variant instead of duplicating it. */
     CreateVariant: MediaFilesService_CreateVariant;
-    /**
-     * Delete removes a media file. Deleting an original also removes all of its
-     * cropped variants; deleting a variant removes only that variant.
-     */
+    /** Deletes a media file by uuid, removing its database record and S3 objects; deleting an original cascades to all of its cropped variants, while deleting a variant removes only that variant. Not reversible. */
     Delete: MediaFilesService_Delete;
-    /**
-     * GetUsage returns the total stored size (bytes) and file count for an
-     * application, counting both originals and their cropped variants.
-     */
+    /** Returns an application's media storage footprint: count of original files, total file count including cropped variants, and total bytes stored in S3 (originals, variants and thumbnails). Use to check or report media quota usage for an application code. */
     GetUsage: MediaFilesService_GetUsage;
 }
 /** AspectRatio enumerates the supported aspect ratios for image variants. */
@@ -34,6 +25,7 @@ export type CreateVariantRequest_size_height = {
 };
 export type CreateVariantRequest_size = CreateVariantRequest_size_width | CreateVariantRequest_size_height;
 export type CreateVariantRequest = {
+    /** Application code (format XXXXX-XXXXX) that owns the original image. */
     application?: string;
     /** uuid of the existing original image to derive the variant from. */
     uuid?: string;
@@ -49,9 +41,13 @@ export type CreateVariantResponse = {
     file: MediaFile;
 };
 export type UploadMediaFileRequest = {
+    /** Application code (format XXXXX-XXXXX) to store the image under. */
     application: string;
+    /** Original filename; defaults to "upload_<date>" when empty. */
     filename: string;
+    /** Raw image bytes to upload. */
     data: string;
+    /** MIME type of the image (image/jpeg, image/png, image/gif, image/webp); auto-detected from the bytes when empty. */
     mimeType: string;
     description?: string;
 };
@@ -59,6 +55,7 @@ export type UploadMediaFileResponse = {
     file: MediaFile;
 };
 export type ListMediaFilesRequest = {
+    /** Application code (format XXXXX-XXXXX) whose media files to list. */
     application?: string;
     page?: number;
     perPage?: number;
@@ -80,11 +77,14 @@ export type ListMediaFilesResponse = {
     total: number;
 };
 export type DeleteMediaFileRequest = {
+    /** Application code (format XXXXX-XXXXX) that owns the file. */
     application?: string;
+    /** uuid of the media file to delete (an original cascades to its variants). */
     uuid?: string;
 };
 export type DeleteMediaFileResponse = {};
 export type GetMediaFilesUsageRequest = {
+    /** Application code (format XXXXX-XXXXX) whose media storage usage to compute. */
     application?: string;
 };
 export type GetMediaFilesUsageResponse = {

package/messages.d.ts

@@ -10,15 +10,25 @@ export type MessagesService_FindRecipients = RpcMethod<FindRecipientsRequest, Fi
 export type MessagesService_GetDeviceReceivedMessages = RpcMethod<GetDeviceReceivedMessagesRequest, GetDeviceReceivedMessagesResponse>;
 export type MessagesService_GetDevicesList = RpcMethod<GetDevicesListRequest, GetDevicesListResponse>;
 export interface MessagesService {
+    /** Lists messages (push, email or SMS sends) for an application, newest first, with paging, free-text search and an optional type filter. Use to browse sends or find a message code before fetching details or statistics. */
     List: MessagesService_List;
+    /** Returns a single message by its message code, including type, status, schedule and channel content. Use after list_messages to inspect one send. */
     Get: MessagesService_Get;
+    /** Cancels a scheduled message by code, setting its status to cancelled so it is not sent. Allowed only while the message is still pending, waiting or processing; an already-sent message cannot be cancelled. Keeps the message record — use delete_message to remove it. */
     Cancel: MessagesService_Cancel;
+    /** Deletes a scheduled message by code, removing its record and cancelling the send. Allowed only while the message is still pending, waiting or processing; an already-sent message cannot be deleted. */
     Delete: MessagesService_Delete;
+    /** Returns aggregate delivery and open time-series plus recipient counts for a single message (by message_code) or a whole campaign, over an optional time range. For one send's delivered/opened numbers pass message_code. */
     GetStatistics: MessagesService_GetStatistics;
+    /** Returns per-link click counts (total and unique) for a message or campaign. Use to see which links in the content were clicked and how often. */
     GetLinkClicksStatistics: MessagesService_GetLinkClicksStatistics;
+    /** Returns per-platform delivery error breakdowns (sender and mailbox errors) for a message or campaign over a time range. Use to diagnose why a send under-delivered. */
     GetDeliveryReport: MessagesService_GetDeliveryReport;
+    /** Searches the recipients of a message by hwid or user id and returns their send and open times. Use to check whether and when a specific device or user received a message. */
     FindRecipients: MessagesService_FindRecipients;
+    /** Lists the messages a single device (by hwid) received in an application, optionally filtered to broadcast or transactional. Use to reconstruct one device's message history. */
     GetDeviceReceivedMessages: MessagesService_GetDeviceReceivedMessages;
+    /** Returns the device hwids and user ids targeted by a message code. Use to see the exact audience a message was sent to. */
     GetDevicesList: MessagesService_GetDevicesList;
 }
 export type Type = 'All' | 'Push' | 'Email' | 'Sms';
@@ -62,12 +72,15 @@ export type Message = {
 export type ListMessagesRequest_OrderBy = 'NAME' | 'CREATED' | 'SEND_DATE' | 'UPDATED';
 export type ListMessagesRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListMessagesRequest = {
+    /** Application code (format XXXXX-XXXXX) whose messages to list. */
     application?: string;
     orderBy?: ListMessagesRequest_OrderBy;
     orderDirection?: ListMessagesRequest_OrderDirection;
     page?: number;
     perPage?: number;
+    /** Free-text search over message content and code. */
     search?: string;
+    /** Restrict to these message ids. */
     ids?: number[];
     type?: Type;
 };
@@ -78,23 +91,30 @@ export type ListMessagesResponse = {
     total: number;
 };
 export type GetMessageRequest = {
+    /** Message code of the message to fetch. */
     code?: string;
 };
 export type GetMessageResponse = {
     message: Message;
 };
 export type CancelMessageRequest = {
+    /** Message code of the message to cancel. */
     code?: string;
 };
 export type CancelMessageResponse = {};
 export type DeleteMessageRequest = {
+    /** Message code of the message to delete. */
     code?: string;
 };
 export type DeleteMessageResponse = {};
 export type GetStatisticsRequest = {
+    /** Application code (format XXXXX-XXXXX). Optional if application_group is set. */
     application?: string;
+    /** Application group code; aggregates statistics across the group. */
     applicationGroup?: string;
+    /** Message code to scope statistics to a single send. Leave empty for campaign-level numbers. */
     messageCode?: string;
+    /** Campaign code to scope statistics to a whole campaign. */
     campaign?: string;
     timestampFrom?: Date;
     timestampTo?: Date;
@@ -124,9 +144,13 @@ export type GetStatisticsResponse = {
     metrics: GetStatisticsResponse_Metrics;
 };
 export type GetLinkClicksStatisticsRequest = {
+    /** Application code (format XXXXX-XXXXX). Optional if application_group is set. */
     application?: string;
+    /** Application group code; aggregates across the group. */
     applicationGroup?: string;
+    /** Message code to scope link clicks to a single send. */
     messageCode?: string;
+    /** Campaign code to scope link clicks to a whole campaign. */
     campaign?: string;
     timestampFrom?: Date;
     timestampTo?: Date;
@@ -151,9 +175,13 @@ export type GetLinkClicksStatisticsResponse = {
     uniqClick: number;
 };
 export type GetDeliveryReportRequest = {
+    /** Application code (format XXXXX-XXXXX). Optional if application_group is set. */
     application?: string;
+    /** Application group code; aggregates across the group. */
     applicationGroup?: string;
+    /** Message code to scope the delivery report to a single send. */
     messageCode?: string;
+    /** Campaign code to scope the delivery report to a whole campaign. */
     campaign?: string;
     timestampFrom?: Date;
     timestampTo?: Date;
@@ -187,9 +215,13 @@ export type GetDeliveryReportResponse = {
     mailErrors: GetDeliveryReportResponse_DeliveryReport;
 };
 export type FindRecipientsRequest = {
+    /** Application code (format XXXXX-XXXXX). */
     application?: string;
+    /** Message code to search recipients within. */
     messageCode?: string;
+    /** Campaign code to search recipients within. */
     campaign?: string;
+    /** hwid or user id to search recipients by (not free-text). */
     search?: string;
 };
 export type FindRecipientsResponse_SearchBy = 'hwid' | 'user_id';
@@ -206,7 +238,9 @@ export type FindRecipientsResponse = {
 };
 export type GetDeviceReceivedMessagesRequest_MessageType = 'unspecified' | 'all' | 'broadcast' | 'transactional';
 export type GetDeviceReceivedMessagesRequest = {
+    /** Application code (format XXXXX-XXXXX). */
     application?: string;
+    /** Device hardware id (HWID) whose received messages to list. */
     hwid?: string;
     messageType?: GetDeviceReceivedMessagesRequest_MessageType;
 };
@@ -228,6 +262,7 @@ export type GetDeviceReceivedMessagesResponse = {
     messages: GetDeviceReceivedMessagesResponse_Message[];
 };
 export type GetDevicesListRequest = {
+    /** Message code whose targeted device hwids and user ids to return. */
     messageCode?: string;
 };
 export type GetDevicesListResponse = {