Update eslintignore, package.json, and models for DirectBilling and S…

…MS services

The commit updates the .eslintignore file to ignore the lib/ directory, updates the version number in package.json from 2.2.4 to 2.3.0, adds linting scripts to package.json, and modifies import statements in DirectBilling and SMS service models to use single quotes instead of double quotes. Additionally, it changes some number type parameters in DirectBilling and SMS service methods from `number` to `string`.

.eslintignore

@@ -0,0 +1 @@
+lib/

lib/index.d.ts

@@ -1,21 +1,21 @@
-export { DbCalculation } from "./models/directbilling/service/db.calculation";
-export { DbProvider, DbProviderID } from "./models/directbilling/db.provider";
-export { DbService, DbServiceNotify } from "./models/directbilling/service/db.service";
-export { PartialDbService } from "./models/directbilling/service/partial.db.service";
-export { DbGenerationResponse } from "./models/directbilling/transaction/db.generation.response";
-export { DbTransactionRequest } from "./models/directbilling/transaction/db.transaction.request";
-export { DbTransactionStatus } from "./models/directbilling/transaction/db.transaction.status";
-export { DbTransaction } from "./models/directbilling/transaction/db.transaction";
-export { PartialDbTransaction } from "./models/directbilling/transaction/partial.db.transaction";
-export { DBServiceStatus } from "./models/directbilling/service/db.service.status";
-export { PaginatedResponse } from "./models/response/paginated.response";
-export { AmountType } from "./models/amount.type";
-export { SmsNumber } from "./models/sms/service/sms.number";
-export { SmsService } from "./models/sms/service/sms.service";
-export { SmsServiceType } from "./models/sms/service/sms.service.type";
-export { SmsTransaction } from "./models/sms/transaction/sms.transaction";
-export { VerificationResponse } from "./models/sms/verification.response";
-export { SMSServiceStatus } from "./models/sms/service/sms.service.status";
-export { DirectBilling } from "./payments/directbilling";
-export { Sms } from "./payments/sms";
-export { SmsXml } from "./payments/sms.xml";
+export { DbCalculation } from './models/directbilling/service/db.calculation';
+export { DbProvider, DbProviderID } from './models/directbilling/db.provider';
+export { DbService, DbServiceNotify } from './models/directbilling/service/db.service';
+export { PartialDbService } from './models/directbilling/service/partial.db.service';
+export { DbGenerationResponse } from './models/directbilling/transaction/db.generation.response';
+export { DbTransactionRequest } from './models/directbilling/transaction/db.transaction.request';
+export { DbTransactionStatus } from './models/directbilling/transaction/db.transaction.status';
+export { DbTransaction } from './models/directbilling/transaction/db.transaction';
+export { PartialDbTransaction } from './models/directbilling/transaction/partial.db.transaction';
+export { DBServiceStatus } from './models/directbilling/service/db.service.status';
+export { PaginatedResponse } from './models/response/paginated.response';
+export { AmountType } from './models/amount.type';
+export { SmsNumber } from './models/sms/service/sms.number';
+export { SmsService } from './models/sms/service/sms.service';
+export { SmsServiceType } from './models/sms/service/sms.service.type';
+export { SmsTransaction } from './models/sms/transaction/sms.transaction';
+export { VerificationResponse } from './models/sms/verification.response';
+export { SMSServiceStatus } from './models/sms/service/sms.service.status';
+export { DirectBilling } from './payments/directbilling';
+export { Sms } from './payments/sms';
+export { SmsXml } from './payments/sms.xml';

lib/models/directbilling/transaction/db.notifications.request.d.ts

@@ -3,7 +3,7 @@ import { DbTransactionStatus } from '../transaction/db.transaction.status';
 import { DbProviderID } from '../db.provider';
 export interface DbNotificationRequest {
     id: string;
-    service_id: number;
+    service_id: string;
     status: DbTransactionStatus;
     values?: {
         net?: number;

lib/models/sms/service/sms.service.d.ts

@@ -1,7 +1,7 @@
 import { SmsServiceType } from './sms.service.type';
 import { SMSServiceStatus } from './sms.service.status';
 export interface SmsService {
-    id: number;
+    id: string;
     type: SmsServiceType;
     status: SMSServiceStatus;
     name: string;

lib/payments/directbilling.d.ts

@@ -14,12 +14,12 @@ export declare class DirectBilling {
     constructor(key: string, password: string);
     getServices(): Promise<PartialDbService[]>;
     getServicesPaginated(page?: number, pageSize?: number): Promise<PaginatedResponse<PartialDbService>>;
-    getService(id: number): Promise<DbService | undefined>;
-    calculateCommission(serviceId: number, amount: number): Promise<DbCalculation | undefined>;
-    getTransactions(serviceId: number): Promise<PartialDbTransaction[]>;
-    getTransactionsPaginated(serviceId: number, page?: number, pageSize?: number): Promise<PaginatedResponse<PartialDbTransaction>>;
-    getTransaction(serviceId: number, transactionId: string): Promise<DbTransaction | undefined>;
-    createTransaction(serviceId: number, key: string, request: DbTransactionRequest): Promise<DbGenerationResponse | undefined>;
+    getService(id: string): Promise<DbService | undefined>;
+    calculateCommission(serviceId: string, amount: number): Promise<DbCalculation | undefined>;
+    getTransactions(serviceId: string): Promise<PartialDbTransaction[]>;
+    getTransactionsPaginated(serviceId: string, page?: number, pageSize?: number): Promise<PaginatedResponse<PartialDbTransaction>>;
+    getTransaction(serviceId: string, transactionId: string): Promise<DbTransaction | undefined>;
+    createTransaction(serviceId: string, key: string, request: DbTransactionRequest): Promise<DbGenerationResponse | undefined>;
     checkNotification(key: string, body: any): DbNotificationRequest | undefined;
     generateSignature(key: string, request: DbTransactionRequest): string;
     generateSignatureNotification(key: string, request: DbNotificationRequest): string;

lib/payments/sms.d.ts

@@ -10,15 +10,15 @@ export declare class Sms {
     constructor(key: string, password: string);
     getServices(): Promise<SmsService[]>;
     getServicesPaginated(page?: number, pageSize?: number): Promise<PaginatedResponse<SmsService>>;
-    getService(id: number): Promise<SmsService | undefined>;
-    getTransactions(serviceId: number): Promise<SmsTransaction[]>;
-    getTransactionsPaginated(serviceId: number, page?: number, pageSize?: number): Promise<PaginatedResponse<SmsTransaction>>;
-    getTransaction(serviceId: number, transactionId: number): Promise<SmsTransaction | undefined>;
-    getServiceNumbers(serviceId: number): Promise<SmsNumber[]>;
-    getServiceNumbersPaginated(serviceId: number, page?: number, pageSize?: number): Promise<PaginatedResponse<SmsNumber>>;
-    getServiceNumber(serviceId: number, number: number): Promise<SmsNumber>;
+    getService(id: string): Promise<SmsService | undefined>;
+    getTransactions(serviceId: string): Promise<SmsTransaction[]>;
+    getTransactionsPaginated(serviceId: string, page?: number, pageSize?: number): Promise<PaginatedResponse<SmsTransaction>>;
+    getTransaction(serviceId: string, transactionId: number): Promise<SmsTransaction | undefined>;
+    getServiceNumbers(serviceId: string): Promise<SmsNumber[]>;
+    getServiceNumbersPaginated(serviceId: string, page?: number, pageSize?: number): Promise<PaginatedResponse<SmsNumber>>;
+    getServiceNumber(serviceId: string, number: number): Promise<SmsNumber>;
     getNumbers(): Promise<SmsNumber[]>;
     getNumbersPaginated(page?: number, pageSize?: number): Promise<PaginatedResponse<SmsNumber>>;
     getNumber(number: number): Promise<SmsNumber | undefined>;
-    verifySmsCode(serviceId: number, code: string, number?: number): Promise<VerificationResponse | undefined>;
+    verifySmsCode(serviceId: string, code: string, number?: number): Promise<VerificationResponse | undefined>;
 }

lib/tests/directbilling.js

@@ -17,22 +17,22 @@ const run = () => __awaiter(void 0, void 0, void 0, function* () {
     console.log(yield db.getServices());
     console.log(yield db.getServicesPaginated(1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-informacji-o-usludze
-    console.log(yield db.getService(158));
+    console.log(yield db.getService('19f3b33c'));
     // https://docs.simpay.pl/pl/typescript/?typescript#directbilling-kalkulacja-prowizji
-    console.log(yield db.calculateCommission(158, 10.00));
+    console.log(yield db.calculateCommission('19f3b33c', 10.00));
     // https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-listy-transakcji
-    const transactionsList = yield db.getTransactions(158);
+    const transactionsList = yield db.getTransactions('19f3b33c');
     console.log(transactionsList);
-    console.log(yield db.getTransactionsPaginated(158, 1, 100));
+    console.log(yield db.getTransactionsPaginated('19f3b33c', 1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-informacji-o-transakcji
-    console.log(yield db.getTransaction(158, transactionsList === null || transactionsList === void 0 ? void 0 : transactionsList[0].id));
+    console.log(yield db.getTransaction('19f3b33c', transactionsList === null || transactionsList === void 0 ? void 0 : transactionsList[0].id));
     // https://docs.simpay.pl/pl/typescript/?typescript#directbilling-generowanie-transakcji
-    console.log(yield db.createTransaction(158, 'key', {
+    console.log(yield db.createTransaction('19f3b33c', 'key', {
         amount: 10.00,
         amountType: amount_type_1.AmountType.GROSS,
         control: 'test'
     }));
-    console.log(yield db.checkNotification('key', {}));
+    console.log(db.checkNotification('key', {}));
 });
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 void run();

lib/tests/sms.js

@@ -16,25 +16,25 @@ const run = () => __awaiter(void 0, void 0, void 0, function* () {
     console.log(yield sms.getServices());
     console.log(yield sms.getServicesPaginated(1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-informacji-o-usludze
-    console.log(yield sms.getService(3549));
+    console.log(yield sms.getService('d151e4f9'));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-listy-transakcji
-    console.log(yield sms.getTransactions(3549));
-    console.log(yield sms.getTransactionsPaginated(3549, 1, 100));
+    console.log(yield sms.getTransactions('d151e4f9'));
+    console.log(yield sms.getTransactionsPaginated('d151e4f9', 1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-informacji-o-transakcji
-    console.log(yield sms.getTransaction(3549, 2216609));
+    console.log(yield sms.getTransaction('d151e4f9', 2216609));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-dostepnych-numerow-dla-uslugi
-    console.log(yield sms.getServiceNumbers(3549));
-    console.log(yield sms.getServiceNumbersPaginated(3549, 1, 100));
+    console.log(yield sms.getServiceNumbers('d151e4f9'));
+    console.log(yield sms.getServiceNumbersPaginated('d151e4f9', 1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-informacji-o-pojedynczym-numerze-uslugi
-    console.log(yield sms.getServiceNumber(3549, 7055));
+    console.log(yield sms.getServiceNumber('d151e4f9', 7055));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-wszystkich-dostepnych-numerow
     console.log(yield sms.getNumbers());
     console.log(yield sms.getNumbersPaginated(1, 100));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-pobieranie-pojedynczego-numeru-sms
     console.log(yield sms.getNumber(7055));
     // https://docs.simpay.pl/pl/typescript/?typescript#sms-weryfikacja-poprawnosci-kodu
-    console.log(yield sms.verifySmsCode(3549, '81FFC5', 7055));
-    console.log(yield sms.verifySmsCode(3549, '81FFC5'));
+    console.log(yield sms.verifySmsCode('d151e4f9', '81FFC5', 7055));
+    console.log(yield sms.verifySmsCode('d151e4f9', '81FFC5'));
 });
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 void run();

package.json

@@ -1,14 +1,15 @@
 {
   "name": "simpay-typescript-api",
   "author": "Rafał Więcek",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "description": "SimPay.pl API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",
-    "lint": "eslint",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
     "dev": "tsc && node lib/test.js"
   },
   "keywords": [

src/index.ts

@@ -1,28 +1,28 @@
 // DirectBilling - Models
-export { DbCalculation } from "./models/directbilling/service/db.calculation";
-export { DbProvider, DbProviderID } from "./models/directbilling/db.provider";
-export { DbService, DbServiceNotify } from "./models/directbilling/service/db.service";
-export { PartialDbService } from "./models/directbilling/service/partial.db.service";
-export { DbGenerationResponse } from "./models/directbilling/transaction/db.generation.response";
-export { DbTransactionRequest } from "./models/directbilling/transaction/db.transaction.request";
-export { DbTransactionStatus } from "./models/directbilling/transaction/db.transaction.status";
-export { DbTransaction } from "./models/directbilling/transaction/db.transaction";
-export { PartialDbTransaction } from "./models/directbilling/transaction/partial.db.transaction";
-export { DBServiceStatus } from "./models/directbilling/service/db.service.status";
+export { DbCalculation } from './models/directbilling/service/db.calculation';
+export { DbProvider, DbProviderID } from './models/directbilling/db.provider';
+export { DbService, DbServiceNotify } from './models/directbilling/service/db.service';
+export { PartialDbService } from './models/directbilling/service/partial.db.service';
+export { DbGenerationResponse } from './models/directbilling/transaction/db.generation.response';
+export { DbTransactionRequest } from './models/directbilling/transaction/db.transaction.request';
+export { DbTransactionStatus } from './models/directbilling/transaction/db.transaction.status';
+export { DbTransaction } from './models/directbilling/transaction/db.transaction';
+export { PartialDbTransaction } from './models/directbilling/transaction/partial.db.transaction';
+export { DBServiceStatus } from './models/directbilling/service/db.service.status';
 
 // Response
-export { PaginatedResponse } from "./models/response/paginated.response";
-export { AmountType } from "./models/amount.type";
+export { PaginatedResponse } from './models/response/paginated.response';
+export { AmountType } from './models/amount.type';
 
 // SMS - Models
-export { SmsNumber } from "./models/sms/service/sms.number";
-export { SmsService } from "./models/sms/service/sms.service";
-export { SmsServiceType } from "./models/sms/service/sms.service.type";
-export { SmsTransaction } from "./models/sms/transaction/sms.transaction";
-export { VerificationResponse } from "./models/sms/verification.response";
-export { SMSServiceStatus } from "./models/sms/service/sms.service.status";
+export { SmsNumber } from './models/sms/service/sms.number';
+export { SmsService } from './models/sms/service/sms.service';
+export { SmsServiceType } from './models/sms/service/sms.service.type';
+export { SmsTransaction } from './models/sms/transaction/sms.transaction';
+export { VerificationResponse } from './models/sms/verification.response';
+export { SMSServiceStatus } from './models/sms/service/sms.service.status';
 
 // Payments
-export { DirectBilling } from "./payments/directbilling"
-export { Sms } from "./payments/sms"
-export { SmsXml } from "./payments/sms.xml"
+export { DirectBilling } from './payments/directbilling';
+export { Sms } from './payments/sms';
+export { SmsXml } from './payments/sms.xml';

src/models/directbilling/transaction/db.notifications.request.ts

@@ -4,7 +4,7 @@ import {DbProviderID} from '../db.provider';
 
 export interface DbNotificationRequest {
     id: string,
-    service_id: number,
+    service_id: string,
     status: DbTransactionStatus,
     values?: {
         net?: number,

src/models/sms/service/sms.service.ts

@@ -2,7 +2,7 @@ import {SmsServiceType} from './sms.service.type';
 import {SMSServiceStatus} from './sms.service.status';
 
 export interface SmsService {
-    id: number;
+    id: string;
 
     type: SmsServiceType;
 

src/payments/directbilling.ts

@@ -75,7 +75,7 @@ export class DirectBilling {
     /*
         https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-informacji-o-usludze
      */
-    async getService(id: number): Promise<DbService | undefined> {
+    async getService(id: string): Promise<DbService | undefined> {
         try {
             const service = (await this.client.get(`/${id}`)).data.data;
 
@@ -90,14 +90,14 @@ export class DirectBilling {
     /*
         https://docs.simpay.pl/pl/typescript/?typescript#directbilling-kalkulacja-prowizji
      */
-    async calculateCommission(serviceId: number, amount: number): Promise<DbCalculation | undefined> {
+    async calculateCommission(serviceId: string, amount: number): Promise<DbCalculation | undefined> {
         return (await this.client.get(`/${serviceId}/calculate?amount=${amount}`)).data.data;
     }
 
     /*
         https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-listy-transakcji
      */
-    async getTransactions(serviceId: number): Promise<PartialDbTransaction[]> {
+    async getTransactions(serviceId: string): Promise<PartialDbTransaction[]> {
         const result = [];
 
         let response = await this.client.get(`/${serviceId}/transactions`);
@@ -118,7 +118,7 @@ export class DirectBilling {
         });
     }
 
-    async getTransactionsPaginated(serviceId: number, page?: number, pageSize?: number): Promise<PaginatedResponse<PartialDbTransaction>> {
+    async getTransactionsPaginated(serviceId: string, page?: number, pageSize?: number): Promise<PaginatedResponse<PartialDbTransaction>> {
         const query: any = {};
 
         if (page) query.page = `${page}`;
@@ -141,7 +141,7 @@ export class DirectBilling {
     /*
         https://docs.simpay.pl/pl/typescript/?typescript#directbilling-pobieranie-informacji-o-transakcji
      */
-    async getTransaction(serviceId: number, transactionId: string): Promise<DbTransaction | undefined> {
+    async getTransaction(serviceId: string, transactionId: string): Promise<DbTransaction | undefined> {
         const transaction = (await this.client.get(`/${serviceId}/transactions/${transactionId}`)).data.data;
 
         transaction.created_at = new Date(transaction.created_at.replace(' ', 'T'));
@@ -153,7 +153,7 @@ export class DirectBilling {
     /*
         https://docs.simpay.pl/pl/typescript/?typescript#directbilling-generowanie-transakcji
      */
-    async createTransaction(serviceId: number, key: string, request: DbTransactionRequest): Promise<DbGenerationResponse | undefined> {
+    async createTransaction(serviceId: string, key: string, request: DbTransactionRequest): Promise<DbGenerationResponse | undefined> {
         request.signature = this.generateSignature(key, request);
 
         return (await this.client.post(`/${serviceId}/transactions`, request)).data;