@wix/notifications 1.0.28 → 1.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/context/package.json +2 -1
- package/meta/package.json +2 -1
- package/package.json +12 -6
- package/type-bundles/context.bundle.d.ts +157 -0
- package/type-bundles/index.bundle.d.ts +157 -0
- package/type-bundles/meta.bundle.d.ts +167 -0
package/context/package.json
CHANGED
package/meta/package.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/notifications",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.29",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -9,21 +9,27 @@
|
|
|
9
9
|
"module": "build/es/index.js",
|
|
10
10
|
"main": "build/cjs/index.js",
|
|
11
11
|
"typings": "./build/cjs/index.d.ts",
|
|
12
|
+
"typesBundle": "./type-bundles/index.bundle.d.ts",
|
|
12
13
|
"files": [
|
|
13
14
|
"build",
|
|
14
15
|
"frontend/package.json",
|
|
15
16
|
"meta",
|
|
16
|
-
"context"
|
|
17
|
+
"context",
|
|
18
|
+
"type-bundles"
|
|
17
19
|
],
|
|
18
20
|
"dependencies": {
|
|
19
|
-
"@wix/notifications_notifications": "1.0.
|
|
21
|
+
"@wix/notifications_notifications": "1.0.16"
|
|
20
22
|
},
|
|
21
23
|
"devDependencies": {
|
|
22
|
-
"
|
|
24
|
+
"glob": "^10.4.1",
|
|
25
|
+
"rollup": "^4.18.0",
|
|
26
|
+
"rollup-plugin-dts": "^6.1.1",
|
|
23
27
|
"typescript": "^5.3.2"
|
|
24
28
|
},
|
|
25
29
|
"scripts": {
|
|
26
|
-
"build": "tsc -b tsconfig.json tsconfig.esm.json",
|
|
30
|
+
"build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
|
|
31
|
+
"build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
|
|
32
|
+
"build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
|
|
27
33
|
"test": ":"
|
|
28
34
|
},
|
|
29
35
|
"wix": {
|
|
@@ -37,5 +43,5 @@
|
|
|
37
43
|
"fqdn": ""
|
|
38
44
|
}
|
|
39
45
|
},
|
|
40
|
-
"falconPackageHash": "
|
|
46
|
+
"falconPackageHash": "74f15a82abb9e534193d8ff1923b8536b66242d7448b50132c5f1fdd"
|
|
41
47
|
}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
|
|
28
|
+
declare global {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
30
|
+
interface SymbolConstructor {
|
|
31
|
+
readonly observable: symbol;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface Public_notification {
|
|
36
|
+
/** id */
|
|
37
|
+
_id?: string | null;
|
|
38
|
+
}
|
|
39
|
+
interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
40
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
41
|
+
toSiteContributors?: ToSiteContributors;
|
|
42
|
+
/** Send to contacts. */
|
|
43
|
+
toContacts?: ToContacts;
|
|
44
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
45
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
46
|
+
/** an open url as an action target */
|
|
47
|
+
targetUrl?: string | null;
|
|
48
|
+
/** target_dashboard_page */
|
|
49
|
+
targetDashboardPage?: DashboardPages;
|
|
50
|
+
/** Notification title. */
|
|
51
|
+
title?: string | null;
|
|
52
|
+
/** Notification body. */
|
|
53
|
+
body?: string | null;
|
|
54
|
+
/** The Action of the notification */
|
|
55
|
+
action?: string | null;
|
|
56
|
+
/** The channel to which send the notification */
|
|
57
|
+
channels?: Channel[];
|
|
58
|
+
}
|
|
59
|
+
/** @oneof */
|
|
60
|
+
interface PublicNotifyRequestRecipientsFilterOneOf {
|
|
61
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
62
|
+
toSiteContributors?: ToSiteContributors;
|
|
63
|
+
/** Send to contacts. */
|
|
64
|
+
toContacts?: ToContacts;
|
|
65
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
66
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
67
|
+
}
|
|
68
|
+
/** @oneof */
|
|
69
|
+
interface PublicNotifyRequestActionTargetOneOf {
|
|
70
|
+
/** an open url as an action target */
|
|
71
|
+
targetUrl?: string | null;
|
|
72
|
+
/** target_dashboard_page */
|
|
73
|
+
targetDashboardPage?: DashboardPages;
|
|
74
|
+
}
|
|
75
|
+
interface ToSiteContributors {
|
|
76
|
+
/** with_role */
|
|
77
|
+
withRole?: Role;
|
|
78
|
+
}
|
|
79
|
+
declare enum Role {
|
|
80
|
+
/** All contributors with any role */
|
|
81
|
+
All_Contributors = "All_Contributors",
|
|
82
|
+
/** Only the owner */
|
|
83
|
+
Owner = "Owner"
|
|
84
|
+
}
|
|
85
|
+
interface ToContacts {
|
|
86
|
+
/** contact_ids */
|
|
87
|
+
contactIds?: string[];
|
|
88
|
+
}
|
|
89
|
+
interface ToTopicsSubscribers {
|
|
90
|
+
/** topics */
|
|
91
|
+
topics?: string[];
|
|
92
|
+
/** excluded_contact_ids */
|
|
93
|
+
excludedContactIds?: string[];
|
|
94
|
+
}
|
|
95
|
+
declare enum Channel {
|
|
96
|
+
/** No Default Channel - need to expilicitly decide on channel */
|
|
97
|
+
Undefined = "Undefined",
|
|
98
|
+
/** The widget inside Wix */
|
|
99
|
+
Dashboard = "Dashboard",
|
|
100
|
+
/** Mobile push to WixApp */
|
|
101
|
+
Mobile = "Mobile",
|
|
102
|
+
/** Browser push to the active browser (Chrome/Safari only) */
|
|
103
|
+
Browser = "Browser"
|
|
104
|
+
}
|
|
105
|
+
declare enum DashboardPages {
|
|
106
|
+
Undefined_Page = "Undefined_Page",
|
|
107
|
+
/** goes to business manager home */
|
|
108
|
+
Home = "Home"
|
|
109
|
+
}
|
|
110
|
+
interface Empty {
|
|
111
|
+
}
|
|
112
|
+
interface NotifyOptions extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
113
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
114
|
+
toSiteContributors?: ToSiteContributors;
|
|
115
|
+
/** Send to contacts. */
|
|
116
|
+
toContacts?: ToContacts;
|
|
117
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
118
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
119
|
+
/** Notification title. */
|
|
120
|
+
title?: string | null;
|
|
121
|
+
/** The Action of the notification */
|
|
122
|
+
action?: string | null;
|
|
123
|
+
/** an open url as an action target */
|
|
124
|
+
targetUrl?: string | null;
|
|
125
|
+
/** target_dashboard_page */
|
|
126
|
+
targetDashboardPage?: DashboardPages;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
declare function notify$1(httpClient: HttpClient): (body: string | null, channels: Channel[], options?: NotifyOptions) => Promise<void>;
|
|
130
|
+
|
|
131
|
+
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
132
|
+
|
|
133
|
+
type _publicNotifyType = typeof notify$1;
|
|
134
|
+
declare const notify: ReturnType<typeof createRESTModule<_publicNotifyType>>;
|
|
135
|
+
|
|
136
|
+
type context_Channel = Channel;
|
|
137
|
+
declare const context_Channel: typeof Channel;
|
|
138
|
+
type context_DashboardPages = DashboardPages;
|
|
139
|
+
declare const context_DashboardPages: typeof DashboardPages;
|
|
140
|
+
type context_Empty = Empty;
|
|
141
|
+
type context_NotifyOptions = NotifyOptions;
|
|
142
|
+
type context_PublicNotifyRequest = PublicNotifyRequest;
|
|
143
|
+
type context_PublicNotifyRequestActionTargetOneOf = PublicNotifyRequestActionTargetOneOf;
|
|
144
|
+
type context_PublicNotifyRequestRecipientsFilterOneOf = PublicNotifyRequestRecipientsFilterOneOf;
|
|
145
|
+
type context_Public_notification = Public_notification;
|
|
146
|
+
type context_Role = Role;
|
|
147
|
+
declare const context_Role: typeof Role;
|
|
148
|
+
type context_ToContacts = ToContacts;
|
|
149
|
+
type context_ToSiteContributors = ToSiteContributors;
|
|
150
|
+
type context_ToTopicsSubscribers = ToTopicsSubscribers;
|
|
151
|
+
type context__publicNotifyType = _publicNotifyType;
|
|
152
|
+
declare const context_notify: typeof notify;
|
|
153
|
+
declare namespace context {
|
|
154
|
+
export { context_Channel as Channel, context_DashboardPages as DashboardPages, type context_Empty as Empty, type context_NotifyOptions as NotifyOptions, type context_PublicNotifyRequest as PublicNotifyRequest, type context_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type context_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type context_Public_notification as Public_notification, context_Role as Role, type context_ToContacts as ToContacts, type context_ToSiteContributors as ToSiteContributors, type context_ToTopicsSubscribers as ToTopicsSubscribers, type context__publicNotifyType as _publicNotifyType, context_notify as notify };
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export { context as notifications };
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
|
|
28
|
+
declare global {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
30
|
+
interface SymbolConstructor {
|
|
31
|
+
readonly observable: symbol;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
interface Public_notification {
|
|
36
|
+
/** id */
|
|
37
|
+
_id?: string | null;
|
|
38
|
+
}
|
|
39
|
+
interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
40
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
41
|
+
toSiteContributors?: ToSiteContributors;
|
|
42
|
+
/** Send to contacts. */
|
|
43
|
+
toContacts?: ToContacts;
|
|
44
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
45
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
46
|
+
/** an open url as an action target */
|
|
47
|
+
targetUrl?: string | null;
|
|
48
|
+
/** target_dashboard_page */
|
|
49
|
+
targetDashboardPage?: DashboardPages;
|
|
50
|
+
/** Notification title. */
|
|
51
|
+
title?: string | null;
|
|
52
|
+
/** Notification body. */
|
|
53
|
+
body?: string | null;
|
|
54
|
+
/** The Action of the notification */
|
|
55
|
+
action?: string | null;
|
|
56
|
+
/** The channel to which send the notification */
|
|
57
|
+
channels?: Channel[];
|
|
58
|
+
}
|
|
59
|
+
/** @oneof */
|
|
60
|
+
interface PublicNotifyRequestRecipientsFilterOneOf {
|
|
61
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
62
|
+
toSiteContributors?: ToSiteContributors;
|
|
63
|
+
/** Send to contacts. */
|
|
64
|
+
toContacts?: ToContacts;
|
|
65
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
66
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
67
|
+
}
|
|
68
|
+
/** @oneof */
|
|
69
|
+
interface PublicNotifyRequestActionTargetOneOf {
|
|
70
|
+
/** an open url as an action target */
|
|
71
|
+
targetUrl?: string | null;
|
|
72
|
+
/** target_dashboard_page */
|
|
73
|
+
targetDashboardPage?: DashboardPages;
|
|
74
|
+
}
|
|
75
|
+
interface ToSiteContributors {
|
|
76
|
+
/** with_role */
|
|
77
|
+
withRole?: Role;
|
|
78
|
+
}
|
|
79
|
+
declare enum Role {
|
|
80
|
+
/** All contributors with any role */
|
|
81
|
+
All_Contributors = "All_Contributors",
|
|
82
|
+
/** Only the owner */
|
|
83
|
+
Owner = "Owner"
|
|
84
|
+
}
|
|
85
|
+
interface ToContacts {
|
|
86
|
+
/** contact_ids */
|
|
87
|
+
contactIds?: string[];
|
|
88
|
+
}
|
|
89
|
+
interface ToTopicsSubscribers {
|
|
90
|
+
/** topics */
|
|
91
|
+
topics?: string[];
|
|
92
|
+
/** excluded_contact_ids */
|
|
93
|
+
excludedContactIds?: string[];
|
|
94
|
+
}
|
|
95
|
+
declare enum Channel {
|
|
96
|
+
/** No Default Channel - need to expilicitly decide on channel */
|
|
97
|
+
Undefined = "Undefined",
|
|
98
|
+
/** The widget inside Wix */
|
|
99
|
+
Dashboard = "Dashboard",
|
|
100
|
+
/** Mobile push to WixApp */
|
|
101
|
+
Mobile = "Mobile",
|
|
102
|
+
/** Browser push to the active browser (Chrome/Safari only) */
|
|
103
|
+
Browser = "Browser"
|
|
104
|
+
}
|
|
105
|
+
declare enum DashboardPages {
|
|
106
|
+
Undefined_Page = "Undefined_Page",
|
|
107
|
+
/** goes to business manager home */
|
|
108
|
+
Home = "Home"
|
|
109
|
+
}
|
|
110
|
+
interface Empty {
|
|
111
|
+
}
|
|
112
|
+
interface NotifyOptions extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
113
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
114
|
+
toSiteContributors?: ToSiteContributors;
|
|
115
|
+
/** Send to contacts. */
|
|
116
|
+
toContacts?: ToContacts;
|
|
117
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
118
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
119
|
+
/** Notification title. */
|
|
120
|
+
title?: string | null;
|
|
121
|
+
/** The Action of the notification */
|
|
122
|
+
action?: string | null;
|
|
123
|
+
/** an open url as an action target */
|
|
124
|
+
targetUrl?: string | null;
|
|
125
|
+
/** target_dashboard_page */
|
|
126
|
+
targetDashboardPage?: DashboardPages;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
declare function notify$1(httpClient: HttpClient): (body: string | null, channels: Channel[], options?: NotifyOptions) => Promise<void>;
|
|
130
|
+
|
|
131
|
+
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
132
|
+
|
|
133
|
+
type _publicNotifyType = typeof notify$1;
|
|
134
|
+
declare const notify: ReturnType<typeof createRESTModule<_publicNotifyType>>;
|
|
135
|
+
|
|
136
|
+
type index_d_Channel = Channel;
|
|
137
|
+
declare const index_d_Channel: typeof Channel;
|
|
138
|
+
type index_d_DashboardPages = DashboardPages;
|
|
139
|
+
declare const index_d_DashboardPages: typeof DashboardPages;
|
|
140
|
+
type index_d_Empty = Empty;
|
|
141
|
+
type index_d_NotifyOptions = NotifyOptions;
|
|
142
|
+
type index_d_PublicNotifyRequest = PublicNotifyRequest;
|
|
143
|
+
type index_d_PublicNotifyRequestActionTargetOneOf = PublicNotifyRequestActionTargetOneOf;
|
|
144
|
+
type index_d_PublicNotifyRequestRecipientsFilterOneOf = PublicNotifyRequestRecipientsFilterOneOf;
|
|
145
|
+
type index_d_Public_notification = Public_notification;
|
|
146
|
+
type index_d_Role = Role;
|
|
147
|
+
declare const index_d_Role: typeof Role;
|
|
148
|
+
type index_d_ToContacts = ToContacts;
|
|
149
|
+
type index_d_ToSiteContributors = ToSiteContributors;
|
|
150
|
+
type index_d_ToTopicsSubscribers = ToTopicsSubscribers;
|
|
151
|
+
type index_d__publicNotifyType = _publicNotifyType;
|
|
152
|
+
declare const index_d_notify: typeof notify;
|
|
153
|
+
declare namespace index_d {
|
|
154
|
+
export { index_d_Channel as Channel, index_d_DashboardPages as DashboardPages, type index_d_Empty as Empty, type index_d_NotifyOptions as NotifyOptions, type index_d_PublicNotifyRequest as PublicNotifyRequest, type index_d_PublicNotifyRequestActionTargetOneOf as PublicNotifyRequestActionTargetOneOf, type index_d_PublicNotifyRequestRecipientsFilterOneOf as PublicNotifyRequestRecipientsFilterOneOf, type index_d_Public_notification as Public_notification, index_d_Role as Role, type index_d_ToContacts as ToContacts, type index_d_ToSiteContributors as ToSiteContributors, type index_d_ToTopicsSubscribers as ToTopicsSubscribers, type index_d__publicNotifyType as _publicNotifyType, index_d_notify as notify };
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export { index_d as notifications };
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
interface PublicNotifyRequest$1 extends PublicNotifyRequestRecipientsFilterOneOf$1, PublicNotifyRequestActionTargetOneOf$1 {
|
|
2
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
3
|
+
toSiteContributors?: ToSiteContributors$1;
|
|
4
|
+
/** Send to contacts. */
|
|
5
|
+
toContacts?: ToContacts$1;
|
|
6
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
7
|
+
toTopicsSubscribers?: ToTopicsSubscribers$1;
|
|
8
|
+
/** an open url as an action target */
|
|
9
|
+
targetUrl?: string | null;
|
|
10
|
+
/** target_dashboard_page */
|
|
11
|
+
targetDashboardPage?: DashboardPages$1;
|
|
12
|
+
/** Notification title. */
|
|
13
|
+
title?: string | null;
|
|
14
|
+
/** Notification body. */
|
|
15
|
+
body?: string | null;
|
|
16
|
+
/** The Action of the notification */
|
|
17
|
+
action?: string | null;
|
|
18
|
+
/** The channel to which send the notification */
|
|
19
|
+
channels?: Channel$1[];
|
|
20
|
+
}
|
|
21
|
+
/** @oneof */
|
|
22
|
+
interface PublicNotifyRequestRecipientsFilterOneOf$1 {
|
|
23
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
24
|
+
toSiteContributors?: ToSiteContributors$1;
|
|
25
|
+
/** Send to contacts. */
|
|
26
|
+
toContacts?: ToContacts$1;
|
|
27
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
28
|
+
toTopicsSubscribers?: ToTopicsSubscribers$1;
|
|
29
|
+
}
|
|
30
|
+
/** @oneof */
|
|
31
|
+
interface PublicNotifyRequestActionTargetOneOf$1 {
|
|
32
|
+
/** an open url as an action target */
|
|
33
|
+
targetUrl?: string | null;
|
|
34
|
+
/** target_dashboard_page */
|
|
35
|
+
targetDashboardPage?: DashboardPages$1;
|
|
36
|
+
}
|
|
37
|
+
interface ToSiteContributors$1 {
|
|
38
|
+
/** with_role */
|
|
39
|
+
withRole?: Role$1;
|
|
40
|
+
}
|
|
41
|
+
declare enum Role$1 {
|
|
42
|
+
/** All contributors with any role */
|
|
43
|
+
All_Contributors = "All_Contributors",
|
|
44
|
+
/** Only the owner */
|
|
45
|
+
Owner = "Owner"
|
|
46
|
+
}
|
|
47
|
+
interface ToContacts$1 {
|
|
48
|
+
/** contact_ids */
|
|
49
|
+
contactIds?: string[];
|
|
50
|
+
}
|
|
51
|
+
interface ToTopicsSubscribers$1 {
|
|
52
|
+
/** topics */
|
|
53
|
+
topics?: string[];
|
|
54
|
+
/** excluded_contact_ids */
|
|
55
|
+
excludedContactIds?: string[];
|
|
56
|
+
}
|
|
57
|
+
declare enum Channel$1 {
|
|
58
|
+
/** No Default Channel - need to expilicitly decide on channel */
|
|
59
|
+
Undefined = "Undefined",
|
|
60
|
+
/** The widget inside Wix */
|
|
61
|
+
Dashboard = "Dashboard",
|
|
62
|
+
/** Mobile push to WixApp */
|
|
63
|
+
Mobile = "Mobile",
|
|
64
|
+
/** Browser push to the active browser (Chrome/Safari only) */
|
|
65
|
+
Browser = "Browser"
|
|
66
|
+
}
|
|
67
|
+
declare enum DashboardPages$1 {
|
|
68
|
+
Undefined_Page = "Undefined_Page",
|
|
69
|
+
/** goes to business manager home */
|
|
70
|
+
Home = "Home"
|
|
71
|
+
}
|
|
72
|
+
interface Empty$1 {
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
|
|
76
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
77
|
+
toSiteContributors?: ToSiteContributors;
|
|
78
|
+
/** Send to contacts. */
|
|
79
|
+
toContacts?: ToContacts;
|
|
80
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
81
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
82
|
+
/** an open url as an action target */
|
|
83
|
+
targetUrl?: string | null;
|
|
84
|
+
/** target_dashboard_page */
|
|
85
|
+
targetDashboardPage?: DashboardPages;
|
|
86
|
+
/** Notification title. */
|
|
87
|
+
title?: string | null;
|
|
88
|
+
/** Notification body. */
|
|
89
|
+
body?: string | null;
|
|
90
|
+
/** The Action of the notification */
|
|
91
|
+
action?: string | null;
|
|
92
|
+
/** The channel to which send the notification */
|
|
93
|
+
channels?: Channel[];
|
|
94
|
+
}
|
|
95
|
+
/** @oneof */
|
|
96
|
+
interface PublicNotifyRequestRecipientsFilterOneOf {
|
|
97
|
+
/** Send to site contributors. This includes admins, managers, and assistants. */
|
|
98
|
+
toSiteContributors?: ToSiteContributors;
|
|
99
|
+
/** Send to contacts. */
|
|
100
|
+
toContacts?: ToContacts;
|
|
101
|
+
/** Send to site members who subscrined to a particular topic. */
|
|
102
|
+
toTopicsSubscribers?: ToTopicsSubscribers;
|
|
103
|
+
}
|
|
104
|
+
/** @oneof */
|
|
105
|
+
interface PublicNotifyRequestActionTargetOneOf {
|
|
106
|
+
/** an open url as an action target */
|
|
107
|
+
targetUrl?: string | null;
|
|
108
|
+
/** target_dashboard_page */
|
|
109
|
+
targetDashboardPage?: DashboardPages;
|
|
110
|
+
}
|
|
111
|
+
interface ToSiteContributors {
|
|
112
|
+
/** with_role */
|
|
113
|
+
withRole?: Role;
|
|
114
|
+
}
|
|
115
|
+
declare enum Role {
|
|
116
|
+
/** All contributors with any role */
|
|
117
|
+
All_Contributors = "All_Contributors",
|
|
118
|
+
/** Only the owner */
|
|
119
|
+
Owner = "Owner"
|
|
120
|
+
}
|
|
121
|
+
interface ToContacts {
|
|
122
|
+
/** contact_ids */
|
|
123
|
+
contactIds?: string[];
|
|
124
|
+
}
|
|
125
|
+
interface ToTopicsSubscribers {
|
|
126
|
+
/** topics */
|
|
127
|
+
topics?: string[];
|
|
128
|
+
/** excluded_contact_ids */
|
|
129
|
+
excludedContactIds?: string[];
|
|
130
|
+
}
|
|
131
|
+
declare enum Channel {
|
|
132
|
+
/** No Default Channel - need to expilicitly decide on channel */
|
|
133
|
+
Undefined = "Undefined",
|
|
134
|
+
/** The widget inside Wix */
|
|
135
|
+
Dashboard = "Dashboard",
|
|
136
|
+
/** Mobile push to WixApp */
|
|
137
|
+
Mobile = "Mobile",
|
|
138
|
+
/** Browser push to the active browser (Chrome/Safari only) */
|
|
139
|
+
Browser = "Browser"
|
|
140
|
+
}
|
|
141
|
+
declare enum DashboardPages {
|
|
142
|
+
Undefined_Page = "Undefined_Page",
|
|
143
|
+
/** goes to business manager home */
|
|
144
|
+
Home = "Home"
|
|
145
|
+
}
|
|
146
|
+
interface Empty {
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
150
|
+
getUrl: (context: any) => string;
|
|
151
|
+
httpMethod: K;
|
|
152
|
+
path: string;
|
|
153
|
+
pathParams: M;
|
|
154
|
+
__requestType: T;
|
|
155
|
+
__originalRequestType: S;
|
|
156
|
+
__responseType: Q;
|
|
157
|
+
__originalResponseType: R;
|
|
158
|
+
};
|
|
159
|
+
declare function notify(): __PublicMethodMetaInfo<'POST', {}, PublicNotifyRequest, PublicNotifyRequest$1, Empty, Empty$1>;
|
|
160
|
+
|
|
161
|
+
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
162
|
+
declare const meta_notify: typeof notify;
|
|
163
|
+
declare namespace meta {
|
|
164
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_notify as notify };
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
export { meta as notifications };
|