skapi-js 2.0.0 → 2.0.2

package/dist/skapi.d.mts

@@ -280,6 +280,29 @@ type Newsletter = {
     url: string;
     /** Number users delivered */
     delivered: number;
+    /**
+     * Newsletter group the message was sent to.<br>
+     * A number for the 0 ~ 99 groups, the group name for a named newsletter group.
+     */
+    group: number | string;
+};
+type NewsletterGroup = {
+    /** Name of the newsletter group. */
+    group: string;
+    /**
+     * Access group required to subscribe to the group and to read its sent mail.<br>
+     * 0 is anyone, 1 is any signed in user, 2 ~ 99 is that access group.
+     */
+    restriction: number;
+    /** Display label of the group. Empty string when none was set. */
+    name: string;
+    /** Number of subscribers of the group. */
+    subscribers: number;
+    /**
+     * E-Mail address a newsletter for this group is sent to.<br>
+     * Empty string when the service has no sender e-mail set.
+     */
+    endpoint: string;
 };
 type UserAttributes = {
     /** User's name */
@@ -648,6 +671,7 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
+type Types_NewsletterGroup = NewsletterGroup;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -668,7 +692,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -985,6 +1009,28 @@ declare class Skapi {
         accessToken?: string;
         refreshToken?: string;
     }): Promise<UserProfile>;
+    /**
+     * Registers a named newsletter group. Service owner only.
+     * @param params Request parameters.
+     * @returns A promise that resolves to Promise<'SUCCESS: Group registered successfully.'>.
+     */
+    registerNewsletterGroup(params: Form<{
+        /** Name of the newsletter group. 2 ~ 20 lowercase alphanumeric characters, at least one letter, not a reserved name. */
+        group: string;
+        /** Access group required to subscribe. 0 ~ 99. Defaults to 0. */
+        restriction?: number;
+        /** Display label of the group. 60 characters max. */
+        name?: string;
+    }>): Promise<'SUCCESS: Group registered successfully.'>;
+    /**
+     * Deletes a named newsletter group along with every subscription of that group. Service owner only.
+     * @param params Request parameters.
+     * @returns A promise that resolves to Promise<string>, 'SUCCESS: Group has been deleted along with N subscription(s).'.
+     */
+    deleteNewsletterGroup(params: Form<{
+        /** Name of the newsletter group to delete. */
+        group: string;
+    }>): Promise<string>;
     /**
      * Sends a secure outbound request using a Skapi client secret key.
      * @param params Request parameters.
@@ -1309,6 +1355,13 @@ declare class Skapi {
         group: string;
         number_of_users: number;
     }>>;
+    /**
+     * Lists every named newsletter group of the service with its restriction, subscriber count and sending address. Service owner only.
+     * @returns A promise that resolves to Promise<{ groups: NewsletterGroup[] }>.
+     */
+    newsletterGroupEndpoint(): Promise<{
+        groups: NewsletterGroup[];
+    }>;
     /**
      * Sends realtime data to a user or group with optional push notification metadata.
      * @param message Message payload to send.
@@ -1520,11 +1573,13 @@ declare class Skapi {
     }): Promise<string | UserProfile>;
     /**
      * Unsubscribes the user from a newsletter group.
+     * Takes a numeric group, "public", "authorized" or the name of a named newsletter group. null unsubscribes from every group.
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<string>.
      */
     unsubscribeNewsletter(params: {
-        group: number | 'public' | 'authorized' | 'admin';
+        /** Numeric group, "public", "authorized" or a named newsletter group. null unsubscribes from every group. */
+        group: number | 'public' | 'authorized' | (string & {}) | null;
     }): Promise<string>;
     /**
      * Registers a web push subscription endpoint for notifications.
@@ -1565,6 +1620,7 @@ declare class Skapi {
     }, user_ids?: string | string[]): Promise<'SUCCESS: Notification sent.'>;
     /**
      * Fetches newsletter delivery records with filters and pagination.
+     * Reads a numeric group, "public", "authorized" or a named newsletter group. A named group is readable by anyone its restriction allows, signed in or not.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<DatabaseResponse<Newsletter>>.
@@ -1583,26 +1639,29 @@ declare class Skapi {
          * Condition does not work with range.
          */
         condition?: '>' | '>=' | '=' | '<' | '<=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte';
-        group: 'public' | 'authorized' | number;
+        /** Numeric group, "public", "authorized" or a named newsletter group. */
+        group: 'public' | 'authorized' | number | (string & {});
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Newsletter>>;
     /**
      * Gets newsletter subscription status for the requested groups.
+     * Takes a numeric group, "public", "authorized" or a named newsletter group. Omit the group for every group the user is subscribed to.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
-     * @returns A promise that resolves to Promise<{ active: boolean; timestamp: number; group: number; subscribed_email: string; }[]>.
+     * @returns A promise that resolves to Promise<{ active: boolean; timestamp: number; group: number | string; subscribed_email: string; }[]>.
      */
-    getNewsletterSubscription(params: {
-        group?: number | 'public' | 'authorized';
+    getNewsletterSubscription(params?: {
+        /** Numeric group, "public", "authorized" or a named newsletter group. Omit or null for every group. */
+        group?: number | 'public' | 'authorized' | (string & {}) | null;
         user_id?: string;
     }, fetchOptions?: FetchOptions): Promise<{
         active: boolean;
         timestamp: number;
-        group: number;
+        group: number | string;
         subscribed_email: string;
     }[] | DatabaseResponse<{
         active: boolean;
         timestamp: number;
-        group: number;
+        group: number | string;
         subscribed_email: string;
     }>>;
     /**
@@ -1980,12 +2039,14 @@ declare class Skapi {
     }): Promise<'SUCCESS: Unblocked user ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".'>;
     /**
      * Subscribes an email/user to a newsletter group with optional redirect flow.
+     * Takes a numeric group, "public", "authorized" or the name of a named newsletter group registered with registerNewsletterGroup().
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<string>.
      */
     subscribeNewsletter(params: Form<{
         email?: string | string[];
-        group: number | 'public' | 'authorized' | 'admin' | (string & {});
+        /** Numeric group, "public", "authorized" or a named newsletter group. */
+        group: number | 'public' | 'authorized' | (string & {});
         redirect?: string;
     }>): Promise<string>;
     /**
@@ -2006,4 +2067,4 @@ declare class SkapiError extends Error {
     });
 }
 
-export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };
+export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };

package/dist/skapi.d.ts

@@ -280,6 +280,29 @@ type Newsletter = {
     url: string;
     /** Number users delivered */
     delivered: number;
+    /**
+     * Newsletter group the message was sent to.<br>
+     * A number for the 0 ~ 99 groups, the group name for a named newsletter group.
+     */
+    group: number | string;
+};
+type NewsletterGroup = {
+    /** Name of the newsletter group. */
+    group: string;
+    /**
+     * Access group required to subscribe to the group and to read its sent mail.<br>
+     * 0 is anyone, 1 is any signed in user, 2 ~ 99 is that access group.
+     */
+    restriction: number;
+    /** Display label of the group. Empty string when none was set. */
+    name: string;
+    /** Number of subscribers of the group. */
+    subscribers: number;
+    /**
+     * E-Mail address a newsletter for this group is sent to.<br>
+     * Empty string when the service has no sender e-mail set.
+     */
+    endpoint: string;
 };
 type UserAttributes = {
     /** User's name */
@@ -648,6 +671,7 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
+type Types_NewsletterGroup = NewsletterGroup;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -668,7 +692,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -985,6 +1009,28 @@ declare class Skapi {
         accessToken?: string;
         refreshToken?: string;
     }): Promise<UserProfile>;
+    /**
+     * Registers a named newsletter group. Service owner only.
+     * @param params Request parameters.
+     * @returns A promise that resolves to Promise<'SUCCESS: Group registered successfully.'>.
+     */
+    registerNewsletterGroup(params: Form<{
+        /** Name of the newsletter group. 2 ~ 20 lowercase alphanumeric characters, at least one letter, not a reserved name. */
+        group: string;
+        /** Access group required to subscribe. 0 ~ 99. Defaults to 0. */
+        restriction?: number;
+        /** Display label of the group. 60 characters max. */
+        name?: string;
+    }>): Promise<'SUCCESS: Group registered successfully.'>;
+    /**
+     * Deletes a named newsletter group along with every subscription of that group. Service owner only.
+     * @param params Request parameters.
+     * @returns A promise that resolves to Promise<string>, 'SUCCESS: Group has been deleted along with N subscription(s).'.
+     */
+    deleteNewsletterGroup(params: Form<{
+        /** Name of the newsletter group to delete. */
+        group: string;
+    }>): Promise<string>;
     /**
      * Sends a secure outbound request using a Skapi client secret key.
      * @param params Request parameters.
@@ -1309,6 +1355,13 @@ declare class Skapi {
         group: string;
         number_of_users: number;
     }>>;
+    /**
+     * Lists every named newsletter group of the service with its restriction, subscriber count and sending address. Service owner only.
+     * @returns A promise that resolves to Promise<{ groups: NewsletterGroup[] }>.
+     */
+    newsletterGroupEndpoint(): Promise<{
+        groups: NewsletterGroup[];
+    }>;
     /**
      * Sends realtime data to a user or group with optional push notification metadata.
      * @param message Message payload to send.
@@ -1520,11 +1573,13 @@ declare class Skapi {
     }): Promise<string | UserProfile>;
     /**
      * Unsubscribes the user from a newsletter group.
+     * Takes a numeric group, "public", "authorized" or the name of a named newsletter group. null unsubscribes from every group.
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<string>.
      */
     unsubscribeNewsletter(params: {
-        group: number | 'public' | 'authorized' | 'admin';
+        /** Numeric group, "public", "authorized" or a named newsletter group. null unsubscribes from every group. */
+        group: number | 'public' | 'authorized' | (string & {}) | null;
     }): Promise<string>;
     /**
      * Registers a web push subscription endpoint for notifications.
@@ -1565,6 +1620,7 @@ declare class Skapi {
     }, user_ids?: string | string[]): Promise<'SUCCESS: Notification sent.'>;
     /**
      * Fetches newsletter delivery records with filters and pagination.
+     * Reads a numeric group, "public", "authorized" or a named newsletter group. A named group is readable by anyone its restriction allows, signed in or not.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<DatabaseResponse<Newsletter>>.
@@ -1583,26 +1639,29 @@ declare class Skapi {
          * Condition does not work with range.
          */
         condition?: '>' | '>=' | '=' | '<' | '<=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte';
-        group: 'public' | 'authorized' | number;
+        /** Numeric group, "public", "authorized" or a named newsletter group. */
+        group: 'public' | 'authorized' | number | (string & {});
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Newsletter>>;
     /**
      * Gets newsletter subscription status for the requested groups.
+     * Takes a numeric group, "public", "authorized" or a named newsletter group. Omit the group for every group the user is subscribed to.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
-     * @returns A promise that resolves to Promise<{ active: boolean; timestamp: number; group: number; subscribed_email: string; }[]>.
+     * @returns A promise that resolves to Promise<{ active: boolean; timestamp: number; group: number | string; subscribed_email: string; }[]>.
      */
-    getNewsletterSubscription(params: {
-        group?: number | 'public' | 'authorized';
+    getNewsletterSubscription(params?: {
+        /** Numeric group, "public", "authorized" or a named newsletter group. Omit or null for every group. */
+        group?: number | 'public' | 'authorized' | (string & {}) | null;
         user_id?: string;
     }, fetchOptions?: FetchOptions): Promise<{
         active: boolean;
         timestamp: number;
-        group: number;
+        group: number | string;
         subscribed_email: string;
     }[] | DatabaseResponse<{
         active: boolean;
         timestamp: number;
-        group: number;
+        group: number | string;
         subscribed_email: string;
     }>>;
     /**
@@ -1980,12 +2039,14 @@ declare class Skapi {
     }): Promise<'SUCCESS: Unblocked user ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".'>;
     /**
      * Subscribes an email/user to a newsletter group with optional redirect flow.
+     * Takes a numeric group, "public", "authorized" or the name of a named newsletter group registered with registerNewsletterGroup().
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<string>.
      */
     subscribeNewsletter(params: Form<{
         email?: string | string[];
-        group: number | 'public' | 'authorized' | 'admin' | (string & {});
+        /** Numeric group, "public", "authorized" or a named newsletter group. */
+        group: number | 'public' | 'authorized' | (string & {});
         redirect?: string;
     }>): Promise<string>;
     /**
@@ -2006,4 +2067,4 @@ declare class SkapiError extends Error {
     });
 }
 
-export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };
+export { type BinaryFile, type Condition, type Connection, type ConnectionInfo, type DatabaseResponse, type DelRecordQuery, type FetchOptions, type FileInfo, type Form, type GetRecordQuery, type Index, type Newsletter, type NewsletterGroup, type PostRecordConfig, type ProgressCallback, type RTCConnector, type RTCConnectorParams, type RTCEvent, type RTCReceiverParams, type RTCResolved, type RealtimeCallback, type RecordData, Skapi, SkapiError, type Subscription, type Table, type Tag, Types, type UniqueId, type UserAttributes, type UserProfile, type UserPublic, type WebSocketMessage };