ShoppingGives SDK

npm install @shoppinggivesos/impact-sdk

import { CartHandler, Environments } from '@shoppinggivesos/impact-sdk';

const config = {
    storeId: '00000000-0000-0000-0000-000000000000', // Shoppinggives store ID
    environment: Environments.Production, // Shoppinggives store environment for most people 
                                          // you will select Environments.Production here.
                                          // If you receive a Staging store ID from your account manager, 
                                          // use the Environments.Staging value
    testMode: false, // Sets the tracking to be test purchases that do not create a real donation!
    logger: {
        error: (message) => {},
        debug: (message) => {},
        warn: (message) => {},
    }, // Optional: Custom logging implementation, 
       // if you omit this param the SG SDK uses console.log by default.
    persistence: {
        get: (key) => {},
        set: (key, value) => {},
        delete: (key) => {},
    }, // Optional: Custom persistence cache implementation,
       // if you omit this param the SG SDK uses session storage by default.
};

// bootstrap the client
const client = new CartHandler(config);

// register any events if you want to use the event system vs 
// async / awaiting the methods. (more information can be found below)
// events need to be registered before the initialize method is called.
client.on('SDK::Ready', (data) => {
    // handle SDK::Ready event
});

// initialize the client with current cart state
const data = await client.initialize({
    cartTotal: 10, // Current cart total
    lineItems: [], // All current line items in the cart or an empty array if no items are in the cart.
    discount: 0, // The discount applied to the cart if any is set. This is the $ amount 
                 // not the % percentage.
});

const results = await client.search('Happys Porch', 0, 25);

let results = []; 
client
  .search('Homes For Our Troops', 0, 25)
  .then((data) => {
     results = data;
  })
  .catch((error) => {});

client.on('Cause::Updated', (data) => {
    // handle the updating of the selected cause
});

try {
    results = await client.search(searchTerm, 0, 25);
} catch (error) {
    // handle error based on the type property:
    switch (error.type) {
      case "ShoppinggivesApiError":
        // handle error, hide UI or show error state
        break;
      case "ShoppinggivesValidationError"
        // handle validation error
      default:
        break;
    }
}

client.on('SDK::Error', (error) => {
  switch (error.type) {
    case "ShoppinggivesApiError":
      // handle error, hide UI or show error state
      break;
    case "ShoppinggivesValidationError"
      // handle validation error
    default:
      break;
  }
});

export interface ICmsLineItem {
  id: any;
  price: number;
  quantity: number;
  discount: number;
}

export interface IDonationRecipient {
  id: string;
  isPortfolio: boolean;
  donation: number;
  logoUrl: string;
  name: string;
  description: string;
  directDonation: string;
  bannerUrl?: string;
  city?: string;
  state?: string;
  streetAddress?: string;
  zip?: number;
  donationBreakdown?: object; // dictionary
}

export class CauseModel {
  isPortfolio: boolean;
  id: any;
  name: string;
  website: string;
  logoUrl: string;
  streetAddress: string;
  city: string;
  state: string;
  zip: number;
  description: string;
  multiplier?: number;
  categoryId?: number;
  categoryName?: string;
  categoryLogoUrl?: string;
  headline?: string;
  bannerUrl?: string;
  portfolioCharities?: any[];
  default: boolean;
}

export class ActiveCampaignsModel {
  onlinePurchase: boolean;
  yotpoRedemption: boolean;
  roundUpDonation: boolean;
  addOnDonation: boolean;
  pointOfSale: boolean;
  postPurchaseDonation: boolean;
  roundUpPos: boolean;
} 

export class CharityResponseModel {
    id: number;
    name: string;
    website: string;
    logoUrl: string;
    streetAddress: string;
    city: string;
    state: string;
    zip: number;
    description: string;
    categoryId: number;
    categoryName: string;
    categoryLogoUrl: string;
    nteeFullCode: string;
    nteeMainCode: number;
    nteeSubCode: number;
}

Categories = [
    { value: 0, label: 'Art and Culture' },
    { value: 1, label: 'Education' },
    { value: 2, label: 'Environment' },
    { value: 3, label: 'Animal Protection and Services' },
    { value: 4, label: 'Health' },
    { value: 5, label: 'Mental Health and Rehabilitation' },
    { value: 6, label: 'Disease and Disorder' },
    { value: 7, label: 'Medical Research' },
    { value: 8, label: 'Criminal Justice and Legal' },
    { value: 9, label: 'Employment' },
    { value: 10, label: 'Food and Nutrition' },
    { value: 11, label: 'Housing and Shelters' },
    { value: 12, label: 'Public Safety' },
    { value: 13, label: 'Sports' },
    { value: 14, label: 'Youth Development' },
    { value: 15, label: 'Human Services' },
    { value: 16, label: 'International Affairs' },
    { value: 17, label: 'Civil Rights' },
    { value: 18, label: 'Community' },
    { value: 19, label: 'Philanthropy and Volunteering' },
    { value: 20, label: 'Science and Tech' },
    { value: 21, label: 'Social Science' },
    { value: 22, label: 'Public Benefits' },
    { value: 23, label: 'Religion' },
    { value: 24, label: 'Mutual Benefit Organizations' },
    { value: 25, label: 'Other' },
]