@smartbills/sdk 0.0.2-alpha.39 → 0.0.2-alpha.40

package/README.md

@@ -37,5 +37,5 @@ const client = new SmartbillsClient.buildClient({
 ### Executing requests
 
 ```javascript
-const product: SBProduct = await smartbillsClient.products.getById(1);
+const product: SBProduct = await smartbillsClient.products.getByIdAsync(1);
 ```

package/dist/@types/client/SBClient.d.ts

@@ -1,37 +1,31 @@
 import { ApiLogService } from '../services/api-logs/LogService.js';
-import { BankAccountService } from '../services/bank-accounts/BankAccountService.js';
-import { BankInstitutionService } from '../services/bank-institutions/BankInstitutionService.js';
-import { BankTransactionService } from '../services/bank-transactions/BankTransactionService.js';
+import { BankAccountService } from '../services/banks/accounts/BankAccountService.js';
+import { BankTransactionService } from '../services/banks/transactions/BankTransactionService.js';
 import { BankService } from '../services/banks/BankService.js';
-import { BarcodeService } from '../services/barcode/BarcodeService.js';
+import { BankInstitutionService } from '../services/banks/institutions/BankInstitutionService.js';
 import { CardService } from '../services/cards/CardService.js';
-import { CustomerService } from '../services/customers/CustomerService.js';
 import { DocumentService } from '../services/documents/DocumentService.js';
-import { DomainService } from '../services/domains/DomainService.js';
-import { FeeService } from '../services/fees/FeeService.js';
+import { DomainService } from '../services/businesses/domains/DomainService.js';
+import { DepartmentService } from '../services/businesses/departments/DepartmentService.js';
 import { FriendService } from '../services/friends/FriendService.js';
-import { LocationService } from '../services/locations/LocationService.js';
-import { MerchantService } from '../services/merchants/MerchantService.js';
 import { OAuthService } from '../services/oauth/OAuthService.js';
-import { OrganizationService } from '../services/organizations/OrganizationService.js';
+import { BusinessService } from '../services/businesses/BusinessService.js';
 import { SBClientOptions } from './SBClientOptions.js';
+import { AttachmentService } from '../services/attachments/AttachmentService.js';
+import { InvoiceService } from '../services/invoices/InvoiceService.js';
 import { SBLogger } from './SBLogger.js';
 import { PaymentMethodService } from '../services/payment-methods/PaymentMethodService.js';
-import { ProductImageService } from '../services/product-images/ProductImageService.js';
-import { ProductVariantService } from '../services/product-variants/ProductVariantService.js';
-import { ProductService } from '../services/products/ProductService.js';
-import { PromoCodeService } from '../services/promo-codes/PromoCodeService.js';
 import { ReceiptService } from '../services/receipts/ReceiptService.js';
-import { ReviewService } from '../services/reviews/ReviewService.js';
 import { SettlementService } from '../services/settlements/SettlementService.js';
-import { TaxService } from '../services/taxes/TaxService.js';
 import { TransactionService } from '../services/transactions/TransactionService.js';
 import { CurrentUserService } from '../services/user/UserService.js';
 import { UserService } from '../services/users/UserService.js';
 import { SBCredentialProvider } from './SBCredentials.js';
 import { ExploreService } from '../services/explore/ExploreService.js';
 import { SupplierService } from '../services/suppliers/SupplierService.js';
-import { VendorService } from '../services/vendors/VendorService.js';
+import { SubscriptionService } from '../services/billing/subscriptions/SubscriptionService.js';
+import { NotificationService } from '../services/notifications/NotificationService.js';
+import { LoyaltyProgramService } from '../services/loyalty/LoyaltyProgramService.js';
 
 declare class SBClient {
     logger: SBLogger;
@@ -40,33 +34,27 @@ declare class SBClient {
     logs: ApiLogService;
     banks: BankService;
     bankAccounts: BankAccountService;
-    promoCodes: PromoCodeService;
     bankInstitutions: BankInstitutionService;
     bankTransactions: BankTransactionService;
     cards: CardService;
-    barcodes: BarcodeService;
-    customers: CustomerService;
     documents: DocumentService;
     domains: DomainService;
+    departments: DepartmentService;
     explore: ExploreService;
-    fees: FeeService;
-    reviews: ReviewService;
-    locations: LocationService;
-    merchants: MerchantService;
+    invoices: InvoiceService;
+    businesses: BusinessService;
+    notifications: NotificationService;
     oauth: OAuthService;
-    organizations: OrganizationService;
-    productVariants: ProductVariantService;
-    productImages: ProductImageService;
-    products: ProductService;
+    loyaltyPrograms: LoyaltyProgramService;
     receipts: ReceiptService;
     suppliers: SupplierService;
     transactions: TransactionService;
     paymentMethods: PaymentMethodService;
     settlements: SettlementService;
     friends: FriendService;
-    taxes: TaxService;
     users: UserService;
-    vendors: VendorService;
+    attachments: AttachmentService;
+    subscriptions: SubscriptionService;
     /**
      * @constructor
      * Creates an instance of the Smartbills API client.
@@ -75,7 +63,6 @@ declare class SBClient {
     initialize(): Promise<void>;
     get accessToken(): string;
     get refreshToken(): string;
-    set merchantId(merchantId: number);
     setCredentials(credentials: SBCredentialProvider): void;
     setLocale(locale: string): void;
     protected configureServices(): void;

package/dist/@types/client/SBClientOptions.d.ts

@@ -8,7 +8,7 @@ type SBClientOptions = {
         auth?: string;
         api?: string;
     };
-    merchantId?: number;
+    businessId?: number;
     userId?: number;
     sessionId?: string;
     credentials?: SBCredentialProvider;

package/dist/@types/client/SBPermission.d.ts

@@ -19,10 +19,10 @@ declare enum SBPermission {
     PAYMENTS_CREATE = "payments:create",
     PAYMENTS_DELETE = "payments:delete",
     PAYMENTS_UPDATE = "payments:update",
-    MERCHANTS_READ = "merchantsread",
-    MERCHANTS_CREATE = "merchants:create",
-    MERCHANTS_DELETE = "merchants:delete",
-    MERCHANTS_UPDATE = "merchants:update",
+    MERCHANTS_READ = "businessread",
+    MERCHANTS_CREATE = "business:create",
+    MERCHANTS_DELETE = "business:delete",
+    MERCHANTS_UPDATE = "business:update",
     RECEIPTS_READ = "receipts:read",
     RECEIPTS_CREATE = "receipts:create",
     RECEIPTS_DELETE = "receipts:delete",

package/dist/@types/client/SBRequestOption.d.ts

@@ -1,6 +1,12 @@
+/**
+ * Interface for request options that can be passed to service methods
+ */
 type SBRequestOptions = {
-    merchantId?: string;
-    userId?: number;
+    /** Business ID to make requests on behalf of */
+    businessId?: string;
+    /** User ID to make requests on behalf of */
+    userId?: string;
+    /** Locale for localized responses */
     locale?: string;
 };
 

package/dist/@types/entities/address/SBBillingAddress.d.ts

@@ -1,4 +1,4 @@
-import { SBEntity } from '../SBEntity.js';
+import { SBEntity } from '../base.js';
 import { SBAddress } from './SBAddress.js';
 
 interface SBBillingAddress extends SBEntity {

package/dist/@types/entities/address/SBCoordinate.d.ts

@@ -1,4 +1,4 @@
-import { SBEntity } from '../SBEntity.js';
+import { SBEntity } from '../base.js';
 
 interface SBCoordinate extends SBEntity {
     longitude: number;

package/dist/@types/entities/attachments/SBAttachment.d.ts

@@ -0,0 +1,27 @@
+import { SBEntity } from '../base.js';
+import { ITimestamp } from '../../interfaces/ITimestamp.js';
+
+/**
+ * Represents an attachment in the Smartbills system
+ * @extends SBEntity - Base entity with ID
+ * @extends ITimestamp - Timestamp fields for creation and update
+ */
+interface SBAttachment extends SBEntity, ITimestamp {
+    /** Name of the attachment */
+    name: string;
+    /** MIME type of the attachment */
+    mimeType: string;
+    /** Size of the attachment in bytes */
+    size: number;
+    /** URL to access the attachment */
+    url: string;
+    /** ID of the entity this attachment belongs to */
+    entityId: number;
+    /** Type of the entity this attachment belongs to */
+    entityType: string;
+    /** ID of the business that owns this attachment */
+    businessId: number;
+}
+
+export type { SBAttachment };
+//# sourceMappingURL=SBAttachment.d.ts.map

package/dist/@types/entities/attachments/SBAttachment.d.ts.map

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

package/dist/@types/entities/banks/SBBalanceHistory.d.ts

@@ -1,7 +1,10 @@
 import { SBBankBalance } from './SBBankBalance.js';
+import { SBEntity } from '../base.js';
 
-interface SBBalanceHistory extends SBBankBalance {
-    date: Date;
+interface SBBalanceHistory extends SBEntity, SBBankBalance {
+    date: string;
+    bankId?: number;
+    bankAccountId?: number;
 }
 
 export type { SBBalanceHistory };

package/dist/@types/entities/banks/SBBank.d.ts

@@ -1,16 +1,17 @@
-import { SBEntity } from '../SBEntity.js';
+import { SBEntity } from '../base.js';
 import { SBBankAccount } from './SBBankAccount.js';
 import { SBBankBalance } from './SBBankBalance.js';
 import { SBBankInstitution } from './SBBankInstitution.js';
-import { SBBankStateEnum } from './SBBankState.js';
 
 interface SBBank extends SBEntity {
     institution: SBBankInstitution;
-    lastUpdate?: Date;
-    createdAt: Date;
-    state: SBBankStateEnum;
+    consentExpiration: string;
+    updatedAt?: string;
+    createdAt: string;
     bankAccounts: SBBankAccount[];
+    userId?: number;
     balance: SBBankBalance;
+    plaidId?: string;
 }
 
 export type { SBBank };

package/dist/@types/entities/banks/SBBankAccount.d.ts

@@ -1,17 +1,18 @@
-import { SBEntity } from '../SBEntity.js';
-import { SBBank } from './SBBank.js';
+import { SBEntity } from '../base.js';
 import { SBBankBalance } from './SBBankBalance.js';
-import { SBBankTransaction } from './SBBankTransaction.js';
 
 interface SBBankAccount extends SBEntity {
-    bank: SBBank;
-    type: string;
-    subtype: string;
     name: string;
-    mask: string;
-    officialName: string;
-    balance: SBBankBalance;
-    transactions: SBBankTransaction[];
+    mask?: string;
+    type?: string;
+    subtype?: string;
+    verificationStatus?: string;
+    balance?: SBBankBalance;
+    plaidId?: string;
+    bankId?: number;
+    userId?: number;
+    isDefault?: boolean;
+    isEnabled?: boolean;
 }
 
 export type { SBBankAccount };

package/dist/@types/entities/banks/SBBankBalance.d.ts

@@ -1,8 +1,10 @@
 interface SBBankBalance {
-    current: number;
-    currencyCode: string;
-    limit: number;
     available: number;
+    current: number;
+    limit?: number;
+    isoCurrencyCode?: string;
+    unofficialCurrencyCode?: string;
+    lastUpdate?: string;
 }
 
 export type { SBBankBalance };

package/dist/@types/entities/banks/SBBankInstitution.d.ts

@@ -1,9 +1,11 @@
-import { SBEntity } from '../SBEntity.js';
+import { SBEntity } from '../base.js';
 
 interface SBBankInstitution extends SBEntity {
     name: string;
-    logo: string;
-    url: string;
+    logo?: string;
+    website?: string;
+    primaryColor?: string;
+    plaidInstitutionId?: string;
 }
 
 export type { SBBankInstitution };

package/dist/@types/entities/banks/SBBankTransaction.d.ts

@@ -1,4 +1,4 @@
-import { SBEntity } from '../SBEntity.js';
+import { SBEntity } from '../base.js';
 import { SBAddress } from '../address/SBAddress.js';
 import { SBBank } from './SBBank.js';
 import { SBBankAccount } from './SBBankAccount.js';
@@ -7,17 +7,29 @@ import { SBDocument } from '../documents/SBDocument.js';
 
 interface SBBankTransaction extends SBEntity {
     amount: number;
-    currencyCode: string;
-    categories: string[];
-    date: Date;
+    isoCurrencyCode?: string;
+    unofficialCurrencyCode?: string;
+    categories?: string[];
+    date: string;
     name: string;
-    paymentChannel: string;
-    storeNumber: string;
-    address: SBAddress;
-    bankAccount: SBBankAccount;
-    bank: SBBank;
+    businessName?: string;
+    paymentChannel?: string;
+    pending?: boolean;
+    pendingTransactionId?: string;
+    accountOwner?: string;
+    transactionId?: string;
+    transactionType?: string;
+    transactionCode?: string;
+    storeNumber?: string;
+    address?: SBAddress;
+    bankAccount?: SBBankAccount;
+    bank?: SBBank;
     receipt?: SBReceipt;
-    documents: SBDocument[];
+    documents?: SBDocument[];
+    plaidId?: string;
+    userId?: number;
+    bankId?: number;
+    bankAccountId?: number;
 }
 
 export type { SBBankTransaction };

package/dist/@types/entities/base.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Represents a paginated list of items.
+ *
+ * @template T - The type of items in the list.
+ */
+interface SBList<T> {
+    /** Array of items in the list */
+    data: Array<T>;
+    /** Pagination details for the list */
+    pagination: Pagination;
+}
+/**
+ * Base interface for all entities in the Smartbills system.
+ * All entities must have a unique identifier.
+ */
+interface SBEntity {
+    /** Unique identifier for the entity */
+    id: number;
+}
+/**
+ * Interface representing pagination details.
+ */
+interface Pagination {
+    /**
+     * The total number of items.
+     */
+    count: number;
+    /**
+     * The maximum number of items per page.
+     */
+    limit: number;
+    /**
+     * The current page number.
+     */
+    currentPage: number;
+    /**
+     * The total number of pages.
+     */
+    pageCount: number;
+    /**
+     * Optional filters applied to the pagination.
+     */
+    filters?: string;
+    /**
+     * Optional sorting criteria applied to the pagination.
+     */
+    sorts?: string;
+}
+interface PaginationLinks {
+    next?: string;
+    previous?: string;
+    first?: string;
+    last?: string;
+    self?: string;
+}
+
+export type { Pagination, PaginationLinks, SBEntity, SBList };
+//# sourceMappingURL=base.d.ts.map

package/dist/@types/entities/base.d.ts.map

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

package/dist/@types/entities/businesses/SBBusiness.d.ts

@@ -0,0 +1,19 @@
+import { SBDomain } from '../domains/SBDomain.js';
+import { SBEntity } from '../base.js';
+import { SBAddress } from '../address/SBAddress.js';
+
+interface SBBusiness extends SBEntity {
+    name: string;
+    description?: string | undefined;
+    address?: SBAddress;
+    phoneNumber?: string | undefined;
+    customerEmail?: string | undefined;
+    logo?: string | undefined;
+    domains?: SBDomain[];
+    slug?: string | undefined;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+
+export type { SBBusiness };
+//# sourceMappingURL=SBBusiness.d.ts.map

package/dist/@types/entities/businesses/SBBusiness.d.ts.map

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

package/dist/@types/entities/businesses/customers/SBCustomer.d.ts

@@ -0,0 +1,35 @@
+import { SBEntity } from '../../base.js';
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+
+/**
+ * Represents a customer in the Smartbills system
+ * @extends SBEntity - Base entity with ID
+ * @extends ITimestamp - Timestamp fields for creation and update
+ */
+interface SBCustomer extends SBEntity, ITimestamp {
+    /** Customer's first name */
+    firstName: string;
+    /** Customer's last name */
+    lastName: string;
+    /** Customer's email address */
+    email: string;
+    /** Customer's phone number */
+    phone: string;
+    /** List of tags associated with the customer */
+    tags: string[];
+    /** Customer's preferred currency */
+    currency: string;
+    /** Whether the customer accepts marketing communications */
+    acceptsMarketing: boolean;
+    /** Date and time when the customer was created */
+    createdAt: Date;
+    /** Date and time when the customer was last updated */
+    updatedAt?: Date;
+    /** ID of the business that owns this customer */
+    businessId: number;
+    /** Customer's current balance */
+    balance: number;
+}
+
+export type { SBCustomer };
+//# sourceMappingURL=SBCustomer.d.ts.map

package/dist/@types/entities/businesses/customers/balance-transactions/SBCustomerBalanceTransaction.d.ts

@@ -0,0 +1,12 @@
+import { SBEntity } from '../../../base.js';
+
+interface SBCustomerBalanceTransaction extends SBEntity {
+    amount: number;
+    currency: string;
+    endingBalance: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+
+export type { SBCustomerBalanceTransaction };
+//# sourceMappingURL=SBCustomerBalanceTransaction.d.ts.map

package/dist/@types/entities/businesses/departments/SBDepartment.d.ts

@@ -0,0 +1,35 @@
+import { SBEntity } from '../../base.js';
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+
+/**
+ * Represents a department within a business in the Smartbills system
+ */
+interface SBDepartment extends SBEntity, ITimestamp {
+    /**
+     * The name of the department
+     */
+    name: string;
+    /**
+     * Optional description of the department
+     */
+    description?: string;
+    /**
+     * Optional code or identifier for the department
+     */
+    code?: string;
+    /**
+     * Optional parent department ID if this is a sub-department
+     */
+    parentDepartmentId?: number;
+    /**
+     * Business ID this department belongs to
+     */
+    businessId: number;
+    /**
+     * Number of employees in this department if available
+     */
+    employeeCount?: number;
+}
+
+export type { SBDepartment };
+//# sourceMappingURL=SBDepartment.d.ts.map

package/dist/@types/entities/businesses/departments/SBDepartment.d.ts.map

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

package/dist/@types/entities/businesses/departments/SBDepartmentTeamMember.d.ts

@@ -0,0 +1,22 @@
+import { SBTeamMember } from '../team/members/SBTeamMember.js';
+
+/**
+ * Represents an employee assigned to a department
+ */
+interface SBDepartmentTeamMember {
+    /**
+     * The unique identifier for the department employee relationship
+     */
+    id: number;
+    /**
+     * The employee ID
+     */
+    teamMember: SBTeamMember;
+    /**
+     * The department ID
+     */
+    departmentId: number;
+}
+
+export type { SBDepartmentTeamMember };
+//# sourceMappingURL=SBDepartmentTeamMember.d.ts.map

package/dist/@types/entities/businesses/departments/SBDepartmentTeamMember.d.ts.map

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

package/dist/@types/entities/businesses/fees/SBFee.d.ts

@@ -0,0 +1,12 @@
+import { SBEntity } from '../../base.js';
+import { SBFeeType } from './SBFeeType.js';
+
+interface SBFee extends SBEntity {
+    name: string;
+    amount?: number;
+    rate?: number;
+    type: SBFeeType;
+}
+
+export type { SBFee };
+//# sourceMappingURL=SBFee.d.ts.map

package/dist/@types/entities/businesses/locations/SBLocation.d.ts

@@ -0,0 +1,16 @@
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+import { SBEntity } from '../../base.js';
+import { SBAddress } from '../../address/SBAddress.js';
+import { SBBusiness } from '../SBBusiness.js';
+
+interface SBLocation extends SBEntity, ITimestamp {
+    active: boolean;
+    name: string;
+    address: SBAddress;
+    phoneNumber: string;
+    business?: SBBusiness;
+    businessId?: number;
+}
+
+export type { SBLocation };
+//# sourceMappingURL=SBLocation.d.ts.map

package/dist/@types/entities/businesses/locations/SBLocationBatch.d.ts

@@ -0,0 +1,9 @@
+import { SBBatch } from '../../batches/SBBatch.js';
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+import { SBLocation } from './SBLocation.js';
+
+interface SBLocationBatch extends SBBatch<SBLocation>, ITimestamp {
+}
+
+export type { SBLocationBatch };
+//# sourceMappingURL=SBLocationBatch.d.ts.map

package/dist/@types/entities/businesses/products/SBProduct.d.ts

@@ -0,0 +1,21 @@
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+import { SBEntity } from '../../base.js';
+import { SBProductImage } from './SBProductImage.js';
+import { SBProductVariant } from './SBProductVariant.js';
+import { SBProducTranslation } from './SBProductTranslation.js';
+import { SBProductVendor } from './SBProductVendor.js';
+
+interface SBProduct extends SBEntity, ITimestamp {
+    businessId?: number;
+    name: string;
+    vendor?: SBProductVendor;
+    categorie: string;
+    tags: string[];
+    slug: string;
+    images: SBProductImage[];
+    variants: SBProductVariant[];
+    translations: SBProducTranslation[];
+}
+
+export type { SBProduct };
+//# sourceMappingURL=SBProduct.d.ts.map

package/dist/@types/entities/businesses/products/SBProductImage.d.ts

@@ -0,0 +1,8 @@
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+
+interface SBProductImage extends ITimestamp {
+    src: string;
+}
+
+export type { SBProductImage };
+//# sourceMappingURL=SBProductImage.d.ts.map

package/dist/@types/entities/businesses/products/SBProductTranslation.d.ts

@@ -0,0 +1,11 @@
+import { SBEntity } from '../../base.js';
+
+interface SBProducTranslation extends SBEntity {
+    locale: string;
+    name: string;
+    description?: string;
+    htmlDescription?: string;
+}
+
+export type { SBProducTranslation };
+//# sourceMappingURL=SBProductTranslation.d.ts.map

package/dist/@types/entities/businesses/products/SBProductVariant.d.ts

@@ -0,0 +1,18 @@
+import { ITimestamp } from '../../../interfaces/ITimestamp.js';
+import { SBProductVariantOption } from './SBProductVariantOption.js';
+import { SBPrice } from '../../prices/SBPrice.js';
+
+interface SBProductVariant extends ITimestamp {
+    name: string;
+    taxable?: boolean;
+    position?: number;
+    weight?: number;
+    weightUnit?: string;
+    prices?: SBPrice[];
+    options?: SBProductVariantOption[];
+    barcode?: string;
+    sku?: string;
+}
+
+export type { SBProductVariant };
+//# sourceMappingURL=SBProductVariant.d.ts.map

package/dist/@types/entities/businesses/products/modifiers/SBProductModifier.d.ts

@@ -0,0 +1,10 @@
+interface SBProductModifier {
+    id: string;
+    name: string;
+    description?: string;
+    price: number;
+    isActive: boolean;
+}
+
+export type { SBProductModifier };
+//# sourceMappingURL=SBProductModifier.d.ts.map