1 | import { _SPCollection, _SPInstance } from "../spqueryable.js";
|
2 | export declare class _Subscriptions extends _SPCollection {
|
3 | /**
|
4 | * Returns all the webhook subscriptions or the specified webhook subscription
|
5 | *
|
6 | * @param subscriptionId The id of a specific webhook subscription to retrieve, omit to retrieve all the webhook subscriptions
|
7 | */
|
8 | getById(subscriptionId: string): ISubscription;
|
9 | /**
|
10 | * Creates a new webhook subscription
|
11 | *
|
12 | * @param notificationUrl The url to receive the notifications
|
13 | * @param expirationDate The date and time to expire the subscription in the form YYYY-MM-ddTHH:mm:ss+00:00 (maximum of 6 months)
|
14 | * @param clientState A client specific string (optional)
|
15 | */
|
16 | add(notificationUrl: string, expirationDate: string, clientState?: string): Promise<ISubscriptionAddResult>;
|
17 | }
|
18 | export interface ISubscriptions extends _Subscriptions {
|
19 | }
|
20 | export declare const Subscriptions: import("../spqueryable.js").ISPInvokableFactory<ISubscriptions>;
|
21 | export declare class _Subscription extends _SPInstance {
|
22 | /**
|
23 | * Renews this webhook subscription
|
24 | *
|
25 | * @param expirationDate The date and time to expire the subscription in the form YYYY-MM-ddTHH:mm:ss+00:00 (maximum of 6 months, optional)
|
26 | * @param notificationUrl The url to receive the notifications (optional)
|
27 | * @param clientState A client specific string (optional)
|
28 | */
|
29 | update(expirationDate?: string, notificationUrl?: string, clientState?: string): Promise<ISubscriptionUpdateResult>;
|
30 | /**
|
31 | * Removes this webhook subscription
|
32 | *
|
33 | */
|
34 | delete(): Promise<void>;
|
35 | }
|
36 | export interface ISubscription extends _Subscription {
|
37 | }
|
38 | export declare const Subscription: import("../spqueryable.js").ISPInvokableFactory<ISubscription>;
|
39 | /**
|
40 | * Result from adding a new subscription
|
41 | *
|
42 | */
|
43 | export interface ISubscriptionAddResult {
|
44 | subscription: ISubscription;
|
45 | data: any;
|
46 | }
|
47 | /**
|
48 | * Result from updating a subscription
|
49 | *
|
50 | */
|
51 | export interface ISubscriptionUpdateResult {
|
52 | subscription: ISubscription;
|
53 | data: any;
|
54 | }
|
55 | //# sourceMappingURL=types.d.ts.map |
\ | No newline at end of file |