wallet 2.1.507 → 2.1.508

package/examples/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "examples",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node": "^10.8.0"
+  },
+  "dependencies": {
+    "wallet": "^2.1.507"
+  }
+}

package/examples/paymentdesigns.example.ts

@@ -1,10 +1,10 @@
-import * as api from "../api";
+import * as api from "wallet";
 import * as constants from "./constants";
 
 paymentDesigns();
 
 async function paymentDesigns() {
-    let designClient = new api.PaymentDesignsApi();
+    let designClient = new api.PaymentDesignsApi(constants.domain);
 
     // Create a new payment design
     let design = await designClient.createPaymentDesign({
@@ -28,6 +28,10 @@ async function paymentDesigns() {
     // The payment design that has just been created
     console.log(design);
 
+    // Fetch the created design
+    design = (await designClient.fetchPaymentDesignById(design.id, constants.headers)).body;
+    console.log(design);
+
     // Change the borderColor and borderSize of the payment design
     design = await designClient.updatePaymentDesign(design.id, {
         ...design,
@@ -46,7 +50,7 @@ async function paymentDesigns() {
         }).then(resp => {
             return resp.body
         });
-    
+
     console.log(design.isActive); // This will be false, since the design has just been archived
 
     // Restore the payment design
@@ -57,4 +61,8 @@ async function paymentDesigns() {
             return resp.body
         });
     console.log(design.isActive); // This will be true, since the design has just been restored
+
+    // Fetch all payment designs
+    let designs = (await designClient.fetchAllPaymentDesigns(false, constants.headers)).body;
+    console.log(designs);
 }

package/examples/performances.example.ts

@@ -1,4 +1,4 @@
-import * as api from "../api";
+import * as api from "wallet";
 import * as constants from "./constants";
 
 performances();
@@ -14,7 +14,8 @@ async function performances() {
         price: 200,
         url: "https://blog.merchant.com",
         orderNumber: 1,
-        mediaURL: "https://example.com/image"
+        mediaURL: "https://example.com/image",
+        isSoldOut: false,
 
     }, constants.headers).catch(err => {
         throw err;
@@ -55,4 +56,8 @@ async function performances() {
         });
 
     console.log(performance.isActive); // This will be true, since the performance has just been restored
+
+    // Fetch all performances
+    let performances = (await client.fetchAllPerformances(false, constants.headers)).body;
+    console.log(performances);
 }

package/examples/promocodes.example.ts

@@ -1,10 +1,10 @@
-import * as api from "../api";
+import * as api from "wallet";
 import * as constants from "./constants";
 
 promocodes();
 
 async function promocodes() {
-    let client = new api.PromoCodesApi();
+    let client = new api.PromoCodesApi(constants.domain);
 
     // Create a new promocode
     let promocode = await client.createPromoCode({
@@ -53,4 +53,8 @@ async function promocodes() {
         });
 
     console.log(promocode.isActive); // This will be true, since the promocode has just been restored
+
+    // Fetch all promocodes
+    let promocodes = (await client.fetchAllPromoCodes(false, constants.headers)).body;
+    console.log(promocodes);
 }

package/examples/sms.example.ts

@@ -0,0 +1,305 @@
+import * as api from "wallet";
+import * as constants from "./constants";
+
+smsExample();
+
+async function smsExample() {
+    let client = new api.SMSApi(constants.domain);
+
+    // Acquire phone number
+    let phoneNumber = await client.acquirePhoneNumber({
+        phoneNumber: "+1807675656"
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(phoneNumber);
+
+    // Send phone number for verification
+    await client.sendPhoneNumberForVerification(phoneNumber.id, {
+        helpDeskQueueResponse: "HELPME",
+        helpDeskKeyword: "HELP12",
+        helpResponse: "Hello, we're here to help.",
+        stopResponse: "We're sad to see you go",
+        messageFooter: "Subscribe for more info!",
+        termsOfServiceURL: "https://example.com/terms-of-service",
+        privacyPolicyURL: "https://example.com/privacy-policy",
+        companyName: "Fictitious Corporation"
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    // Archive phone number
+    phoneNumber = await client.archivePhoneNumber(phoneNumber.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(phoneNumber.isActive); // This will be false
+
+    // Restore phone number
+    phoneNumber = await client.restorePhoneNumber(phoneNumber.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(phoneNumber.isActive); // This will be true
+
+    // Create SMS agreement
+    let agreement = await client.createSMSAgreement({
+        isShortCodeTimelineUnderstood: true,
+        isPricingUnderstood: true,
+        isShortCodeTransferUnderstood: true,
+        isOptInOutUnderstood: true,
+        isShortCodeUnderstood: true,
+        isStandardsUnderstood: true,
+        isCtiaShortCodeRead: true,
+        isManualRead: true,
+        isStopUnderstood: true,
+        isTosOnWebsite: true,
+        isPrivacyPolicyOnWebsite: true,
+        isTwilioTermsRead: true,
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(agreement);
+
+    // Fetch the agreement
+    agreement = await client.fetchSMSAgreement(constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(agreement);
+
+    // Create imported list
+    let importedList = await client.createImportedList({
+        listName: "Imported List",
+        isActive: true,
+        phoneNumberID: phoneNumber.id
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(importedList);
+
+
+    // Create recipient in imported list
+    let recipient = await client.createRecipientInImportedList({
+        importedListID: importedList.id,
+        mobilePhoneNumber: "+1805654545"
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(recipient);
+
+    // Count recipients in imported list
+    let { count } = await client.countImportedListRecipients(importedList.id, false, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(count);
+
+    // Fetch recipients
+    let importedListRecipients = await client.fetchImportedListRecipients(importedList.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(importedListRecipients);
+
+    // Fetch recipients by page
+    let importedListRecipientByPage = await client.fetchImportedListRecipientsByPage(importedList.id, 10, 1, false, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(`Total: ${importedListRecipientByPage.total}, Length: ${importedListRecipientByPage.length}, List: ${JSON.stringify(importedListRecipientByPage.results)}`);
+
+    // Export recipients
+    await client.exportImportedListRecipients(importedList.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    // Create opt in list
+    let optInList = await client.createOptInList({
+        isActive: true,
+        listName: "Opt In List",
+        phoneNumberID: phoneNumber.id,
+        estimatedMessagesPerMonth: 250,
+        optInKeyword: "OPTIN",
+        optOutKeyword: "OPTOUT",
+        optInConfirmedResponse: "You've opted in",
+        optOutConfirmedResponse: "You've opted out",
+        optInConfirmedCustomerReceives: "You've opted in",
+        optOutConfirmedCustomerReceives: "You've opted out",
+        isOver21Required: false,
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(optInList);
+
+    // Count opt in list subscribers
+    count = await client.countOptInListSubscribers(optInList.id, true, false, false, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return (resp.body).count;
+        });
+
+    console.log(count);
+
+    // Export opt in list subscribers
+    await client.exportOptInListSubscribers(optInList.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    // Fetch subscribers
+    let optInListRecipients = await client.fetchOptInListSubscribers(optInList.id, true, false, false, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(optInListRecipients);
+
+    // Fetch subscribers by page
+    let optInListRecipientByPage = await client.fetchOptInListSubscribersByPage(optInList.id, 10, 1, true, false, false, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(`Total: ${optInListRecipientByPage.total}, Length: ${optInListRecipientByPage.length}, List: ${JSON.stringify(optInListRecipientByPage.results)}`);
+
+    // Fetch all opt in lists associated with the given phone number
+
+    let optInListsAssociatedWithPhoneNumber = await client.fetchOptInListsAssociatedWithPhoneNumber(phoneNumber.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(optInListsAssociatedWithPhoneNumber);
+
+    // Create opt in source
+    let optInSource = await client.createOptInListSource({
+        sourceName: "Opt In Source",
+        listID: optInList.id,
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+    console.log(optInSource);
+
+
+    // Count subscribers in opt in list source
+    count = await client.countOptInSourceSubscribers(optInSource.id, true, false, false, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return (resp.body).count;
+        });
+
+    console.log(count);
+
+    let optInSourceSubscribers = await client.fetchOptInSourceSubscribers(optInSource.id, true, false, false, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(optInSourceSubscribers);
+
+    let optInSourcesAssociatedWithPhoneNumber = await client.fetchOptInSourcesAssociatedWithPhoneNumber(phoneNumber.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(optInSourcesAssociatedWithPhoneNumber);
+
+    // Fetch all outbound SMSes
+    let outboundSMSes = await client.fetchOutboundSMS(phoneNumber.id, undefined, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+    console.log(outboundSMSes);
+
+    // Fetch outbound SMSes by page
+    let outboundSMSesByPage = await client.fetchOutboundSMSByPage(phoneNumber.id, undefined, undefined, 10, 1, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+    console.log(`Total: ${outboundSMSesByPage.total}, Length: ${outboundSMSesByPage.length}, Messages: ${JSON.stringify(outboundSMSesByPage.results)}`);
+
+
+    // Count outbound SMSes
+    let outboundSMSesCount = await client.countOutboundSMS(phoneNumber.id, undefined, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return (resp.body).count;
+        });
+    console.log(outboundSMSesCount);
+
+    // Retrieve message limits
+    let limits = await client.retrieveSentAndMaxCountOfMessages(constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+    console.log(`Max: ${limits.max}, Sent: ${limits.sent}`);
+}

package/examples/staticvouchercampaigns.example.ts

@@ -0,0 +1,192 @@
+import * as api from "wallet";
+import * as constants from "./constants";
+
+staticVoucherCampaigns();
+
+async function staticVoucherCampaigns() {
+    let client = new api.StaticVoucherCampaignsApi(constants.domain);
+    // Fetch payment design
+    let designClient = new api.PaymentDesignsApi(constants.domain);
+    let allDesigns = await designClient.fetchAllPaymentDesigns(false, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+    let selectedDesign = allDesigns[0];
+
+    let startDate = new Date();
+    let expiryDate = new Date((new Date()).setDate((new Date()).getDate() + 5));
+
+    let params: api.CreateStaticVoucherCampaign = {
+        startDateTime: startDate,
+        expirationDateTime: expiryDate,
+        title: "Static Voucher Campaign API Client",
+        notes: "Example notes",
+        valueType: "currency", // percent or currency
+        displayValue: "$5 Off",
+        merchantsReferenceID: "",
+        validOnlyAtPOSRegisterIDs: [],
+        paymentDesignID: selectedDesign.id,
+        isActive: true,
+        sourceID: 0,
+    }
+    let campaign = await client.createStaticVoucherCampaign(params, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(campaign);
+
+
+    // Fetch static voucher campaign by ID
+    campaign = await client.fetchStaticVoucherCampaignById(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(campaign);
+
+    // Fetch all the static voucher campaigns
+    let allCampaigns = await client.fetchStaticVoucherCampaigns(false, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(allCampaigns);
+
+    // Fetch all vouchers within a static voucher campaign
+    let allVouchers = await client.fetchStaticVouchers(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(allVouchers);
+
+    // Fetch vouchers within a static voucher campaign by page
+    let allVouchersByPage = await client.fetchStaticVouchersPage(campaign.id, 1, 10, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(allVouchersByPage);
+
+    // Fetch performance overview
+    let performanceOverview = await client.fetchPerformanceOverview(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(performanceOverview);
+
+    // Fetch reach stats of individual static voucher campaign
+    let individualCampaignReachStats = await client.fetchReachStatsOfIndividualStaticVoucherCampaign(campaign.id, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(individualCampaignReachStats);
+
+    // Fetch reach stats of all static voucher campaigns
+    let allStaticVoucherCampaignStats = await client.fetchReachStatsOfAllStaticVoucherCampaigns(undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(allStaticVoucherCampaignStats);
+
+    // Fetch wallet page views of a static voucher campaign
+    let views = await client.fetchViews(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(views);
+
+    // Fetch redeemed vouchers
+    let redeemedVouchers = await client.fetchVouchersRedeemed(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(redeemedVouchers);
+
+    // Duplicate static voucher campaign
+    let duplicatedCampaign = await client.duplicateStaticVoucherCampaignById(campaign.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(duplicatedCampaign);
+
+    // Update static voucher campaign
+    campaign = await client.updateStaticVoucherCampaign(campaign.id, {
+        ...params,
+        title: `${params.title} Updated`
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(campaign);
+
+    // Create static voucher campaign with voucher
+    let campaignWithVoucher = await client.createStaticVoucherCampaignWithVoucher({
+        ...params,
+        cellPhone: "+1809898787",
+        memberID: "MEM0091",
+        offerAmountCents: 1000
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(campaignWithVoucher);
+
+    allVouchers = await client.fetchStaticVouchers(campaignWithVoucher.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    // Update static voucher campaign
+    campaignWithVoucher = await client.updateStaticVoucherCampaignWithVoucher(campaignWithVoucher.id, {
+        ...params,
+        offerAmountCents: 2000,
+        voucherID: allVouchers[0].id
+    }, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+    console.log(campaignWithVoucher);
+}

package/examples/staticvouchers.example.ts

@@ -0,0 +1,67 @@
+import * as api from "wallet";
+import * as constants from "./constants";
+
+staticVouchers();
+
+async function staticVouchers() {
+    let client = new api.StaticVouchersApi(constants.domain);
+
+    let params: api.WTStaticVoucherCreateParams = {
+        offerAmountCents: 1000, // In cents
+        memberID: "MEM0090",
+        cellPhone: "+1809898787",
+        campaignID: "",
+    }
+    // Create a new static voucher
+    let voucher = await client.createStaticVoucher(params, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // The static voucher that has just been created
+    console.log(voucher);
+
+    // Fetch the static voucher that has just been created
+    voucher = (await client.fetchStaticVoucher(voucher.id, constants.headers)).body;
+    console.log(voucher);
+
+    // Update the static voucher with a new maxUses count
+    voucher = await client.updateStaticVoucher(voucher.id, {
+        ...params,
+        offerAmountCents: 2000 // In cents
+    }, constants.headers).catch(err => {
+        throw err;
+    }).then(resp => {
+        return resp.body
+    });
+
+    // Archive the static voucher
+    await client.deleteStaticVoucher(voucher.id, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body
+        });
+
+
+    // Fetch reach stats of individual static voucher
+    let individualVoucherReachStats = await client.fetchReachStatsOfIndividualStaticVoucher(voucher.id, undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(individualVoucherReachStats);
+
+    // Fetch reach stats of all the static vouchers
+    let allVouchersReachStats = await client.fetchReachStatsOfAllStaticVouchers(undefined, undefined, constants.headers)
+        .catch(err => {
+            throw err;
+        }).then(resp => {
+            return resp.body;
+        });
+
+    console.log(allVouchersReachStats);
+}

package/model/advertisementCredit.ts

@@ -2,7 +2,7 @@
  * wallet-api
  * API
  *
- * The version of the OpenAPI document: 2.1.507
+ * The version of the OpenAPI document: 2.1.508
  * Contact: development@wallet.inc
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/model/advertisementCreditBroadcast.ts

@@ -2,7 +2,7 @@
  * wallet-api
  * API
  *
- * The version of the OpenAPI document: 2.1.507
+ * The version of the OpenAPI document: 2.1.508
  * Contact: development@wallet.inc
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/model/advertisementCreditScan.ts

@@ -2,7 +2,7 @@
  * wallet-api
  * API
  *
- * The version of the OpenAPI document: 2.1.507
+ * The version of the OpenAPI document: 2.1.508
  * Contact: development@wallet.inc
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).