added descriptions to all NFT methods and renamed two of them

Author: Ekimoth

index.d.ts

@@ -956,9 +956,9 @@ export interface GetExchangeRatesResponse {
   rates: ExchangeRate[];
 }
 
-export type GetMyNFTsResponse = GetMerchantNFTListResponse;
+export type GetUserBoughtNFTsResponse = GetMerchantNFTListResponse;
 
-export interface MakeNFTReservationResponse {
+export interface MakeReservationResponse {
   created_at: number;
   updated_at: number;
   description: string;
@@ -984,8 +984,8 @@ export declare class NFTs {
     Promise<AxiosResponse<GetMerchantNFTListResponse>>;
   getMerchantNFT(merchantUuid: string, nftId: number): Promise<AxiosResponse<GetMerchantNFTResponse>>;
   getExchangeRates(fiat: string, invert?: boolean): Promise<AxiosResponse<GetExchangeRatesResponse>>;
-  getMyNFTs(page?: number, size?: number): Promise<AxiosResponse<GetMyNFTsResponse>>;
-  makeNFTReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>>;
+  getUserBoughtNFTs(page?: number, size?: number): Promise<AxiosResponse<GetUserBoughtNFTsResponse>>;
+  makeReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeReservationResponse>>;
 }
 
 export interface ApiEndpoints {
@@ -1052,8 +1052,8 @@ export interface ApiEndpoints {
   getMerchantNFTList: (merchantUuid: string, page: number, size: number, filter: string) => string;
   getMerchantNFT: (merchantUuid: string, nftId: number) => string;
   getExchangeRates: (fiat: string, invert: boolean) => string;
-  getMyNFTs: (page: number, size: number) => string;
-  makeNFTReservation: (merchantUuid: string, nftId: number) => string;
+  getUserBoughtNFTs: (page: number, size: number) => string;
+  makeReservation: (merchantUuid: string, nftId: number) => string;
 }
 
 export interface ApiConfig {

src/constants/index.ts

@@ -115,6 +115,6 @@ export const API = {
   getMerchantNFT: (merchantUuid: string, nftId: number): string => `/v2/nfts/${merchantUuid}/${nftId}`,
   getExchangeRates: (fiat: string, invert: boolean): string =>
     `/v2/nfts/exchange-rate/${fiat}${invert ? '?invert=true' : ''}`,
-  getMyNFTs: (page: number, size: number): string => `/v2/nfts?page=${page}&size=${size}`,
-  makeNFTReservation: (merchantUuid: string, nftId: number): string => `/v2/nfts/${merchantUuid}/${nftId}/reserve`,
+  getUserBoughtNFTs: (page: number, size: number): string => `/v2/nfts?page=${page}&size=${size}`,
+  makeReservation: (merchantUuid: string, nftId: number): string => `/v2/nfts/${merchantUuid}/${nftId}/reserve`,
 };

src/endpoints/nfts.ts

@@ -21,10 +21,28 @@ class NFTs extends BaseExtend {
     super(config, request);
   }
 
+  /**
+   * Returns a merchant's Marketplace data if there is one
+   * @method getMerchantMarketplace
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @returns Promise<AxiosResponse<GetMerchantMarketplaceResponse>>
+   */
   async getMerchantMarketplace(merchantUuid: string): Promise<AxiosResponse<GetMerchantMarketplaceResponse>> {
     return this.request.get(API.getMerchantMarketplace(merchantUuid));
   }
 
+  /**
+   * Returns a list of NFT items sold by a merchant
+   * @method getMerchantNFTList
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} page The current page number.
+   * If it is not set the starting page will be returned. Defaults to 1
+   * @param {number} size The maximum mumber of items returned in the response. Defaults to 50
+   * @param {string} filter Parameter by which the returned items in the list to be filtered. Defaults to "published"
+   * @returns Promise<AxiosResponse<GetMerchantNFTListResponse>>
+   */
   async getMerchantNFTList(
     merchantUuid: string,
     page = 1,
@@ -34,28 +52,59 @@ class NFTs extends BaseExtend {
     return this.request.get(API.getMerchantNFTList(merchantUuid, page, size, filter));
   }
 
+  /**
+   * Returns a specific NFT item sold by a merchant
+   * @method getMerchantNFT
+   * @async
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} nftId The unique NFT identifier
+   * @returns Promise<AxiosResponse<GetMerchantNFTResponse>>
+   */
   async getMerchantNFT(merchantUuid: string, nftId: number): Promise<AxiosResponse<GetMerchantNFTResponse>> {
     return this.request.get(API.getMerchantNFT(merchantUuid, nftId));
   }
 
+  /**
+   * Returns exchange rates of a specific FIAT currency in respect to a list crypto currencies
+   * @method getExchangeRates
+   * @param {string} fiat The FIAT currency
+   * @param {boolean} invert Whether the returned rates to be in their inverted exchange rates
+   * @returns Promise<AxiosResponse<GetExchangeRatesResponse>>
+   */
   async getExchangeRates(fiat: string, invert = false): Promise<AxiosResponse<GetExchangeRatesResponse>> {
     return this.request.get(API.getExchangeRates(fiat, invert));
   }
 
-  async getMyNFTs(page = 1, size = 50): Promise<AxiosResponse<GetMyNFTsResponse>> {
+  /**
+   * Returns a list of NFTs bought and owned by an authenticated user
+   * @method getUserBoughtNFTs
+   * @param {number} page The current page number.
+   * If it is not set the starting page will be returned. Defaults to 1
+   * @param {number} size The maximum mumber of items returned in the response. Defaults to 50
+   * @returns Promise<AxiosResponse<GetMyNFTsResponse>>
+   */
+  async getUserBoughtNFTs(page = 1, size = 50): Promise<AxiosResponse<GetMyNFTsResponse>> {
     const tokenObject = await this.request.getToken();
 
-    return this.request.authenticatedGet(API.getMyNFTs(page, size), {
+    return this.request.authenticatedGet(API.getUserBoughtNFTs(page, size), {
       headers: {
         Authorization: `Bearer ${tokenObject.token}`,
       },
     });
   }
 
-  async makeNFTReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>> {
+  /**
+   * Makes a reservation request for a specific NFT and returns the relevant data when
+   * that reservation is completed successfully
+   * @method makeReservation
+   * @param {string} merchantUuid The Merchant's unique universal identifier (Merchant UUID).
+   * @param {number} nftId The unique NFT identifier
+   * @returns Promise<AxiosResponse<MakeNFTReservationResponse>>
+   */
+  async makeReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>> {
     const tokenObject = await this.request.getToken();
 
-    return this.request.authenticatedPost(API.makeNFTReservation(merchantUuid, nftId), {
+    return this.request.authenticatedPost(API.makeReservation(merchantUuid, nftId), {
       headers: {
         Authorization: `Bearer ${tokenObject.token}`,
       },

src/models/INFTs.ts

@@ -93,6 +93,6 @@ export interface NFTs extends BaseExtend {
     Promise<AxiosResponse<GetMerchantNFTListResponse>>;
   getMerchantNFT(merchantUuid: string, nftId: number): Promise<AxiosResponse<GetMerchantNFTResponse>>;
   getExchangeRates(fiat: string, invert?: boolean): Promise<AxiosResponse<GetExchangeRatesResponse>>;
-  getMyNFTs(page?: number, size?: number): Promise<AxiosResponse<GetMyNFTsResponse>>;
-  makeNFTReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>>;
+  getUserBoughtNFTs(page?: number, size?: number): Promise<AxiosResponse<GetMyNFTsResponse>>;
+  makeReservation(merchantUuid: string, nftId: number): Promise<AxiosResponse<MakeNFTReservationResponse>>;
 }