@pushwoosh/rpc-v2-http-api-data 0.2.512 → 0.2.514

package/applications.d.ts

@@ -13,6 +13,8 @@ export type ApplicationsService_GetAccountGroupPermissions = RpcMethod<GetAccoun
 export type ApplicationsService_SaveAccountGroupPermissions = RpcMethod<SaveAccountGroupPermissionsRequest, SaveAccountGroupPermissionsResponse>;
 export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
 export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
+export type ApplicationsService_GetEmailSunsetPolicy = RpcMethod<GetEmailSunsetPolicyRequest, GetEmailSunsetPolicyResponse>;
+export type ApplicationsService_SetEmailSunsetPolicy = RpcMethod<SetEmailSunsetPolicyRequest, SetEmailSunsetPolicyResponse>;
 export interface ApplicationsService {
     /** Returns one Pushwoosh application by its code (format XXXXX-XXXXX) with platforms, subscriber counts, languages and permissions. Use to inspect a single app; use list_applications to browse many. */
     Get: ApplicationsService_Get;
@@ -40,6 +42,10 @@ export interface ApplicationsService {
     GetDOIConfig: ApplicationsService_GetDOIConfig;
     /** Enables or disables double opt-in (DOI) for an application; enabling for the first time clones the confirmation email preset into the account. Use to require email confirmation before subscribing. */
     SetDOIConfig: ApplicationsService_SetDOIConfig;
+    /** Returns the email sunset policy of an application: whether marketing emails skip recipients with no email activity, the inactivity period in days and the activity type. Use before changing it with set_email_sunset_policy. */
+    GetEmailSunsetPolicy: ApplicationsService_GetEmailSunsetPolicy;
+    /** Turns the email sunset policy of an application on or off and sets its period (30, 90, 180, 365 or 730 days) and activity (click, open or both). Enabled without a period or activity, it takes 180 days and both. Transactional emails are never affected. */
+    SetEmailSunsetPolicy: ApplicationsService_SetEmailSunsetPolicy;
 }
 export type ApplicationPlatformSubscribersCount = {
     pushEnabled: number;
@@ -205,3 +211,49 @@ export type SetDOIConfigRequest = {
     enabled?: boolean;
 };
 export type SetDOIConfigResponse = {};
+/** What counts as email activity for the sunset policy. */
+export type EmailSunsetActivityType = 'EMAIL_SUNSET_ACTIVITY_TYPE_UNSPECIFIED' | 'EMAIL_SUNSET_ACTIVITY_TYPE_CLICK' | 'EMAIL_SUNSET_ACTIVITY_TYPE_OPEN' | 'EMAIL_SUNSET_ACTIVITY_TYPE_CLICK_AND_OPEN';
+/** How many marketing emails and users are reached without the sunset policy (total) and with it (sent); skipped is their difference. A user counts as skipped when none of their emails is sent. */
+export type EmailSunsetCounters = {
+    totalEmails: number;
+    totalUsers: number;
+    sentEmails: number;
+    sentUsers: number;
+    skippedEmails: number;
+    skippedUsers: number;
+    /** When the counters were last recounted; unset while a recount is pending. */
+    updatedAt: Date;
+    /** PENDING after the policy is enabled or changed until the recount finishes, DONE once the counters are set. */
+    status: EmailSunsetCountersStatus;
+};
+export type EmailSunsetPolicy = {
+    /** Whether marketing emails skip recipients without activity within the period. */
+    enabled: boolean;
+    /** Inactivity period in days: 30, 90, 180, 365 or 730. */
+    period: number;
+    /** What counts as activity; a recipient without any counts from the First Install tag. */
+    activityType: EmailSunsetActivityType;
+    /** Counters of the whole application, recounted daily while the policy is enabled; only the status while a recount is pending. */
+    counters: EmailSunsetCounters;
+};
+export type EmailSunsetCountersStatus = 'EMAIL_SUNSET_COUNTERS_STATUS_UNSPECIFIED' | 'EMAIL_SUNSET_COUNTERS_STATUS_PENDING' | 'EMAIL_SUNSET_COUNTERS_STATUS_DONE';
+export type GetEmailSunsetPolicyRequest = {
+    /** Application code (format XXXXX-XXXXX) whose email sunset policy to fetch. */
+    code?: string;
+};
+export type GetEmailSunsetPolicyResponse = {
+    policy: EmailSunsetPolicy;
+};
+export type SetEmailSunsetPolicyRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
+    code?: string;
+    /** Whether the policy is on. */
+    enabled?: boolean;
+    /** Inactivity period in days: 30, 90, 180, 365 or 730; 0 keeps the stored value, or 180 when there is none. */
+    period?: number;
+    /** What counts as activity; UNSPECIFIED keeps the stored value, or CLICK_AND_OPEN when there is none. */
+    activityType?: EmailSunsetActivityType;
+};
+export type SetEmailSunsetPolicyResponse = {
+    policy: EmailSunsetPolicy;
+};

package/data.js

@@ -5620,6 +5620,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.applications.SetDOIConfigResponse",
                 "method": "patch",
                 "path": "/api/applications/{code}/doi-config"
+            },
+            "GetEmailSunsetPolicy": {
+                "request": "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyRequest",
+                "response": "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyResponse",
+                "method": "get",
+                "path": "/api/applications/{code}/email-sunset-policy"
+            },
+            "SetEmailSunsetPolicy": {
+                "request": "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyRequest",
+                "response": "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyResponse",
+                "method": "patch",
+                "path": "/api/applications/{code}/email-sunset-policy"
             }
         }
     },
@@ -6025,6 +6037,110 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.applications.EmailSunsetActivityType": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUNSET_ACTIVITY_TYPE_UNSPECIFIED",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_CLICK",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_OPEN",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_CLICK_AND_OPEN"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetCounters": {
+        "type": "I",
+        "fields": {
+            "totalEmails": {
+                "type": "number"
+            },
+            "totalUsers": {
+                "type": "number"
+            },
+            "sentEmails": {
+                "type": "number"
+            },
+            "sentUsers": {
+                "type": "number"
+            },
+            "skippedEmails": {
+                "type": "number"
+            },
+            "skippedUsers": {
+                "type": "number"
+            },
+            "updatedAt": {
+                "type": "Date"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetCountersStatus"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetPolicy": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "period": {
+                "type": "number"
+            },
+            "activityType": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetActivityType"
+            },
+            "counters": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetCounters"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetCountersStatus": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUNSET_COUNTERS_STATUS_UNSPECIFIED",
+            "EMAIL_SUNSET_COUNTERS_STATUS_PENDING",
+            "EMAIL_SUNSET_COUNTERS_STATUS_DONE"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyResponse": {
+        "type": "I",
+        "fields": {
+            "policy": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetPolicy"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "enabled": {
+                "type": "boolean"
+            },
+            "period": {
+                "type": "number"
+            },
+            "activityType": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetActivityType"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyResponse": {
+        "type": "I",
+        "fields": {
+            "policy": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetPolicy"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications.email_froms.ApplicationEmailFromsService": {
         "type": "S",
         "key": "applicationEmailFroms",
@@ -39426,6 +39542,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.tags.GetTagUsageResponse",
                 "method": "get",
                 "path": "/api/tags/{name}:get-tag-usage"
+            },
+            "AddTagField": {
+                "request": "pushwoosh.rpc_v2.tags.AddTagFieldRequest",
+                "response": "pushwoosh.rpc_v2.tags.AddTagFieldResponse",
+                "method": "post",
+                "path": "/api/tags/{name}/fields"
+            },
+            "DeleteTagField": {
+                "request": "pushwoosh.rpc_v2.tags.DeleteTagFieldRequest",
+                "response": "pushwoosh.rpc_v2.tags.DeleteTagFieldResponse",
+                "method": "delete",
+                "path": "/api/tags/{name}/fields/{field}"
             }
         }
     },
@@ -39448,7 +39576,9 @@ export const data = {
             "BOOLEAN",
             "PRICE",
             "VERSION",
-            "TIMEZONE"
+            "TIMEZONE",
+            "OBJECT",
+            "OBJECT_LIST"
         ]
     },
     "pushwoosh.rpc_v2.tags.Tag": {
@@ -39468,6 +39598,21 @@ export const data = {
             },
             "hasRightAceModify": {
                 "type": "boolean"
+            },
+            "fields": {
+                "type": "pushwoosh.rpc_v2.tags.TagField",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.TagField": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "type": {
+                "type": "pushwoosh.rpc_v2.tags.Tag.Type"
             }
         }
     },
@@ -39482,6 +39627,10 @@ export const data = {
             },
             "userSpecific": {
                 "type": "boolean"
+            },
+            "fields": {
+                "type": "pushwoosh.rpc_v2.tags.TagField",
+                "array": true
             }
         }
     },
@@ -39732,6 +39881,44 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.tags.AddTagFieldRequest": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "field": {
+                "type": "pushwoosh.rpc_v2.tags.TagField"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.AddTagFieldResponse": {
+        "type": "I",
+        "fields": {
+            "tag": {
+                "type": "pushwoosh.rpc_v2.tags.Tag"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.DeleteTagFieldRequest": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "field": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.DeleteTagFieldResponse": {
+        "type": "I",
+        "fields": {
+            "tag": {
+                "type": "pushwoosh.rpc_v2.tags.Tag"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.tags.GetTagUsageRequest": {
         "type": "I",
         "fields": {

package/package.json

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

package/tags.d.ts

@@ -7,6 +7,8 @@ export type TagsService_GetTagsUsage = RpcMethod<GetTagsUsageRequest, GetTagsUsa
 export type TagsService_List = RpcMethod<ListTagsRequest, ListTagsResponse>;
 export type TagsService_GetTagValues = RpcMethod<GetTagValuesRequest, GetTagValuesResponse>;
 export type TagsService_GetTagUsage = RpcMethod<GetTagUsageRequest, GetTagUsageResponse>;
+export type TagsService_AddTagField = RpcMethod<AddTagFieldRequest, AddTagFieldResponse>;
+export type TagsService_DeleteTagField = RpcMethod<DeleteTagFieldRequest, DeleteTagFieldResponse>;
 export interface TagsService {
     /** Returns a single account tag (user/device attribute) by name, including its value type and whether it is system-defined or user-specific. Use after list_tags to inspect one tag before editing segments or profiles. */
     Get: TagsService_Get;
@@ -24,26 +26,40 @@ export interface TagsService {
     GetTagValues: TagsService_GetTagValues;
     /** Returns only the segments, in-apps and running or paused journeys that use a tag. For every user of a tag (messages, webhooks, control groups, content) use get_tags_usage. */
     GetTagUsage: TagsService_GetTagUsage;
+    /** Adds a field to an OBJECT or OBJECT_LIST tag; needs object tags enabled for the account. A field is a plain tag named "<object>.<field>"; at most 20 per object. */
+    AddTagField: TagsService_AddTagField;
+    /** Deletes a field of an OBJECT or OBJECT_LIST tag with its stored values; refuses a field still used (see get_tags_usage) and the last field of an object. */
+    DeleteTagField: TagsService_DeleteTagField;
 }
 export type GetTagRequest = {
     /** Tag name to fetch. */
     name?: string;
 };
-export type Tag_Type = 'UNKNOWN' | 'INTEGER' | 'STRING' | 'LIST' | 'DATE' | 'BOOLEAN' | 'PRICE' | 'VERSION' | 'TIMEZONE';
+export type Tag_Type = 'UNKNOWN' | 'INTEGER' | 'STRING' | 'LIST' | 'DATE' | 'BOOLEAN' | 'PRICE' | 'VERSION' | 'TIMEZONE' | 'OBJECT' | 'OBJECT_LIST';
 export type Tag = {
     name: string;
     type: Tag_Type;
     system: boolean;
     userSpecific: boolean;
     hasRightAceModify: boolean;
+    /** Fields of an OBJECT or OBJECT_LIST tag, ordered by name. */
+    fields: TagField[];
+};
+export type TagField = {
+    /** Field name relative to its object: "amount" for the tag "order.amount". */
+    name: string;
+    /** INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE or VERSION. */
+    type: Tag_Type;
 };
 export type CreateTagRequest = {
     /** Tag name to create (letters, digits, spaces and dashes; max 64 chars). */
     name?: string;
     /** Value type of the tag; TIMEZONE is not allowed here. */
     type?: Tag_Type;
-    /** If true the tag is stored per user id rather than per device. */
+    /** If true the tag is stored per user id rather than per device. OBJECT and OBJECT_LIST tags are always user-specific. */
     userSpecific?: boolean;
+    /** Fields of an OBJECT or OBJECT_LIST tag, 1 to 20; ignored for other types. */
+    fields?: TagField[];
 };
 export type CreateTagResponse = {
     tag: Tag;
@@ -133,6 +149,23 @@ export type GetTagValuesResponse = {
     page: number;
     perPage: number;
 };
+export type AddTagFieldRequest = {
+    /** Name of the OBJECT or OBJECT_LIST tag. */
+    name?: string;
+    field?: TagField;
+};
+export type AddTagFieldResponse = {
+    tag: Tag;
+};
+export type DeleteTagFieldRequest = {
+    /** Name of the OBJECT or OBJECT_LIST tag. */
+    name?: string;
+    /** Field name relative to the object. */
+    field?: string;
+};
+export type DeleteTagFieldResponse = {
+    tag: Tag;
+};
 export type GetTagUsageRequest = {
     /** Tag name whose references (segments, in-apps, journeys) to return. */
     name?: string;