@smartbills/sdk 0.0.2-alpha.44 → 0.0.2-alpha.46

package/dist/@types/services/invoices/InvoiceService.d.ts

@@ -0,0 +1,216 @@
+import { SBServiceOptions } from '../../client/SBServiceOptions.js';
+import { IListable } from '../../interfaces/IListable.js';
+import { IUpdatable } from '../../interfaces/IUpdatable.js';
+import { SBList } from '../../entities/base.js';
+import { SBRequestOptions } from '../../client/SBRequestOption.js';
+import { SBService } from '../SBService.js';
+import { AxiosRequestConfig } from 'axios';
+import { SBBatch } from '../../entities/batches/SBBatch.js';
+import { IDeletable } from '../../interfaces/IDeletable.js';
+import { SBBarcode } from '../../entities/barcode/SBBarcode.js';
+import { ICreatable } from '../../interfaces/ICreatable.js';
+import { BankTransactionAssociateRequest } from '../receipts/BankTransactionAssociateRequest.js';
+import { ReceiptPaymentCreateRequest } from '../receipts/payments/ReceiptTransactionCreateRequest.js';
+import { ReceiptReviewCreateRequest } from '../receipts/reviews/ReceiptReviewCreateRequest.js';
+import { ReceiptTransactionUpdateRequest } from '../receipts/payments/ReceiptTransactionUpdateRequest.js';
+import { SBDocument } from '../../entities/documents/SBDocument.js';
+import { InvoiceUpdateRequest } from './InvoiceUpdateRequest.js';
+import { SBInvoice } from '../../entities/invoices/SBInvoice.js';
+import { InvoiceCreateRequest } from './InvoiceCreateRequest.js';
+import { InvoiceBatchUpsertRequest } from './InvoiceBatchUpsertRequest.js';
+import { InvoiceListRequest } from './InvoiceListRequest.js';
+import { IRetrievableById } from '../../interfaces/IRetrievableById.js';
+
+/**
+ * Service for managing invoices in the Smartbills system
+ * Provides functionality for CRUD operations on invoices
+ **/
+declare class InvoiceService extends SBService implements IListable<InvoiceListRequest, SBInvoice>, IRetrievableById<SBInvoice>, IDeletable<SBInvoice>, ICreatable<InvoiceCreateRequest, SBInvoice>, IUpdatable<InvoiceUpdateRequest, SBInvoice> {
+    /**
+     * Creates a new instance of the invoice service
+     * @param options - Service configuration options
+     */
+    constructor(options?: SBServiceOptions);
+    /**
+     * Retrieves an invoice by its ID
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the invoice data
+     */
+    getByIdAsync(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Lists invoices with pagination
+     * @param request - List request parameters
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with paginated invoice data
+     */
+    listAsync(request: InvoiceListRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBList<SBInvoice>>;
+    /**
+     * Creates a new invoice
+     * @param request - Invoice creation request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created invoice
+     */
+    createAsync(request: InvoiceCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Updates an existing invoice
+     * @param id - The invoice ID
+     * @param invoice - Invoice update request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    updateAsync(id: number, invoice: InvoiceUpdateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Deletes an invoice
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the deleted invoice
+     */
+    deleteAsync(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Generates a QR code for a public invoice
+     * @param token - Public invoice token
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the QR code string
+     */
+    generateQRCode(token: string, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<string>;
+    /**
+     * Creates a barcode for an invoice
+     * @param id - The invoice ID
+     * @param request - Barcode creation request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    createBarcode(id: number, request: SBBarcode, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Deletes a barcode from an invoice
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    deleteBarcode(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Uploads a document attachment to an invoice
+     * @param id - The invoice ID
+     * @param file - File to upload
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created document
+     */
+    uploadDocument(id: number, file: File, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBDocument>;
+    /**
+     * Associates a bank transaction with an invoice
+     * @param id - The invoice ID
+     * @param request - Bank transaction association request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    associateBankTransaction(id: number, request: BankTransactionAssociateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Batch creates multiple invoices
+     * @param request - Array of invoice creation requests
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with an array of created invoices
+     */
+    batchCreate(request: InvoiceCreateRequest[], options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice[]>;
+    /**
+     * Batch updates multiple invoices
+     * @param request - Array of invoice update requests
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with an array of updated invoices
+     */
+    batchUpdate(request: InvoiceBatchUpsertRequest[], options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice[]>;
+    /**
+     * Exports an invoice as JSON
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the invoice data as a Blob
+     */
+    exportAsJson(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<Blob>;
+    /**
+     * Shares an invoice
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    share(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Retrieves the public token for an invoice
+     * @param id - The invoice ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the token
+     */
+    retrievePublicToken(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<{
+        token: string;
+    }>;
+    /**
+     * Creates a review for an invoice
+     * @param id - The invoice ID
+     * @param request - Review creation request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    createReview(id: number, request: ReceiptReviewCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Adds a payment transaction to an invoice
+     * @param id - The invoice ID
+     * @param request - Transaction creation request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    addTransaction(id: number, request: ReceiptPaymentCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Updates a payment transaction in an invoice
+     * @param id - The invoice ID
+     * @param transactionId - The transaction ID
+     * @param request - Transaction update request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated invoice
+     */
+    updateTransaction(id: number, transactionId: number, request: ReceiptTransactionUpdateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Uploads an invoice to an existing bulk job
+     * @param id - The bulk job ID
+     * @param request - Invoice batch upsert request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created invoice
+     */
+    uploadToBulkJob(id: number, request: InvoiceBatchUpsertRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Completes a bulk job
+     * @param id - The bulk job ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the completed invoice
+     */
+    completeBulkJob(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBInvoice>;
+    /**
+     * Performs a batch operation on invoices
+     * @param request - Batch upsert request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the batch result
+     */
+    batch(request: InvoiceBatchUpsertRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBBatch<SBInvoice>>;
+}
+
+export { InvoiceService };
+//# sourceMappingURL=InvoiceService.d.ts.map

package/dist/@types/services/invoices/InvoiceService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvoiceService.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/invoices/InvoiceUpdateRequest.d.ts

@@ -0,0 +1,73 @@
+import { ReceiptTaxUpdateRequest } from '../receipts/taxes/ReceiptTaxUpdateRequest.js';
+import { BillingAddressRequest } from '../addresses/BillingAddressRequest.js';
+import { CustomerUpdateRequest } from '../businesses/customers/CustomerUpdateRequest.js';
+import { ReceiptLineItemUpdateRequest } from '../receipts/line-items/ReceiptLineItemUpdateRequest.js';
+import { ReceiptPaymentUpdateRequest } from '../receipts/payments/ReceiptPaymentUpdateRequest.js';
+import { SBBarcode } from '../../entities/barcode/SBBarcode.js';
+
+/**
+ * @file InvoiceUpdateRequest.ts
+ * @description Defines the interface for updating an existing invoice in the Smartbills system.
+ * This interface matches the InvoiceUpdateRequest in the .NET backend.
+ * @module services/invoice
+ */
+
+/**
+ * Interface for updating an existing invoice in the Smartbills system.
+ * Contains the fields that can be updated for an invoice.
+ *
+ * @interface InvoiceUpdateRequest
+ */
+interface InvoiceUpdateRequest {
+    /** The ID of the business associated with the invoice */
+    businessId?: number;
+    /** The ID of the location where the invoice was created */
+    locationId?: number;
+    /** The ID of the employee who processed the invoice */
+    employeeId?: number;
+    /** Updated customer information */
+    customer?: CustomerUpdateRequest;
+    /** Updated billing address */
+    billingAddress?: BillingAddressRequest;
+    /** Updated shipping address */
+    shippingAddress?: BillingAddressRequest;
+    /** Updated line items on the invoice */
+    items?: ReceiptLineItemUpdateRequest[];
+    /** The currency code for the invoice (e.g., "USD", "CAD") */
+    currency?: string;
+    /** The timestamp when the invoice was last updated */
+    updatedAt?: Date;
+    /** The date when the invoice was cancelled, if applicable */
+    cancelledAt?: Date;
+    /** The reason for cancellation, if the invoice was cancelled */
+    cancelReason?: string;
+    /** The payment status of the invoice */
+    paymentStatus?: string;
+    /** The total amount of discounts applied to the invoice */
+    totalDiscounts?: number;
+    /** The taxes applied to the invoice */
+    taxes?: ReceiptTaxUpdateRequest[];
+    /** Whether taxes are included in the item prices */
+    taxesIncluded?: boolean;
+    /** The total tip amount on the invoice */
+    totalTip?: number;
+    /** The total duties amount on the invoice */
+    totalDuties?: number;
+    /** The total shipping amount on the invoice */
+    totalShipping?: number;
+    /** The total weight of the items on the invoice */
+    totalWeight?: number;
+    /** The total taxes amount on the invoice */
+    totalTaxes?: number;
+    /** The total amount of the invoice */
+    total?: number;
+    /** The subtotal amount of the invoice before taxes and fees */
+    subTotal?: number;
+    /** The payments/transactions made for the invoice */
+    transactions?: ReceiptPaymentUpdateRequest[];
+    /** The barcode information for the invoice */
+    barcode?: SBBarcode;
+}
+
+export type { InvoiceUpdateRequest };
+//# sourceMappingURL=InvoiceUpdateRequest.d.ts.map

package/dist/@types/services/invoices/InvoiceUpdateRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvoiceUpdateRequest.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/invoices/InvoiceUpsertRequest.d.ts

@@ -0,0 +1,5 @@
+interface InvoiceUpsertRequest {
+}
+
+export type { InvoiceUpsertRequest };
+//# sourceMappingURL=InvoiceUpsertRequest.d.ts.map

package/dist/@types/services/invoices/InvoiceUpsertRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvoiceUpsertRequest.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/loyalty/LoyaltyProgramService.d.ts

@@ -0,0 +1,172 @@
+import { SBRequestOptions } from '../../client/SBRequestOption.js';
+import { SBServiceOptions } from '../../client/SBServiceOptions.js';
+import { SBService } from '../SBService.js';
+import { SBLoyaltyProgramResponse, LoyaltyProgramListRequest, LoyaltyProgramCreateRequest, LoyaltyProgramUpdateRequest, LoyaltyAccountCreateRequest, SBLoyaltyProgramAccountResponse, LoyaltyProgramPointsAccumulateRequest, SBLoyaltyProgramPointResponse, LoyaltyProgramPointsAdjustRequest, LoyaltyRewardCreateRequest, SBLoyaltyRewardResponse, LoyaltyRewardRedeemRequest } from '../../entities/loyalty.js';
+import { SBList } from '../../entities/base.js';
+import { INestedListable } from '../../interfaces/IListable.js';
+import { AxiosRequestConfig } from 'axios';
+import { INestedDeletable } from '../../interfaces/IDeletable.js';
+import { INestedCreatable } from '../../interfaces/ICreatable.js';
+import { INestedUpdatable } from '../../interfaces/IUpdatable.js';
+import { INestedRetrievableById } from '../../interfaces/IRetrievableById.js';
+
+/**
+ * Service for managing loyalty programs in the Smartbills system
+ * Provides functionality for CRUD operations on loyalty programs, accounts, rewards and points
+ * @implements INestedRetrievableById<SBLoyaltyProgramResponse> - Allows retrieving loyalty programs by ID
+ * @implements INestedListable<LoyaltyProgramListRequest, SBLoyaltyProgramResponse> - Allows listing loyalty programs
+ * @implements INestedCreatable<LoyaltyProgramCreateRequest, SBLoyaltyProgramResponse> - Allows creating loyalty programs
+ * @implements INestedUpdatable<LoyaltyProgramUpdateRequest, SBLoyaltyProgramResponse> - Allows updating loyalty programs
+ * @implements INestedDeletable<SBLoyaltyProgramResponse> - Allows deleting loyalty programs
+ */
+declare class LoyaltyProgramService extends SBService implements INestedRetrievableById<SBLoyaltyProgramResponse>, INestedListable<LoyaltyProgramListRequest, SBLoyaltyProgramResponse>, INestedCreatable<LoyaltyProgramCreateRequest, SBLoyaltyProgramResponse>, INestedUpdatable<LoyaltyProgramUpdateRequest, SBLoyaltyProgramResponse>, INestedDeletable<SBLoyaltyProgramResponse> {
+    /**
+     * Creates a new instance of the loyalty program service
+     * @param options - Service configuration options
+     */
+    constructor(options?: SBServiceOptions);
+    /**
+     * Create a new loyalty program
+     * @param businessId - The business ID
+     * @param request - The loyalty program creation request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created loyalty program
+     */
+    createAsync(businessId: number, request: LoyaltyProgramCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramCreateRequest>): Promise<SBLoyaltyProgramResponse>;
+    /**
+     * Get a loyalty program by ID
+     * @param businessId - The business ID
+     * @param id - The loyalty program ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the loyalty program
+     */
+    getByIdAsync(businessId: number, id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBLoyaltyProgramResponse>;
+    /**
+     * Update a loyalty program
+     * @param businessId - The business ID
+     * @param id - The loyalty program ID
+     * @param request - The update request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated loyalty program
+     */
+    updateAsync(businessId: number, id: number, request: LoyaltyProgramUpdateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramUpdateRequest>): Promise<SBLoyaltyProgramResponse>;
+    /**
+     * List loyalty programs with pagination
+     * @param businessId - The business ID
+     * @param request - The pagination request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with list of loyalty programs
+     */
+    listAsync(businessId: number, request: LoyaltyProgramListRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramListRequest>): Promise<SBList<SBLoyaltyProgramResponse>>;
+    /**
+     * Delete a loyalty program
+     * @param businessId - The business ID
+     * @param id - The loyalty program ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the deleted loyalty program
+     */
+    deleteAsync(businessId: number, id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBLoyaltyProgramResponse>;
+    /**
+     * Create a loyalty program account
+     * @param businessId - The business ID
+     * @param programId - The loyalty program ID
+     * @param request - The account creation request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created loyalty account
+     */
+    createAccount(businessId: number, programId: number, request: LoyaltyAccountCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyAccountCreateRequest>): Promise<SBLoyaltyProgramAccountResponse>;
+    /**
+     * Get a loyalty program account by ID
+     * @param businessId - The business ID
+     * @param programId - The loyalty program ID
+     * @param accountId - The account ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the loyalty account
+     */
+    getAccount(businessId: number, programId: number, accountId: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBLoyaltyProgramAccountResponse>;
+    /**
+     * Delete a loyalty program account
+     * @param businessId - The business ID
+     * @param programId - The loyalty program ID
+     * @param accountId - The account ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the deleted loyalty account
+     */
+    deleteAccount(businessId: number, programId: number, accountId: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBLoyaltyProgramAccountResponse>;
+    /**
+     * List loyalty program accounts
+     * @param businessId - The business ID
+     * @param programId - The loyalty program ID
+     * @param request - The pagination request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with list of loyalty accounts
+     */
+    listAccounts(businessId: number, programId: number, request: LoyaltyProgramListRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramListRequest>): Promise<SBList<SBLoyaltyProgramAccountResponse>>;
+    /**
+     * Accumulate points for a loyalty program
+     * @param businessId - The business ID
+     * @param request - The points accumulation request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the points response
+     */
+    accumulatePoints(businessId: number, request: LoyaltyProgramPointsAccumulateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramPointsAccumulateRequest>): Promise<SBLoyaltyProgramPointResponse>;
+    /**
+     * Adjust points for a loyalty program
+     * @param businessId - The business ID
+     * @param request - The points adjustment request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the points response
+     */
+    adjustPoints(businessId: number, request: LoyaltyProgramPointsAdjustRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramPointsAdjustRequest>): Promise<SBLoyaltyProgramPointResponse>;
+    /**
+     * Issue points to a loyalty program
+     * @param businessId - The business ID
+     * @param request - The points issue request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the points response
+     */
+    issuePoints(businessId: number, request: LoyaltyProgramPointsAccumulateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyProgramPointsAccumulateRequest>): Promise<SBLoyaltyProgramPointResponse>;
+    /**
+     * Create a loyalty reward
+     * @param businessId - The business ID
+     * @param request - The reward creation request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created reward
+     */
+    createReward(businessId: number, request: LoyaltyRewardCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyRewardCreateRequest>): Promise<SBLoyaltyRewardResponse>;
+    /**
+     * Get reward by ID
+     * @param businessId - The business ID
+     * @param id - The reward ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the reward details
+     */
+    getReward(businessId: number, id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBLoyaltyRewardResponse>;
+    /**
+     * Redeem a loyalty reward
+     * @param businessId - The business ID
+     * @param id - The reward ID
+     * @param request - The reward redemption request
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with success message
+     */
+    redeemReward(businessId: number, id: number, request: LoyaltyRewardRedeemRequest, options?: SBRequestOptions, config?: AxiosRequestConfig<LoyaltyRewardRedeemRequest>): Promise<string>;
+}
+
+export { LoyaltyProgramService };
+//# sourceMappingURL=LoyaltyProgramService.d.ts.map

package/dist/@types/services/loyalty/LoyaltyProgramService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoyaltyProgramService.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/notifications/NotificationCreateRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Request interface for creating a new notification
+ */
+interface NotificationCreateRequest {
+    /** Title of the notification */
+    title: string;
+    /** Message content of the notification */
+    message: string;
+    /** Type of notification (e.g., 'info', 'warning', 'error') */
+    type: string;
+    /** ID of the user who will receive this notification */
+    userId: number;
+    /** Optional link associated with the notification */
+    link?: string;
+    /** Optional metadata associated with the notification */
+    metadata?: Record<string, any>;
+}
+
+export type { NotificationCreateRequest };
+//# sourceMappingURL=NotificationCreateRequest.d.ts.map

package/dist/@types/services/notifications/NotificationCreateRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationCreateRequest.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/notifications/NotificationService.d.ts

@@ -0,0 +1,66 @@
+import { SBRequestOptions } from '../../client/SBRequestOption.js';
+import { SBServiceOptions } from '../../client/SBServiceOptions.js';
+import { AxiosRequestConfig } from 'axios';
+import { SBService } from '../SBService.js';
+import { SBNotification } from '../../entities/notifications/SBNotification.js';
+import { SBList } from '../../entities/base.js';
+import { ListRequest } from '../ListRequest.js';
+import { ICreatable } from '../../interfaces/ICreatable.js';
+import { NotificationCreateRequest } from './NotificationCreateRequest.js';
+import { IRetrievableById } from '../../interfaces/IRetrievableById.js';
+
+/**
+ * Service for managing notifications in the Smartbills system
+ * Provides functionality for retrieving, creating, and managing notifications
+ * @implements IRetrievableById<SBNotification> - Allows retrieving notifications by ID
+ * @implements ICreatable<NotificationCreateRequest, SBNotification> - Allows creating new notifications
+ */
+declare class NotificationService extends SBService implements IRetrievableById<SBNotification>, ICreatable<NotificationCreateRequest, SBNotification> {
+    /**
+     * Creates a new instance of the notification service
+     * @param options - Service configuration options
+     */
+    constructor(options?: SBServiceOptions);
+    /**
+     * Retrieves a notification by its ID
+     * @param id - The notification ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the notification data
+     */
+    getByIdAsync(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBNotification>;
+    /**
+     * Lists notifications with pagination
+     * @param request - Pagination parameters
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with paginated notification data
+     */
+    listAsync(request?: ListRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBList<SBNotification>>;
+    /**
+     * Creates a new notification
+     * @param request - Notification creation request data
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the created notification
+     */
+    createAsync(request: NotificationCreateRequest, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBNotification>;
+    /**
+     * Marks a notification as read
+     * @param id - The notification ID
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves with the updated notification
+     */
+    markAsRead(id: number, options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<SBNotification>;
+    /**
+     * Marks all notifications as read
+     * @param options - Request options
+     * @param config - Axios request configuration
+     * @returns Promise that resolves when all notifications are marked as read
+     */
+    markAllAsRead(options?: SBRequestOptions, config?: AxiosRequestConfig): Promise<void>;
+}
+
+export { NotificationService };
+//# sourceMappingURL=NotificationService.d.ts.map

package/dist/@types/services/notifications/NotificationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationService.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/oauth/AccessTokenResponse.d.ts

@@ -0,0 +1,10 @@
+declare class AccessTokenResponse {
+    access_token: string;
+    expires_in?: number;
+    refresh_token?: string;
+    scope?: string;
+    token_type?: string;
+}
+
+export { AccessTokenResponse };
+//# sourceMappingURL=AccessTokenResponse.d.ts.map

package/dist/@types/services/oauth/AccessTokenResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessTokenResponse.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/oauth/AuthorizationCodeResponse.d.ts

@@ -0,0 +1,11 @@
+declare class AuthorizationCodeResponse {
+    constructor(response: string);
+    private findInputValue;
+    redirectUrl: string;
+    code: string;
+    session_state: string;
+    scope: string;
+}
+
+export { AuthorizationCodeResponse };
+//# sourceMappingURL=AuthorizationCodeResponse.d.ts.map

package/dist/@types/services/oauth/AuthorizationCodeResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthorizationCodeResponse.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/oauth/AuthorizeRequest.d.ts

@@ -0,0 +1,18 @@
+interface AuthorizeRequest {
+    client_id: string;
+    redirect_uri?: string;
+    max_age?: number;
+    ui_locales?: string;
+    login_hint?: string;
+    code_challenge_method?: "plain" | "S256";
+    code_challenge?: string;
+    prompt?: "none" | "login";
+    nonce?: string;
+    state?: string;
+    response_type?: "id_token" | "token" | "id_token token" | "code" | "code id_token" | "code id_token token";
+    scope: string;
+    acr_values?: string;
+}
+
+export type { AuthorizeRequest };
+//# sourceMappingURL=AuthorizeRequest.d.ts.map

package/dist/@types/services/oauth/AuthorizeRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthorizeRequest.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/@types/services/oauth/OAuthService.d.ts

@@ -0,0 +1,17 @@
+import { AccessTokenResponse } from './AccessTokenResponse.js';
+import { AuthorizationCodeResponse } from './AuthorizationCodeResponse.js';
+import { AuthorizeRequest } from './AuthorizeRequest.js';
+import { TokenExchangeRequest } from './TokenExchangeRequest.js';
+import { RefreshTokenRequest } from './RefreshTokenRequest.js';
+import { SBService } from '../SBService.js';
+import { SBServiceOptions } from '../../client/SBServiceOptions.js';
+
+declare class OAuthService extends SBService {
+    constructor(options?: SBServiceOptions);
+    getAuthorizationCode(request: AuthorizeRequest): Promise<AuthorizationCodeResponse>;
+    getToken(request: TokenExchangeRequest): Promise<AccessTokenResponse>;
+    refreshToken(loginRequest: RefreshTokenRequest): Promise<AccessTokenResponse>;
+}
+
+export { OAuthService };
+//# sourceMappingURL=OAuthService.d.ts.map

package/dist/@types/services/oauth/OAuthService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OAuthService.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}