@pushwoosh/rpc-v2-http-api-data 0.2.200 → 0.2.201

package/app_inbox_presets.d.ts

@@ -0,0 +1,81 @@
+import { RpcMethod } from './commonTypes';
+export type appInboxPresetsService_List = RpcMethod<ListAppInboxPresetsRequest, ListAppInboxPresetsResponse>;
+export type appInboxPresetsService_Get = RpcMethod<GetAppInboxPresetRequest, GetAppInboxPresetResponse>;
+export type appInboxPresetsService_Create = RpcMethod<CreateAppInboxPresetRequest, CreateAppInboxPresetResponse>;
+export type appInboxPresetsService_Update = RpcMethod<UpdateAppInboxPresetRequest, UpdateAppInboxPresetResponse>;
+export type appInboxPresetsService_Delete = RpcMethod<DeleteAppInboxPresetRequest, DeleteAppInboxPresetResponse>;
+export interface appInboxPresetsService {
+    List: appInboxPresetsService_List;
+    Get: appInboxPresetsService_Get;
+    Create: appInboxPresetsService_Create;
+    Update: appInboxPresetsService_Update;
+    Delete: appInboxPresetsService_Delete;
+}
+export type ListAppInboxPresetsRequest_OrderBy = 'NAME' | 'CREATED' | 'UPDATED';
+export type ListAppInboxPresetsRequest_OrderDirection = 'ASC' | 'DESC';
+export type ListAppInboxPresetsRequest = {
+    application?: string;
+    orderBy?: ListAppInboxPresetsRequest_OrderBy;
+    orderDirection?: ListAppInboxPresetsRequest_OrderDirection;
+    page?: number;
+    perPage?: number;
+    searchByName?: string;
+    searchByCategory?: string[];
+};
+export type AppInboxPresetOpenAction = {
+    type: string;
+    url: string;
+    deepLinkCode: string;
+    deepLinkParams: Record<string, string>;
+    richMediaCode: string;
+};
+export type AppInboxPresetLocale = {
+    title: string;
+    body: string;
+    iconUrl: string;
+    bannerUrl: string;
+    openAction: AppInboxPresetOpenAction;
+    customData: object;
+};
+export type AppInboxPreset = {
+    name: string;
+    code: string;
+    categories: string[];
+    localizedContent: Record<string, AppInboxPresetLocale>;
+    created: Date;
+    updated: Date;
+};
+export type ListAppInboxPresetsResponse = {
+    presets: AppInboxPreset[];
+    page: number;
+    perPage: number;
+    total: number;
+};
+export type GetAppInboxPresetRequest = {
+    code?: string;
+};
+export type GetAppInboxPresetResponse = {
+    preset: AppInboxPreset;
+};
+export type CreateAppInboxPresetRequest = {
+    application?: string;
+    name?: string;
+    categories?: string[];
+    localizedContent?: Record<string, AppInboxPresetLocale>;
+};
+export type CreateAppInboxPresetResponse = {
+    preset: AppInboxPreset;
+};
+export type UpdateAppInboxPresetRequest = {
+    code?: string;
+    name?: string;
+    categories?: string[];
+    localizedContent?: Record<string, AppInboxPresetLocale>;
+};
+export type UpdateAppInboxPresetResponse = {
+    preset: AppInboxPreset;
+};
+export type DeleteAppInboxPresetRequest = {
+    code?: string;
+};
+export type DeleteAppInboxPresetResponse = {};

package/app_inbox_presets.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/applications_info.d.ts

@@ -19,7 +19,12 @@ export type ApplicationPlatformsInfo_PlatformInfo = {
     certificateTimeLeft: Duration;
     properties: Record<string, string>;
 };
+export type ApplicationPlatformsInfo_AppInboxInfo = {
+    available: boolean;
+    integrated: boolean;
+};
 export type ApplicationPlatformsInfo = {
     application: string;
     platforms: Record<number, ApplicationPlatformsInfo_PlatformInfo>;
+    appInbox: ApplicationPlatformsInfo_AppInboxInfo;
 };

package/data.js

@@ -4888,6 +4888,253 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.app_inbox_presets.appInboxPresetsService": {
+        "type": "S",
+        "key": "appInboxPresets",
+        "methods": {
+            "List": {
+                "request": "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest",
+                "response": "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsResponse",
+                "method": "get",
+                "path": "/api/app_inbox_presets"
+            },
+            "Get": {
+                "request": "pushwoosh.rpc_v2.app_inbox_presets.GetAppInboxPresetRequest",
+                "response": "pushwoosh.rpc_v2.app_inbox_presets.GetAppInboxPresetResponse",
+                "method": "get",
+                "path": "/api/app_inbox_presets/{code}"
+            },
+            "Create": {
+                "request": "pushwoosh.rpc_v2.app_inbox_presets.CreateAppInboxPresetRequest",
+                "response": "pushwoosh.rpc_v2.app_inbox_presets.CreateAppInboxPresetResponse",
+                "method": "post",
+                "path": "/api/app_inbox_presets"
+            },
+            "Update": {
+                "request": "pushwoosh.rpc_v2.app_inbox_presets.UpdateAppInboxPresetRequest",
+                "response": "pushwoosh.rpc_v2.app_inbox_presets.UpdateAppInboxPresetResponse",
+                "method": "put",
+                "path": "/api/app_inbox_presets/{code}"
+            },
+            "Delete": {
+                "request": "pushwoosh.rpc_v2.app_inbox_presets.DeleteAppInboxPresetRequest",
+                "response": "pushwoosh.rpc_v2.app_inbox_presets.DeleteAppInboxPresetResponse",
+                "method": "delete",
+                "path": "/api/app_inbox_presets/{code}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest.OrderBy": {
+        "type": "E",
+        "values": [
+            "NAME",
+            "CREATED",
+            "UPDATED"
+        ]
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest.OrderDirection": {
+        "type": "E",
+        "values": [
+            "ASC",
+            "DESC"
+        ]
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "orderBy": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest.OrderBy"
+            },
+            "orderDirection": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsRequest.OrderDirection"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "searchByName": {
+                "type": "string"
+            },
+            "searchByCategory": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetOpenAction": {
+        "type": "I",
+        "fields": {
+            "type": {
+                "type": "string"
+            },
+            "url": {
+                "type": "string"
+            },
+            "deepLinkCode": {
+                "type": "string"
+            },
+            "deepLinkParams": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "richMediaCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetLocale": {
+        "type": "I",
+        "fields": {
+            "title": {
+                "type": "string"
+            },
+            "body": {
+                "type": "string"
+            },
+            "iconUrl": {
+                "type": "string"
+            },
+            "bannerUrl": {
+                "type": "string"
+            },
+            "openAction": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetOpenAction"
+            },
+            "customData": {
+                "type": "object"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPreset": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "categories": {
+                "type": "string",
+                "array": true
+            },
+            "localizedContent": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetLocale",
+                "mapKeyType": "string"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.ListAppInboxPresetsResponse": {
+        "type": "I",
+        "fields": {
+            "presets": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPreset",
+                "array": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.GetAppInboxPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.GetAppInboxPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.CreateAppInboxPresetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "categories": {
+                "type": "string",
+                "array": true
+            },
+            "localizedContent": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetLocale",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.CreateAppInboxPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.UpdateAppInboxPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "categories": {
+                "type": "string",
+                "array": true
+            },
+            "localizedContent": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPresetLocale",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.UpdateAppInboxPresetResponse": {
+        "type": "I",
+        "fields": {
+            "preset": {
+                "type": "pushwoosh.rpc_v2.app_inbox_presets.AppInboxPreset"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.DeleteAppInboxPresetRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.app_inbox_presets.DeleteAppInboxPresetResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc_v2.applications.ApplicationsService": {
         "type": "S",
         "key": "applications",
@@ -6952,6 +7199,17 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_info.ApplicationPlatformsInfo.AppInboxInfo": {
+        "type": "I",
+        "fields": {
+            "available": {
+                "type": "boolean"
+            },
+            "integrated": {
+                "type": "boolean"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications_info.ApplicationPlatformsInfo": {
         "type": "I",
         "fields": {
@@ -6961,6 +7219,9 @@ export const data = {
             "platforms": {
                 "type": "pushwoosh.rpc_v2.applications_info.ApplicationPlatformsInfo.PlatformInfo",
                 "mapKeyType": "number"
+            },
+            "appInbox": {
+                "type": "pushwoosh.rpc_v2.applications_info.ApplicationPlatformsInfo.AppInboxInfo"
             }
         }
     },
@@ -14574,6 +14835,9 @@ export const data = {
             },
             "whatsApp": {
                 "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
+            },
+            "appInbox": {
+                "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
             }
         }
     },
@@ -14613,6 +14877,9 @@ export const data = {
             },
             "whatsApp": {
                 "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
+            },
+            "appInbox": {
+                "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
             }
         }
     },
@@ -14644,6 +14911,9 @@ export const data = {
             },
             "whatsApp": {
                 "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
+            },
+            "appInbox": {
+                "type": "pushwoosh.rpc_v2.frequency_capping.Capping"
             }
         }
     },

package/frequency_capping.d.ts

@@ -3,7 +3,7 @@ export type FrequencyCappingService_Get = RpcMethod<GetFrequencyCappingRequest,
 export type FrequencyCappingService_Update = RpcMethod<UpdateFrequencyCappingRequest, UpdateFrequencyCappingResponse>;
 export type FrequencyCappingService_Create = RpcMethod<CreateFrequencyCappingRequest, CreateFrequencyCappingResponse>;
 export interface FrequencyCappingService {
-    /** Returns the frequency-capping limits configured for an application code XXXXX-XXXXX, per channel (push, email, SMS, in-app, WhatsApp). Use to read current caps before updating them; errors if no capping has been created for the application. */
+    /** Returns the frequency-capping limits configured for an application code XXXXX-XXXXX, per channel (push, email, SMS, in-app, WhatsApp, App Inbox). Use to read current caps before updating them; errors if no capping has been created for the application. */
     Get: FrequencyCappingService_Get;
     /** Overwrites the per-channel frequency-capping limits of an existing application capping. Use to change caps already created; only the channels present in the request are updated, and it errors if no capping exists yet (use create_frequency_capping first). */
     Update: FrequencyCappingService_Update;
@@ -26,6 +26,7 @@ export type FrequencyCapping = {
     sms: Capping;
     inApp: Capping;
     whatsApp: Capping;
+    appInbox: Capping;
 };
 export type GetFrequencyCappingRequest = {
     /** Application code XXXXX-XXXXX whose capping is read. */
@@ -47,6 +48,8 @@ export type CreateFrequencyCappingRequest = {
     inApp?: Capping;
     /** WhatsApp channel cap; omit to leave the channel uncapped. */
     whatsApp?: Capping;
+    /** App Inbox channel cap; omit to leave the channel uncapped. */
+    appInbox?: Capping;
 };
 export type CreateFrequencyCappingResponse = {
     frequencyCapping: FrequencyCapping;
@@ -64,5 +67,7 @@ export type UpdateFrequencyCappingRequest = {
     inApp?: Capping;
     /** WhatsApp channel cap; omit to leave that channel unchanged. */
     whatsApp?: Capping;
+    /** App Inbox channel cap; omit to leave that channel unchanged. */
+    appInbox?: Capping;
 };
 export type UpdateFrequencyCappingResponse = {};

package/index.d.ts

@@ -6,6 +6,7 @@ import { AccountsService as pushwoosh_rpc_v2_accounts_AccountsService } from './
 import { AlertsService as pushwoosh_accounts_alerts_v1_AlertsService } from './pushwoosh_accounts_alerts_v1';
 import { GetAuthInfoService as pushwoosh_rpc_v2_accounts_get_auth_info_GetAuthInfoService } from './accounts_get_auth_info';
 import { ApiTokensService as pushwoosh_rpc_v2_api_tokens_ApiTokensService } from './api_tokens';
+import { appInboxPresetsService as pushwoosh_rpc_v2_app_inbox_presets_appInboxPresetsService } from './app_inbox_presets';
 import { ApplicationsService as pushwoosh_rpc_v2_applications_ApplicationsService } from './applications';
 import { ApplicationEmailFromsService as pushwoosh_rpc_v2_applications_email_froms_ApplicationEmailFromsService } from './applications_email_froms';
 import { ApplicationSoundsService as pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService } from './applications_sounds';
@@ -75,6 +76,7 @@ export type API = {
     alerts: pushwoosh_accounts_alerts_v1_AlertsService;
     getAuthInfo: pushwoosh_rpc_v2_accounts_get_auth_info_GetAuthInfoService;
     apiTokens: pushwoosh_rpc_v2_api_tokens_ApiTokensService;
+    appInboxPresets: pushwoosh_rpc_v2_app_inbox_presets_appInboxPresetsService;
     applications: pushwoosh_rpc_v2_applications_ApplicationsService;
     applicationEmailFroms: pushwoosh_rpc_v2_applications_email_froms_ApplicationEmailFromsService;
     applicationSounds: pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService;

package/package.json

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