podium-admin-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.10 • Public • Published

    Podium Admin JavaScript SDK

    This library allows you to access the Podium Admin REST API for building client applications.

    Installation

    npm install podium-admin-sdk
    

    Usage

    import { Podium, PodiumPaginator, PodiumFilter } from 'podium-admin-sdk'
    let podium = new Podium({
      endpoint: 'https://admin.podiumrewards.com/api/'
    })
    
    podium.Auth.login(email, password).then(rsp => {
      console.log(rsp.message)
    }).catch(error => {
      console.log(error.message)
    })
    
    let filter = new PodiumFilter()
        filter.setValues({ customer_id: 1, search: 'Dan' })
    let paginator = new PodiumPaginator()
        paginator.setPerPage(5)
        paginator.setSortField('last_name')
        paginator.setSortDirection('asc')
    podium.Users.List(filter, paginator).then((rsp) => {
          console.log(rsp)
    })
    
    

    Settings

    Settings can be passed into the Podium constructor as a JSON object.

    Name Type Default Description
    endpoint url https://api.podiumrewards.com/v1/ The Podium endpoint URL.

    API methods

    Authentication

    Log in with a username and password and receive an API token to interact with other resources available via the API. The logout endpoint deletes the authentication token.

    Podium.Auth.Login(email, password)
    Podium.Auth.GetToken()
    Podium.Auth.SetToken(string)
    Podium.Auth.HasToken()
    Podium.Auth.logout()
    
    

    Podium Resource

    Log in with a username and password and receive an API token to interact with other resources available via the API. The logout endpoint deletes the authentication token.

    Get
    Name Type Required? Description
    id number/string yes ID of Resource.
    List
    Name Type Required? Description
    arg1 Filter/Paginator no Filter or Paginator Object.
    paginator Paginator no Paginator if first parameter is filter.
    Create
    Name Type Required? Description
    object object no Object to be created.
    Update
    Name Type Required? Description
    id number/string yes ID of Resource.
    object object no Object to be deleted.
    Delete
    Name Type Required? Description
    id number/string yes ID of object to be delete.

    Methods that extend Resource

    Podium.Auth
    Podium.Campaigns.Flex.Flex
    Podium.Campaigns.Flex.Issue.File
    Podium.Campaigns.Flex.Issue.FileError
    Podium.Campaigns.Flex.Issue.Manual
    Podium.Campaigns.Flex.Rule
    Podium.Campaigns.Incentive
    Podium.LRG.Configuration
    Podium.LRG.Session
    Podium.Product.Catalog
    Podium.Product.Filterable
    Podium.Rewards
    Podium.Segments
    Podium.SSO.Attributes
    Podium.Terms.Latest
    Podium.Terms.Terms
    Podium.Users
    

    Paginator properties

    The following set properties are chainable:

    PodiumPaginator.setPage(number)
    PodiumPaginator.setPerPage(number)
    PodiumPaginator.setSortField(field)
    PodiumPaginator.setSortDirection([asc|desc])
    PodiumPaginator.setSortDesc(boolean)
    PodiumPaginator.toParams()
    

    Filter properties

    The following set properties are chainable:

    PodiumFilter.setValues(object)
    PodiumFilter.getValues(number)
    PodiumFilter.toParams()
    

    Install

    npm i podium-admin-sdk

    DownloadsWeekly Downloads

    3

    Version

    0.0.10

    License

    Apache-2.0

    Unpacked Size

    96.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • snapjay
    • vk-engage
    • mxie0314
    • br1988
    • nasharma-engage
    • isingh2020