@ariary/notification 4.0.0 → 4.2.0

package/README.md

@@ -12,7 +12,7 @@ yarn add @ariary/notification
 
 1. Sign in at [ariari.mg](https://ariari.mg)
 2. Create a project
-3. You'll receive a `projectId` and a `secret`
+3. You'll receive a `secret`
 
 ## Setup
 
@@ -20,7 +20,6 @@ yarn add @ariary/notification
 import Ariari from '@ariary/notification'
 
 Ariari.config({
-  projectId: 'your-project-id',
   secret: 'your-secret',
 })
 ```
@@ -198,13 +197,11 @@ Use `name` to manage separate Ariari instances with different credentials. `Aria
 ```ts
 const marketing = Ariari.config({
   name: 'marketing',
-  projectId: 'project-a',
   secret: 'secret-a',
 })
 
 const alerts = Ariari.config({
   name: 'alerts',
-  projectId: 'project-b',
   secret: 'secret-b',
 })
 

package/dist/index.d.mts

@@ -1,3 +1,120 @@
+interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+/**
+ * This is the base class for all generated API classes.
+ */
+declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+type Json = any;
+type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+type HTTPHeaders = {
+    [key: string]: string;
+};
+type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+type HTTPBody = Json | FormData | URLSearchParams;
+type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+
 /**
  * API Payment Service - NestJS
  * Système de gestion des paiements - NestJS
@@ -144,7 +261,7 @@ type SmsStatus$1 = typeof SmsStatus$1[keyof typeof SmsStatus$1];
  * @export
  * @interface SmsDetail
  */
-interface SmsDetail$1 {
+interface SmsDetail {
     /**
      * ID unique du SMS
      * @type {string}
@@ -177,6 +294,99 @@ interface SmsDetail$1 {
     retryCount: number;
 }
 
+/**
+ * API Payment Service - NestJS
+ * Système de gestion des paiements - NestJS
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface NotifTaskWithSms
+ */
+interface NotifTaskWithSms {
+    /**
+     * ID de la tâche
+     * @type {string}
+     * @memberof NotifTaskWithSms
+     */
+    taskId: string;
+    /**
+     * Statut par SMS
+     * @type {NotifTaskStatus}
+     * @memberof NotifTaskWithSms
+     */
+    status: NotifTaskStatus;
+    /**
+     * Statut par pages SMS
+     * @type {NotifTaskStatus}
+     * @memberof NotifTaskWithSms
+     */
+    statusPage: NotifTaskStatus;
+    /**
+     * Date de création
+     * @type {Date}
+     * @memberof NotifTaskWithSms
+     */
+    createdAt: Date;
+    /**
+     * Date planifiée
+     * @type {Date}
+     * @memberof NotifTaskWithSms
+     */
+    scheduledAt?: Date;
+    /**
+     * Liste des SMS
+     * @type {Array<SmsDetail>}
+     * @memberof NotifTaskWithSms
+     */
+    sms: Array<SmsDetail>;
+}
+
+/**
+ * API Payment Service - NestJS
+ * Système de gestion des paiements - NestJS
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PaginationParams
+ */
+interface PaginationParams {
+    /**
+     * Offset de départ
+     * @type {number}
+     * @memberof PaginationParams
+     */
+    from?: number;
+    /**
+     * Nombre d'éléments à retourner
+     * @type {number}
+     * @memberof PaginationParams
+     */
+    count?: number;
+    /**
+     * Ordre de tri (-1 pour DESC, 1 pour ASC)
+     * @type {number}
+     * @memberof PaginationParams
+     */
+    order?: number;
+}
+
 /**
  * API Payment Service - NestJS
  * Système de gestion des paiements - NestJS
@@ -227,24 +437,114 @@ interface ResponseNotifTask {
     createdAt: Date;
 }
 
-type Data = {
-    body?: Record<string, unknown> | object;
-    params?: Record<string, string>;
-    public?: boolean;
-};
-type PData = Omit<Data, 'body'>;
-type Config = {
+/**
+ * API Payment Service - NestJS
+ * Système de gestion des paiements - NestJS
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface PaginatedNotifTaskResponse
+ */
+interface PaginatedNotifTaskResponse {
+    /**
+     * Liste des tâches
+     * @type {Array<ResponseNotifTask>}
+     * @memberof PaginatedNotifTaskResponse
+     */
+    tasks: Array<ResponseNotifTask>;
+    /**
+     * Paramètres pour la page suivante
+     * @type {PaginationParams}
+     * @memberof PaginatedNotifTaskResponse
+     */
+    next: PaginationParams;
+    /**
+     * Paramètres pour la page précédente
+     * @type {PaginationParams}
+     * @memberof PaginatedNotifTaskResponse
+     */
+    prev?: PaginationParams;
+}
+
+/**
+ * API Payment Service - NestJS
+ * Système de gestion des paiements - NestJS
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface NotifTaskFindAllRequest {
+    xSecret: string;
+    from: string;
+    count: string;
+    order: string;
     projectId: string;
-    secret: string;
-    baseUrl?: string;
-};
-declare const createRequester: (config: Config) => {
-    get: <T>(url: string, data?: PData) => Promise<T>;
-    post: <T>(url: string, data?: Data) => Promise<T>;
-    patch: <T>(url: string, data?: Data) => Promise<T>;
-    put: <T>(url: string, data?: Data) => Promise<T>;
-    delete: <T = void>(url: string, data?: PData) => Promise<T>;
-};
+}
+interface NotifTaskFindAllWithSmsRequest {
+    xSecret: string;
+    projectId: string;
+    days: string;
+}
+interface NotifTaskFindOneRequest {
+    xSecret: string;
+    id: string;
+    details: string;
+}
+/**
+ *
+ */
+declare class NotifTaskApi extends BaseAPI {
+    /**
+     * Creates request options for notifTaskFindAll without sending the request
+     */
+    notifTaskFindAllRequestOpts(requestParameters: NotifTaskFindAllRequest): Promise<RequestOpts>;
+    /**
+     * Récupérer les tâches avec pagination
+     */
+    notifTaskFindAllRaw(requestParameters: NotifTaskFindAllRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<PaginatedNotifTaskResponse>>;
+    /**
+     * Récupérer les tâches avec pagination
+     */
+    notifTaskFindAll(requestParameters: NotifTaskFindAllRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<PaginatedNotifTaskResponse>;
+    /**
+     * Creates request options for notifTaskFindAllWithSms without sending the request
+     */
+    notifTaskFindAllWithSmsRequestOpts(requestParameters: NotifTaskFindAllWithSmsRequest): Promise<RequestOpts>;
+    /**
+     * Récupérer toutes les tâches avec SMS détaillés sur N jours pour un projet
+     */
+    notifTaskFindAllWithSmsRaw(requestParameters: NotifTaskFindAllWithSmsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Array<NotifTaskWithSms>>>;
+    /**
+     * Récupérer toutes les tâches avec SMS détaillés sur N jours pour un projet
+     */
+    notifTaskFindAllWithSms(requestParameters: NotifTaskFindAllWithSmsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Array<NotifTaskWithSms>>;
+    /**
+     * Creates request options for notifTaskFindOne without sending the request
+     */
+    notifTaskFindOneRequestOpts(requestParameters: NotifTaskFindOneRequest): Promise<RequestOpts>;
+    /**
+     * Récupérer une tâche par ID, avec SMS optionnels via ?details=limit,page
+     */
+    notifTaskFindOneRaw(requestParameters: NotifTaskFindOneRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<NotifTaskWithSms>>;
+    /**
+     * Récupérer une tâche par ID, avec SMS optionnels via ?details=limit,page
+     */
+    notifTaskFindOne(requestParameters: NotifTaskFindOneRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<NotifTaskWithSms>;
+}
 
 type Message = {
     phone: string[] | string;
@@ -257,29 +557,25 @@ declare enum SmsStatus {
     DELIVERED = "DELIVERED",
     FAILED = "FAILED"
 }
-type SmsDetail = SmsDetail$1;
 type EstimateMessage = EstimateMessage$1;
-type EstimateResponse = EstimateSmsResponse;
-type TaskData = ResponseNotifTask & {
-    scheduledAt?: Date;
-};
-type TaskResponse = {
-    task: TaskData;
-    sms: SmsDetail[];
-    total: number;
-};
 
+type Config = {
+    secret: string;
+    baseUrl?: string;
+};
 declare class Task {
     id: string;
-    private _requester;
-    constructor(id: string, requester: ReturnType<typeof createRequester>);
-    status(): Promise<TaskResponse>;
-    status(count: number, page?: number): Promise<TaskResponse>;
-    fullStatus(): Promise<TaskResponse>;
+    private _api;
+    private _secret;
+    constructor(id: string, api: NotifTaskApi, secret: string);
+    status(): Promise<NotifTaskWithSms>;
+    status(count: number, page?: number): Promise<NotifTaskWithSms>;
+    fullStatus(): Promise<NotifTaskWithSms>;
 }
 declare class Ariari {
-    private _config;
-    private _requester;
+    private _secret;
+    private _smsApi;
+    private _notifTaskApi;
     private constructor();
     static config: (nameAndConfig: Config & {
         name?: string;
@@ -290,10 +586,10 @@ declare class Ariari {
     static get: (name?: string) => Ariari;
     send: (...args: [string, ...Message[]] | Message[]) => Promise<Task>;
     getTask: (taskId: string) => Task;
-    estimate: (...messages: EstimateMessage[]) => Promise<EstimateResponse>;
+    estimate: (...messages: EstimateMessage[]) => Promise<EstimateSmsResponse>;
     static send: (...args: [string, ...Message[]] | Message[]) => Promise<Task>;
     static getTask: (taskId: string) => Task;
     static estimate: (...messages: EstimateMessage[]) => Promise<EstimateSmsResponse>;
 }
 
-export { SmsStatus, Ariari as default };
+export { type Config, SmsStatus, Ariari as default };