wallet 1.1.5 → 2.1.505

package/.openapi-generator/FILES

@@ -11,6 +11,7 @@ api/countriesApi.ts
 api/customerApi.ts
 api/dashboardApi.ts
 api/dynamicVouchersApi.ts
+api/employeeAPIKeysApi.ts
 api/employeeAccessApi.ts
 api/employeesApi.ts
 api/industriesApi.ts
@@ -67,8 +68,9 @@ model/duplicateRowFound.ts
 model/dynamicVoucher.ts
 model/dynamicVoucherBroadcast.ts
 model/employee.ts
+model/employeeAPIKey.ts
 model/employeeActivityLog.ts
-model/employeeAlert.ts
+model/entityTooLarge.ts
 model/exportDataFile.ts
 model/falsumError.ts
 model/falsumField.ts
@@ -144,7 +146,6 @@ model/inlineObject65.ts
 model/inlineObject66.ts
 model/inlineObject67.ts
 model/inlineObject68.ts
-model/inlineObject69.ts
 model/inlineObject7.ts
 model/inlineObject8.ts
 model/inlineObject9.ts
@@ -152,6 +153,9 @@ model/inlineResponse200.ts
 model/inlineResponse2001.ts
 model/inlineResponse20010.ts
 model/inlineResponse20011.ts
+model/inlineResponse20012.ts
+model/inlineResponse20013.ts
+model/inlineResponse20014.ts
 model/inlineResponse2002.ts
 model/inlineResponse2003.ts
 model/inlineResponse2004.ts
@@ -193,11 +197,14 @@ model/optInListSubscriber.ts
 model/outboundSMS.ts
 model/paginatedWTMembers.ts
 model/paginatedWTMerchantCredits.ts
+model/paginationRequestWithIDAndWithoutSortOptions.ts
 model/paginationRequestWithSortOptions.ts
 model/paymentDesign.ts
 model/performance.ts
 model/phoneNumber.ts
 model/pickCreateStaticVoucherCampaignWithVoucherExcludeKeyofcreateStaticVoucherCampaignWithVoucherSourceID.ts
+model/pickMSEmployeeAPIKeyCreateParamsExcludeKeyofMSEmployeeAPIKeyCreateParamsEmployeeID.ts
+model/pickMSEmployeeAPIKeyUpdateParamsExcludeKeyofMSEmployeeAPIKeyUpdateParamsId.ts
 model/pickMSMemberCreationParamsExcludeKeyofMSMemberCreationParamsMemberIdentifier.ts
 model/pickMSMemberExcludeKeyofMSMemberMemberIdentifier.ts
 model/pickMSMerchantCreditCreationParamsExcludeKeyofMSMerchantCreditCreationParamsMemberIdentifier.ts
@@ -206,9 +213,11 @@ model/pickPaginationRequestWithoutSortOptionsExcludeKeyofPaginationRequestWithou
 model/pickSSImportedListUpdateParamsExcludeKeyofSSImportedListUpdateParamsId.ts
 model/pickSSMobileNumberUpdateParamsExcludeKeyofSSMobileNumberUpdateParamsId.ts
 model/pickSSOptInListCreateParamsExcludeKeyofSSOptInListCreateParamsEmployeeID.ts
+model/pickSSOptInListMemberCreateParamsExcludeKeyofSSOptInListMemberCreateParamsMerchantCreatedAtOrMaxSMSCount.ts
 model/pickSSOptInListUpdateParamsExcludeKeyofSSOptInListUpdateParamsId.ts
 model/pickSSOptInSourceUpdateParamsExcludeKeyofSSOptInSourceUpdateParamsId.ts
 model/pickSSOutboundMessageLogExcludeKeyofSSOutboundMessageLogToCellPhone.ts
+model/pickVSAdvertisementCreditCreateParamsExcludeKeyofVSAdvertisementCreditCreateParamsEmployeeID.ts
 model/pickVSAdvertisementCreditScanExcludeKeyofVSAdvertisementCreditScanRedeemedAtOrRefundedAt.ts
 model/pickVSAdvertisementCreditUpdateParamsExcludeKeyofVSAdvertisementCreditUpdateParamsId.ts
 model/pickVSCampaignUpdateParamsExcludeKeyofVSCampaignUpdateParamsStartDateOrExpirationDate.ts
@@ -216,7 +225,6 @@ model/pickVSDynamicVoucherExcludeKeyofVSDynamicVoucherTemporalDecreaseFrequencyT
 model/pickVSPaymentDesignCreateParamsExcludeKeyofVSPaymentDesignCreateParamsBackgroundImageURLOrCompanyLogoURLOrEmployeeID.ts
 model/pickVSPaymentDesignUpdateParamsExcludeKeyofVSPaymentDesignUpdateParamsId.ts
 model/pickVSStaticVoucherExcludeKeyofVSStaticVoucherRedeemedAtOrRefundedAtOrLastViewedAt.ts
-model/pickWTAdvertisementCreditCreateParamsExcludeKeyofWTAdvertisementCreditCreateParamsEmployeeID.ts
 model/pickWTEmployeeCreateExcludeKeyofWTEmployeeCreateEmail.ts
 model/pickWTMemberMemberIDOrFirstNameOrLastNameOrMembershipTierIDOrPointsAccruedOrMobileNumber.ts
 model/pickWTMerchantCreditMemberIDOrCreditAmountOrMobileNumber.ts
@@ -236,6 +244,7 @@ model/request.ts
 model/response.ts
 model/role.ts
 model/roleAuditLog.ts
+model/sSImportedListRecipientCreateParams.ts
 model/sSOptInSource.ts
 model/simpleSMSBroadcast.ts
 model/staticVoucher.ts
@@ -257,6 +266,7 @@ model/vSCampaignGeneratedMessage.ts
 model/vSCampaignGeneratedMessagePagination.ts
 model/vSDynamicVoucherStatus.ts
 model/wTAdvertisementCredit.ts
+model/wTAdvertisementCreditCreateParams.ts
 model/wTAdvertisementCreditScan.ts
 model/wTAdvertisementCreditUpdateParams.ts
 model/wTDynamicVoucher.ts
@@ -265,7 +275,11 @@ model/wTDynamicVoucherRedemption.ts
 model/wTDynamicVoucherSummary.ts
 model/wTDynamicVoucherUpdateParams.ts
 model/wTEmployee.ts
+model/wTEmployeeAPIKey.ts
+model/wTEmployeeAPIKeyCreateParams.ts
+model/wTEmployeeAPIKeyUpdateParams.ts
 model/wTEmployeeCreate.ts
+model/wTEmployeeNotification.ts
 model/wTEmployeeUpdate.ts
 model/wTImportedList.ts
 model/wTLinkBookCreateParams.ts
@@ -303,6 +317,7 @@ model/wTStaticVoucherCreateParams.ts
 model/wTStaticVoucherUpdateParams.ts
 model/wTWalletPageView.ts
 model/wTWalletPageViewGeoPoint.ts
+model/walletConfiguration.ts
 model/walletPageView.ts
 model/webpage.ts
 package.json

package/README.md

@@ -1,7 +1,7 @@
 
 ![Wallet Inc](https://resources.wallet.inc/logos/wallet-350x96.png)
 
-> Access to this module is presently restricted to customers of Wallet Inc.
+> Access to this module is presently restricted to customers of Wallet Inc. Reach out on [Discord](https://discord.gg/xzwhcNCjcQ) for help.
 
 ## Summary
 
@@ -13,6 +13,13 @@ This module provides a server-side SDK for integrating with the CRM & Digital Pa
 npm install wallet
 ```
 
+## To test examples
+
+```bash
+cd examples
+npm install # Install ts-node to run typescript examples without transpilation
+```
+
 ## Usage
 
 
@@ -20,9 +27,12 @@ npm install wallet
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+membershipTiers();
 
 async function membershipTiers() {
-    let tiersClient = new api.MembershipTiersApi();
+    let tiersClient = new api.MembershipTiersApi(constants.domain);
 
     // Create new membership tier
     let tier = await tiersClient.createMembershipTier({
@@ -31,7 +41,7 @@ async function membershipTiers() {
         tierDiscount: 20,
         tierDesignID: "JSUilOPE98",
         pointsDesignID: "L918AJ7356"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -43,14 +53,14 @@ async function membershipTiers() {
     tier = await tiersClient.updateMembershipTier(tier.id, {
         ...tier,
         tierName: "SILVER"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the membership tier
-    tier = await tiersClient.archiveMembershipTier(tier.id)
+    tier = await tiersClient.archiveMembershipTier(tier.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -60,7 +70,7 @@ async function membershipTiers() {
     console.log(tier.isActive); // This will be false, since the tier has just been archived
 
     // Restore the membership tier
-    tier = await tiersClient.restoreMembershipTier(tier.id)
+    tier = await tiersClient.restoreMembershipTier(tier.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -75,6 +85,9 @@ async function membershipTiers() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+paymentDesigns();
 
 async function paymentDesigns() {
     let designClient = new api.PaymentDesignsApi();
@@ -92,7 +105,7 @@ async function paymentDesigns() {
         icon: "fa-anchor",
         designName: "Thanksgiving Design",
         displayName: "Decorator",
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -106,14 +119,14 @@ async function paymentDesigns() {
         ...design,
         borderColor: "#050505",
         borderSize: "6px",
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the payment design
-    design = await designClient.archivePaymentDesign(design.id)
+    design = await designClient.archivePaymentDesign(design.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -123,7 +136,7 @@ async function paymentDesigns() {
     console.log(design.isActive); // This will be false, since the design has just been archived
 
     // Restore the payment design
-    design = await designClient.restorePaymentDesign(design.id)
+    design = await designClient.restorePaymentDesign(design.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -137,9 +150,12 @@ async function paymentDesigns() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+clubMembers();
 
 async function clubMembers() {
-    let membersClient = new api.ClubMembersPointsApi();
+    let membersClient = new api.ClubMembersPointsApi(constants.domain);
 
     // Create new club member
     let member = await membersClient.createMember({
@@ -149,7 +165,7 @@ async function clubMembers() {
         mobileNumber: "+1807654543",
         pointsAccrued: 2000,
         memberID: "MEM001"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -161,14 +177,14 @@ async function clubMembers() {
     member = await membersClient.updateMember(member.id, {
         ...member,
         mobileNumber: "+1809863542"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the club member
-    member = await membersClient.archiveMember(member.id)
+    member = await membersClient.archiveMember(member.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -178,7 +194,7 @@ async function clubMembers() {
     console.log(member.isActive); // This will be false, since the member has just been archived
 
     // Restore the club member
-    member = await membersClient.restoreMember(member.id)
+    member = await membersClient.restoreMember(member.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -193,18 +209,23 @@ async function clubMembers() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+advertisementCredits();
 
 async function advertisementCredits() {
-    let client = new api.AdvertisementCreditsApi();
+    let client = new api.AdvertisementCreditsApi(constants.domain);
+
+    let title = "Ad Credit API Client (New Headers)";
 
     // Create a new advertisement credit
     let adCredit = await client.createAdvertisementCredit({
-        title: "Ad Credit",
+        title: title,
         valueType: "percent",
-        paymentDesignID: "HUdjo93KL",
+        paymentDesignID: "jbkVgPTgoo",
         maxUses: 5,
-        discountValue: 5,
-    }).catch(err => {
+        discountValue: 500,
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -215,16 +236,19 @@ async function advertisementCredits() {
 
     // Update the advertisement credit with a new maxUses count
     adCredit = await client.updateAdvertisementCredit(adCredit.id, {
-        ...adCredit,
+        title: `${title} Update`,
+        valueType: "percent",
+        paymentDesignID: "jbkVgPTgoo",
         maxUses: 10,
-    }).catch(err => {
+        discountValue: 1000,
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the advertisement credit
-    adCredit = await client.archiveAdvertisementCredit(adCredit.id)
+    adCredit = await client.archiveAdvertisementCredit(adCredit.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -234,7 +258,7 @@ async function advertisementCredits() {
     console.log(adCredit.isActive); // This will be false, since the advertisement credit has just been archived
 
     // Restore the advertisement credit
-    adCredit = await client.restoreAdvertisementCredit(adCredit.id)
+    adCredit = await client.restoreAdvertisementCredit(adCredit.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -249,9 +273,12 @@ async function advertisementCredits() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+linkBook();
 
 async function linkBook() {
-    let client = new api.LinkBookApi();
+    let client = new api.LinkBookApi(constants.domain);
 
     // Create a new link book link
     let link = await client.createLinkBook({
@@ -260,7 +287,7 @@ async function linkBook() {
         icon: "fa-clock",
         orderNumber: 1,
         linkBookSectionID: "",
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -273,14 +300,14 @@ async function linkBook() {
     link = await client.updateLinkBook(link.id, {
         ...link,
         url: "https://test.com"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the link book link
-    link = await client.archiveLinkBook(link.id)
+    link = await client.archiveLinkBook(link.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -290,7 +317,7 @@ async function linkBook() {
     console.log(link.isActive); // This will be false, since the link book link has just been archived
 
     // Restore the link book link
-    link = await client.restoreLinkBook(link.id)
+    link = await client.restoreLinkBook(link.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -305,15 +332,18 @@ async function linkBook() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+merchantURLs();
 
 async function merchantURLs() {
-    let client = new api.MerchantURLsApi();
+    let client = new api.MerchantURLsApi(constants.domain);
 
     // Create a new merchant URL
     let url = await client.createMerchantURL({
         nickname: "Instagram",
         destinationURL: "https://instagram.com/merchant"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -326,14 +356,14 @@ async function merchantURLs() {
     url = await client.updateMerchantURL(url.id, {
         ...url,
         destinationURL: "https://instagram.com/redirect/merchant"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the merchant URL
-    url = await client.archiveMerchantURL(url.id)
+    url = await client.archiveMerchantURL(url.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -343,7 +373,7 @@ async function merchantURLs() {
     console.log(url.isActive); // This will be false, since the merchant URL has just been archived
 
     // Restore the merchant URL
-    url = await client.restoreMerchantURL(url.id)
+    url = await client.restoreMerchantURL(url.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -358,9 +388,12 @@ async function merchantURLs() {
 
 ```nodejs
 import * as api from "../api";
+import * as constants from "./constants";
+
+news();
 
 async function news() {
-    let client = new api.NewsApi();
+    let client = new api.NewsApi(constants.domain);
 
     // Create a new news article
     let article = await client.createNewsArticle({
@@ -369,7 +402,7 @@ async function news() {
         body: "This is a news article related to the merchant",
         url: "https://blog.merchant.com",
         mediaURL: "https://example.com/image"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
@@ -383,14 +416,14 @@ async function news() {
     article = await client.updateNewsArticle(article.id, {
         ...article,
         title: "News Article Updated"
-    }).catch(err => {
+    }, constants.headers).catch(err => {
         throw err;
     }).then(resp => {
         return resp.body
     });
 
     // Archive the news article
-    article = await client.archiveNewsArticle(article.id)
+    article = await client.archiveNewsArticle(article.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -400,7 +433,7 @@ async function news() {
     console.log(article.isActive); // This will be false, since the news article has just been archived
 
     // Restore the news article
-    article = await client.restoreNewsArticle(article.id)
+    article = await client.restoreNewsArticle(article.id, constants.headers)
         .catch(err => {
             throw err;
         }).then(resp => {
@@ -410,4 +443,185 @@ async function news() {
     console.log(article.isActive); // This will be true, since the news article has just been restored
 }
 ```
+    
+### Create and manipulate Performances
+
+```nodejs
+import * as api from "../api";
+import * as constants from "./constants";
+
+performances();
+
+async function performances() {
+    let client = new api.PerformancesApi(constants.domain);
+
+    // Create a new performance
+    let performance = await client.createPerformance({
+        title: "Performance",
+        body: "Details related to the performance",
+        startDateTime: new Date(),
+        price: 200,
+        url: "https://blog.merchant.com",
+        orderNumber: 1,
+        mediaURL: "https://example.com/image"
+
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+
+    // The performance that has just been created
+    console.log(performance);
+
+    // Update the performance with a new title
+    performance = await client.updatePerformance(performance.id, {
+        ...performance,
+        title: "performance Updated"
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the performance
+    performance = await client.archivePerformance(performance.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(performance.isActive); // This will be false, since the performance has just been archived
+
+    // Restore the performance
+    performance = await client.restorePerformance(performance.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(performance.isActive); // This will be true, since the performance has just been restored
+}
+```
+    
+### Create and manipulate Promo Codes
+
+```nodejs
+import * as api from "../api";
+import * as constants from "./constants";
+
+promocodes();
+
+async function promocodes() {
+    let client = new api.PromoCodesApi();
+
+    // Create a new promocode
+    let promocode = await client.createPromoCode({
+        title: "Promo Code",
+        description: "Description about Promo Code",
+        promoCode: "MON50OFF",
+        displayValue: "50OFF",
+        orderNumber: 1,
+        startDate: new Date(),
+        expirationDate: new Date(new Date().getTime() + (5 * 24 * 60 * 60 * 1000))
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The promocode that has just been created
+    console.log(promocode);
+
+    // Update the promocode with a new title
+    promocode = await client.updatePromoCode(promocode.id, {
+        ...promocode,
+        title: "promocode Updated"
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the promocode
+    promocode = await client.archivePromoCode(promocode.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(promocode.isActive); // This will be false, since the promocode has just been archived
+
+    // Restore the promocode
+    promocode = await client.restorePromoCode(promocode.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(promocode.isActive); // This will be true, since the promocode has just been restored
+}
+```
+    
+### Create and manipulate Merchant Credits
+
+```nodejs
+import * as api from "../api";
+import * as constants from "./constants";
+
+merchantCredits();
+
+async function merchantCredits() {
+    let client = new api.MerchantCreditsApi();
+
+    // Create a new merchant credit
+    let merchantcredit = await client.createMerchantCredit({
+        mobileNumber: "+1808978789",
+        creditAmount: 2000, // In cents
+        memberID: "MEM001"
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The merchant credit that has just been created
+    console.log(merchantcredit);
+
+    // Update the merchant credit with a new title
+    merchantcredit = await client.updateMerchantCredit(merchantcredit.id, {
+        ...merchantcredit,
+        creditAmount: 1000, // In cents
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the merchant credit
+    merchantcredit = await client.archiveMerchantCredit(merchantcredit.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(merchantcredit.isActive); // This will be false, since the merchant credit has just been archived
+
+    // Restore the merchant credit
+    merchantcredit = await client.restoreMerchantCredit(merchantcredit.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(merchantcredit.isActive); // This will be true, since the merchant credit has just been restored
+}
+```