@medusajs/medusa 1.3.2 → 1.3.3

package/dist/services/gift-card.d.ts

@@ -1,69 +1,78 @@
-export default GiftCardService;
-declare const GiftCardService_base: any;
+import { EntityManager } from "typeorm";
+import { EventBusService } from ".";
+import { TransactionBaseService } from "../interfaces";
+import { GiftCard } from "../models";
+import { GiftCardRepository } from "../repositories/gift-card";
+import { GiftCardTransactionRepository } from "../repositories/gift-card-transaction";
+import { FindConfig, QuerySelector, Selector } from "../types/common";
+import { CreateGiftCardInput, CreateGiftCardTransactionInput, UpdateGiftCardInput } from "../types/gift-card";
+import RegionService from "./region";
+declare type InjectedDependencies = {
+    manager: EntityManager;
+    giftCardRepository: typeof GiftCardRepository;
+    giftCardTransactionRepository: typeof GiftCardTransactionRepository;
+    regionService: RegionService;
+    eventBusService: EventBusService;
+};
 /**
  * Provides layer to manipulate gift cards.
- * @extends BaseService
  */
-declare class GiftCardService extends GiftCardService_base {
-    [x: string]: any;
+declare class GiftCardService extends TransactionBaseService<GiftCardService> {
+    protected readonly giftCardRepository_: typeof GiftCardRepository;
+    protected readonly giftCardTransactionRepo_: typeof GiftCardTransactionRepository;
+    protected readonly regionService_: RegionService;
+    protected readonly eventBus_: EventBusService;
+    protected manager_: EntityManager;
+    protected transactionManager_: EntityManager | undefined;
     static Events: {
         CREATED: string;
     };
-    constructor({ manager, giftCardRepository, giftCardTransactionRepository, regionService, eventBusService, }: {
-        manager: any;
-        giftCardRepository: any;
-        giftCardTransactionRepository: any;
-        regionService: any;
-        eventBusService: any;
-    });
-    /** @private @const {EntityManager} */
-    private manager_;
-    /** @private @const {GiftCardRepository} */
-    private giftCardRepository_;
-    /** @private @const {GiftCardRepository} */
-    private giftCardTransactionRepo_;
-    /** @private @const {RegionService} */
-    private regionService_;
-    /** @private @const {EventBus} */
-    private eventBus_;
-    withTransaction(transactionManager: any): GiftCardService;
+    constructor({ manager, giftCardRepository, giftCardTransactionRepository, regionService, eventBusService, }: InjectedDependencies);
     /**
      * Generates a 16 character gift card code
-     * @return {string} the generated gift card code
+     * @return the generated gift card code
+     */
+    static generateCode(): string;
+    /**
+     * @param selector - the query object for find
+     * @param config - the configuration used to find the objects. contains relations, skip, and take.
+     * @return the result of the find operation
      */
-    generateCode_(): string;
+    listAndCount(selector?: QuerySelector<GiftCard>, config?: FindConfig<GiftCard>): Promise<[GiftCard[], number]>;
     /**
-     * @param {Object} selector - the query object for find
-     * @param {Object} config - the configuration used to find the objects. contains relations, skip, and take.
-     * @return {Promise} the result of the find operation
+     * @param selector - the query object for find
+     * @param config - the configuration used to find the objects. contains relations, skip, and take.
+     * @return the result of the find operation
      */
-    list(selector?: any, config?: any): Promise<any>;
-    createTransaction(data: any): Promise<any>;
+    list(selector?: QuerySelector<GiftCard>, config?: FindConfig<GiftCard>): Promise<GiftCard[]>;
+    createTransaction(data: CreateGiftCardTransactionInput): Promise<string>;
     /**
      * Creates a gift card with provided data given that the data is validated.
-     * @param {GiftCard} giftCard - the gift card data to create
-     * @return {Promise<GiftCard>} the result of the create operation
+     * @param giftCard - the gift card data to create
+     * @return the result of the create operation
      */
-    create(giftCard: GiftCard): Promise<GiftCard>;
+    create(giftCard: CreateGiftCardInput): Promise<GiftCard>;
+    protected retrieve_(selector: Selector<GiftCard>, config?: FindConfig<GiftCard>): Promise<GiftCard>;
     /**
      * Gets a gift card by id.
-     * @param {string} giftCardId - id of gift card to retrieve
-     * @param {object} config - optional values to include with gift card query
-     * @return {Promise<GiftCard>} the gift card
+     * @param giftCardId - id of gift card to retrieve
+     * @param config - optional values to include with gift card query
+     * @return the gift card
      */
-    retrieve(giftCardId: string, config?: object): Promise<GiftCard>;
-    retrieveByCode(code: any, config?: {}): Promise<any>;
+    retrieve(giftCardId: string, config?: FindConfig<GiftCard>): Promise<GiftCard>;
+    retrieveByCode(code: string, config?: FindConfig<GiftCard>): Promise<GiftCard>;
     /**
      * Updates a giftCard.
-     * @param {string} giftCardId - giftCard id of giftCard to update
-     * @param {GiftCard} update - the data to update the giftCard with
-     * @return {Promise} the result of the update operation
+     * @param giftCardId - giftCard id of giftCard to update
+     * @param update - the data to update the giftCard with
+     * @return the result of the update operation
      */
-    update(giftCardId: string, update: GiftCard): Promise<any>;
+    update(giftCardId: string, update: UpdateGiftCardInput): Promise<GiftCard>;
     /**
      * Deletes a gift card idempotently
-     * @param {string} giftCardId - id of gift card to delete
-     * @return {Promise} the result of the delete operation
+     * @param giftCardId - id of gift card to delete
+     * @return the result of the delete operation
      */
-    delete(giftCardId: string): Promise<any>;
+    delete(giftCardId: string): Promise<GiftCard | void>;
 }
+export default GiftCardService;