@pushwoosh/rpc-v2-http-api-data 0.2.99 → 0.2.101

package/data.js

@@ -21562,11 +21562,8 @@ export const data = {
             "FILTER_EXPRESSION_INVALID",
             "FILTER_CODE_SEGMENT_NOT_FOUND",
             "FILTER_EXPRESSION_GEO_NOT_SUPPORTED",
-            "CONTENT_SUBSCRIPTION_MUTUALLY_EXCLUSIVE",
-            "CONTENT_OR_SUBSCRIPTION_REQUIRED",
             "SUBSCRIPTION_FORM_CODE_INVALID",
             "SUBSCRIPTION_FORM_CODE_EMPTY",
-            "POPUP_FORM_SOURCE_TYPE_IMMUTABLE",
             "EXCLUDED_PAGE_INVALID",
             "EXCLUDED_PAGE_OPERATOR_INVALID",
             "EXCLUDED_PAGES_TOO_MANY",
@@ -26246,6 +26243,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.test_devices.DeleteResponse",
                 "method": "post",
                 "path": "/api/test_devices:delete"
+            },
+            "GetAutoRegistration": {
+                "request": "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationRequest",
+                "response": "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationResponse",
+                "method": "get",
+                "path": "/api/test_devices/auto_registration"
+            },
+            "SetAutoRegistration": {
+                "request": "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationRequest",
+                "response": "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationResponse",
+                "method": "post",
+                "path": "/api/test_devices/auto_registration"
             }
         }
     },
@@ -26292,6 +26301,9 @@ export const data = {
             },
             "description": {
                 "type": "string"
+            },
+            "autoCreated": {
+                "type": "boolean"
             }
         }
     },
@@ -26350,6 +26362,47 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationResponse": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "expireAt": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "enabled": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationResponse": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "expireAt": {
+                "type": "Date"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.users.UsersService": {
         "type": "S",
         "key": "users",

package/package.json

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

package/pushwoosh_rpc_popup_forms_v3.d.ts

@@ -67,16 +67,10 @@ export type PopupFormsServiceErrors =
  | 'FILTER_CODE_SEGMENT_NOT_FOUND'
 /** filter_expression contains geo conditions, which are not supported for web popups. */
  | 'FILTER_EXPRESSION_GEO_NOT_SUPPORTED'
-/** popup_form_content_code and subscription_form_code are mutually exclusive. */
- | 'CONTENT_SUBSCRIPTION_MUTUALLY_EXCLUSIVE'
-/** Exactly one of popup_form_content_code / subscription_form_code is required. */
- | 'CONTENT_OR_SUBSCRIPTION_REQUIRED'
 /** Subscription form code is invalid. */
  | 'SUBSCRIPTION_FORM_CODE_INVALID'
 /** Subscription form code is required. */
  | 'SUBSCRIPTION_FORM_CODE_EMPTY'
-/** Cannot switch a popup form between a content and a subscription form via update. */
- | 'POPUP_FORM_SOURCE_TYPE_IMMUTABLE'
 /**
  * Excluded page path has invalid format.
  * args: page - the invalid excluded page path value.
@@ -118,11 +112,11 @@ export type PopupFormsService_Activate = RpcMethod<ActivateRequest, ActivateResp
 export interface PopupFormsService {
     /** Lists web popup forms for an application code, newest-published first, with paging, name/code search and an optional status filter; each item carries visitor and impression counts. Use to browse popup forms or find a popup form code before fetching details. */
     List: PopupFormsService_List;
-    /** Returns a single web popup form by its popup form code, including status, display rules, audience targeting and the associated content or subscription form. Use after list_popup_forms to inspect one form's full configuration. */
+    /** Returns a single web popup form by its popup form code, including status, display rules, audience targeting and the associated content and subscription form. Use after list_popup_forms to inspect one form's full configuration. */
     Get: PopupFormsService_Get;
-    /** Creates a new web popup form under an application code from either a popup form content code or a subscription form code (exactly one), returning the server-generated popup form code. The name must be unique within the application. */
+    /** Creates a new web popup form under an application code from a popup form content code, optionally referencing a subscription form as well, returning the server-generated popup form code. The name must be unique within the application. */
     Create: PopupFormsService_Create;
-    /** Updates an existing web popup form by code, patching name, display rules, audience and page rules per explicit update_* flags. Use to change an existing form's configuration; the source type (content vs subscription form) is immutable. */
+    /** Updates an existing web popup form by code, patching name, display rules, audience and page rules per explicit update_* flags. Use to change an existing form's configuration. */
     Update: PopupFormsService_Update;
     /** Permanently deletes a web popup form by its popup form code. Irreversible; use disable_popup_form instead to only pause a form while keeping it. */
     Delete: PopupFormsService_Delete;
@@ -150,17 +144,11 @@ export type PopupForm = {
     description?: string;
     /** Status of Popup Form (active, paused, draft). */
     status: string;
-    /**
-     * Code of associated Popup Form Content.
-     * Set when the popup shows a content; mutually exclusive with subscription_form_code.
-     */
+    /** Code of associated Popup Form Content. Always set. */
     popupFormContentCode: string;
     /** Name of associated Popup Form Content. */
     popupFormContentName: string;
-    /**
-     * Code of associated subscription form.
-     * Set when the popup shows a subscription form; mutually exclusive with popup_form_content_code.
-     */
+    /** Code of associated subscription form. Optional, accompanies the content. */
     subscriptionFormCode: string;
     /** Name of associated subscription form. */
     subscriptionFormName: string;
@@ -268,9 +256,9 @@ export type CreateRequest = {
     name?: string;
     /** Similar to the PopupForm. */
     description?: string;
-    /** Similar to the PopupForm. Provide exactly one of popup_form_content_code / subscription_form_code. */
+    /** Similar to the PopupForm. Required. */
     popupFormContentCode?: string;
-    /** Similar to the PopupForm. Provide exactly one of popup_form_content_code / subscription_form_code. */
+    /** Similar to the PopupForm. Optional. */
     subscriptionFormCode?: string;
     /** Similar to the PopupForm. */
     deviceType?: string;
@@ -309,19 +297,9 @@ export type UpdateRequest = {
     name?: string;
     /** Similar to the PopupForm. */
     description?: string;
-    /**
-     * Similar to the PopupForm. Only valid for a content-based popup form (one
-     * that was created with popup_form_content_code); updates the referenced
-     * content. The source type is immutable — providing this for a
-     * subscription-form popup is rejected. Mutually exclusive with subscription_form_code.
-     */
+    /** Similar to the PopupForm. Updates the referenced content. */
     popupFormContentCode?: string;
-    /**
-     * Similar to the PopupForm. Only valid for a subscription-form popup (one
-     * that was created with subscription_form_code); updates the referenced
-     * subscription form. The source type is immutable — providing this for a
-     * content-based popup is rejected. Mutually exclusive with popup_form_content_code.
-     */
+    /** Similar to the PopupForm. Updates the referenced subscription form. */
     subscriptionFormCode?: string;
     /** Similar to the PopupForm. */
     deviceType?: string;

package/test_devices.d.ts

@@ -3,6 +3,8 @@ export type TestDevicesService_Create = RpcMethod<CreateRequest, CreateResponse>
 export type TestDevicesService_Verify = RpcMethod<VerifyRequest, VerifyResponse>;
 export type TestDevicesService_List = RpcMethod<ListRequest, ListResponse>;
 export type TestDevicesService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
+export type TestDevicesService_GetAutoRegistration = RpcMethod<GetAutoRegistrationRequest, GetAutoRegistrationResponse>;
+export type TestDevicesService_SetAutoRegistration = RpcMethod<SetAutoRegistrationRequest, SetAutoRegistrationResponse>;
 export interface TestDevicesService {
     /** Registers a test device for an application by push token or HWID; for email, SMS, WhatsApp and LINE platforms it instead sends a verification code to the device and returns needs_verify=true, requiring verify_test_device to finish. Use to add a device that receives test sends. */
     Create: TestDevicesService_Create;
@@ -12,6 +14,10 @@ export interface TestDevicesService {
     List: TestDevicesService_List;
     /** Removes a test device from an application by HWID or push token and clears its PW_TestDevice tag on the device. Use to stop a device from receiving test sends; cannot be undone. */
     Delete: TestDevicesService_Delete;
+    /** Reports whether the application currently accepts test devices registered from the app itself (the SDK knock gesture), and when that window expires. Use to render the auto-registration switch and its countdown. */
+    GetAutoRegistration: TestDevicesService_GetAutoRegistration;
+    /** Opens a one-hour window in which the application accepts test devices registered from the app itself, or closes it immediately. While the window is closed such registrations are dropped; adding a test device from the Control Panel is never affected. */
+    SetAutoRegistration: TestDevicesService_SetAutoRegistration;
 }
 export type TestDevice = {
     /** test device name */
@@ -55,6 +61,12 @@ export type CreateRequest = {
     name?: string;
     /** test device description. max length: 64 characters. */
     description?: string;
+    /**
+     * set by the SDK when the device registered itself through the knock gesture
+     * instead of being added on purpose. such registrations are only accepted
+     * while the auto-registration window is open.
+     */
+    autoCreated?: boolean;
 };
 export type CreateResponse = {
     needsVerify: boolean;
@@ -81,3 +93,24 @@ export type DeleteRequest = {
     pushToken?: string;
 };
 export type DeleteResponse = {};
+export type GetAutoRegistrationRequest = {
+    /** application code */
+    application?: string;
+};
+export type GetAutoRegistrationResponse = {
+    /** true while the application accepts test devices registered from the app itself */
+    enabled: boolean;
+    /** when the window closes. unset when enabled is false */
+    expireAt: Date;
+};
+export type SetAutoRegistrationRequest = {
+    /** application code */
+    application?: string;
+    /** true opens the window for an hour, false closes it right away */
+    enabled?: boolean;
+};
+export type SetAutoRegistrationResponse = {
+    enabled: boolean;
+    /** when the window closes. unset when enabled is false */
+    expireAt: Date;
+};