wallet 0.1.220005 → 1.1.3

package/README.md

@@ -0,0 +1,401 @@
+
+# TypeScript Client for accessing Wallet API
+
+## Usage
+
+
+### Create and manipulate Membership Tiers
+
+```nodejs
+import * as api from "../api";
+
+async function membershipTiers() {
+    let tiersClient = new api.MembershipTiersApi();
+
+    // Create new membership tier
+    let tier = await tiersClient.createMembershipTier({
+        tierNumber: "1",
+        tierName: "GOLD",
+        tierDiscount: 20,
+        tierDesignID: "JSUilOPE98",
+        pointsDesignID: "L918AJ7356"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The membership tier that has just been created
+    console.log(tier);
+
+    tier = await tiersClient.updateMembershipTier(tier.id, {
+        ...tier,
+        tierName: "SILVER"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the membership tier
+    tier = await tiersClient.archiveMembershipTier(tier.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(tier.isActive); // This will be true, since the tier has just been restored
+}
+```
+    
+### Create and manipulate Payment Designs
+
+```nodejs
+import * as api from "../api";
+
+async function paymentDesigns() {
+    let designClient = new api.PaymentDesignsApi();
+
+    // Create a new payment design
+    let design = await designClient.createPaymentDesign({
+        borderColor: "#f0f0f0",
+        borderStyleType: "Dashed",
+        borderSize: "4px",
+        borderRadius: 2,
+        fontColor: "#777777",
+        fontType: "Arial",
+        abbreviation: "ABBR",
+        acronym: "AR",
+        icon: "fa-anchor",
+        designName: "Thanksgiving Design",
+        displayName: "Decorator",
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The payment design that has just been created
+    console.log(design);
+
+    // Change the borderColor and borderSize of the payment design
+    design = await designClient.updatePaymentDesign(design.id, {
+        ...design,
+        borderColor: "#050505",
+        borderSize: "6px",
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the payment design
+    design = await designClient.archivePaymentDesign(design.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+    
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+    console.log(design.isActive); // This will be true, since the design has just been restored
+}
+```
+    
+### Create and manipulate Club Members
+
+```nodejs
+import * as api from "../api";
+
+async function clubMembers() {
+    let membersClient = new api.ClubMembersPointsApi();
+
+    // Create new club member
+    let member = await membersClient.createMember({
+        firstName: "John",
+        lastName: "Doe",
+        membershipTierID: "HDywI893LQ",
+        mobileNumber: "+1807654543",
+        pointsAccrued: 2000,
+        memberID: "MEM001"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The club member that has just been created
+    console.log(member);
+
+    member = await membersClient.updateMember(member.id, {
+        ...member,
+        mobileNumber: "+1809863542"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the club member
+    member = await membersClient.archiveMember(member.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(member.isActive); // This will be true, since the member has just been restored
+}
+```
+    
+### Create and manipulate Advertisement Credits
+
+```nodejs
+import * as api from "../api";
+
+async function advertisementCredits() {
+    let client = new api.AdvertisementCreditsApi();
+
+    // Create a new advertisement credit
+    let adCredit = await client.createAdvertisementCredit({
+        title: "Ad Credit",
+        valueType: "percent",
+        paymentDesignID: "HUdjo93KL",
+        maxUses: 5,
+        discountValue: 5,
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The advertisement credit that has just been created
+    console.log(adCredit);
+
+    // Update the advertisement credit with a new maxUses count
+    adCredit = await client.updateAdvertisementCredit(adCredit.id, {
+        ...adCredit,
+        maxUses: 10,
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the advertisement credit
+    adCredit = await client.archiveAdvertisementCredit(adCredit.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(adCredit.isActive); // This will be true, since the advertisement credit has just been restored
+}
+```
+    
+### Create and manipulate Link Book Links
+
+```nodejs
+import * as api from "../api";
+
+async function linkBook() {
+    let client = new api.LinkBookApi();
+
+    // Create a new link book link
+    let link = await client.createLinkBook({
+        title: "External Link",
+        url: "https://example.com",
+        icon: "fa-clock",
+        orderNumber: 1,
+        linkBookSectionID: "",
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The link book link that has just been created
+    console.log(link);
+
+    // Update the link book link with a new url
+    link = await client.updateLinkBook(link.id, {
+        ...link,
+        url: "https://test.com"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the link book link
+    link = await client.archiveLinkBook(link.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(link.isActive); // This will be true, since the link book link has just been restored
+}
+```
+    
+### Create and manipulate Merchant URLs
+
+```nodejs
+import * as api from "../api";
+
+async function merchantURLs() {
+    let client = new api.MerchantURLsApi();
+
+    // Create a new merchant URL
+    let url = await client.createMerchantURL({
+        nickname: "Instagram",
+        destinationURL: "https://instagram.com/merchant"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The merchant URL that has just been created
+    console.log(url);
+
+    // Update the merchant URL with a new destination URL
+    url = await client.updateMerchantURL(url.id, {
+        ...url,
+        destinationURL: "https://instagram.com/redirect/merchant"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the merchant URL
+    url = await client.archiveMerchantURL(url.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(url.isActive); // This will be true, since the merchant URL has just been restored
+}
+```
+    
+### Create and manipulate News Articles
+
+```nodejs
+import * as api from "../api";
+
+async function news() {
+    let client = new api.NewsApi();
+
+    // Create a new news article
+    let article = await client.createNewsArticle({
+        title: "News Article",
+        orderNumber: 1,
+        body: "This is a news article related to the merchant",
+        url: "https://blog.merchant.com",
+        mediaURL: "https://example.com/image"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+
+    // The news article that has just been created
+    console.log(article);
+
+    // Update the news article with a new title
+    article = await client.updateNewsArticle(article.id, {
+        ...article,
+        title: "News Article Updated"
+    }).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the news article
+    article = await client.archiveNewsArticle(article.id)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    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)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(article.isActive); // This will be true, since the news article has just been restored
+}
+```
+