@edropin/store-svc

    1.0.43 • Public • Published

    e_dropin_store

    EDropinStore - JavaScript client for e_dropin_store Store service for eDropin This SDK is automatically generated by the Swagger Codegen project:

    • API version: 1.0.11
    • Package version: 1.0.11
    • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

    Installation

    For Node.js

    npm

    To publish the library as a npm, please follow the procedure in "Publishing npm packages".

    Then install it via:

    npm install e_dropin_store --save
    Local development

    To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

    npm install

    Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

    npm link

    Finally, switch to the directory you want to use your e_dropin_store from, and run:

    npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

    You should now be able to require('e_dropin_store') in javascript files from the directory you ran the last command above from.

    git

    If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

        npm install GIT_USER_ID/GIT_REPO_ID --save

    For browser

    The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

    browserify main.js > bundle.js

    Then include bundle.js in the HTML pages.

    Webpack Configuration

    Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

    module: {
      rules: [
        {
          parser: {
            amd: false
          }
        }
      ]
    }

    Getting Started

    Please follow the installation instruction and execute the following JS code:

    var EDropinStore = require('e_dropin_store');
     
    var defaultClient = EDropinStore.ApiClient.instance;
     
    // Configure API key authorization: Authorization
    var Authorization = defaultClient.authentications['Authorization'];
    Authorization.apiKey = "YOUR API KEY"
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.apiKeyPrefix['Authorization'] = "Token"
     
    // Configure API key authorization: ClientKey
    var ClientKey = defaultClient.authentications['ClientKey'];
    ClientKey.apiKey = "YOUR API KEY"
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ClientKey.apiKeyPrefix['X-Client-Key'] = "Token"
     
    var api = new EDropinStore.EsCartApi()
     
    var itemId = "itemId_example"; // {String} Store Item Id
     
    var body = new EDropinStore.EsCartItemInput(); // {EsCartItemInput} Cart Item that needs to be upserted
     
     
    var callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.addItem(itemIdbody, callback);
     

    Documentation for API Endpoints

    All URIs are relative to http://localhost:9004

    Class Method HTTP request Description
    EDropinStore.EsCartApi addItem POST /cart/add-item/{itemId} Upsert item to cart
    EDropinStore.EsCartApi applyPromotion POST /cart/apply-promotion Promotional codes and memberships can be entered here
    EDropinStore.EsCartApi checkout POST /cart/checkout Endpoint to charge the customer for the items in their cart.
    EDropinStore.EsCartApi emptyCart DELETE /cart Empty the user cart
    EDropinStore.EsCartApi removeItem POST /cart/remove-item/{itemId} Delete a cart item
    EDropinStore.EsCartApi updateCart POST /cart Update the cart
    EDropinStore.EsCartApi validate POST /cart/validate Validate Cart for a currency to ensure all items are available and pricing is all up to date and there are not potential conflicts
    EDropinStore.EsCurrencyExchangeApi getLatestExchange GET /currency-exchange Get the latest exchange rates data
    EDropinStore.EsCustomersApi getUserCustomer GET /customers Get the users current customer information
    EDropinStore.EsCustomersApi listAllCards GET /customers/cards Retrieve all saved cards for customer
    EDropinStore.EsCustomersApi removeCard DELETE /customers/cards/{cardId} Remove a card
    EDropinStore.EsCustomersApi updateCustomer PUT /customers Update a customer
    EDropinStore.EsMembershipsApi createMembership POST /memberships Create Membership
    EDropinStore.EsMembershipsApi deleteMembersTask DELETE /memberships/{membershipId}/members/tasks Delete all members in the membership [cloud tasks]
    EDropinStore.EsMembershipsApi deleteMembership DELETE /memberships/{membershipId} Delete an existing membership
    EDropinStore.EsMembershipsApi getAllMemberships GET /memberships Get Memberships
    EDropinStore.EsMembershipsApi getMembers GET /memberships/{membershipId}/members Get members for a membership
    EDropinStore.EsMembershipsApi getMembership GET /memberships/{membershipId} Get a membership from eDropin
    EDropinStore.EsMembershipsApi updateMembers PUT /memberships/{membershipId}/members Update an existing membership
    EDropinStore.EsMembershipsApi updateMembership PUT /memberships/{membershipId} Update an existing membership
    EDropinStore.EsMerchantsApi enableBilling POST /merchants/{merchantId}/enable-billing Enable billing
    EDropinStore.EsMerchantsApi getMerchant GET /merchants/{merchantId} Get a Merchant from the directory
    EDropinStore.EsMerchantsApi listMerchantFeed GET /merchants/{merchantId}/feed Merchant Feed
    EDropinStore.EsMerchantsApi updateFeeStructure PUT /merchants/{merchantId}/fee-structure/{itemType} Setup fee structure for merchant [Admin Only]
    EDropinStore.EsMerchantsApi updateMerchant PUT /merchants/{merchantId} Update Merchant
    EDropinStore.EsOrderApi getOrder GET /orders/{orderId} Get order by id
    EDropinStore.EsOrderApi listOrderItems GET /orders/{orderId}/items List order items
    EDropinStore.EsOrderApi listUserOrders GET /orders Get orders for current user
    EDropinStore.EsOrderItemsApi createCharge POST /order-items/{orderItemId}/charge Create an additional charge on an order item
    EDropinStore.EsOrderItemsApi createRefund POST /order-items/{orderItemId}/refunds Create a refund for an order item
    EDropinStore.EsOrderItemsApi createRefundRequest POST /order-items/{orderItemId}/refund-requests Create a refund for an item
    EDropinStore.EsOrderItemsApi getOrderItem GET /order-items/{orderItemId} Get the order item
    EDropinStore.EsOrderItemsApi listOrderItemsByMerchant GET /order-items List merchant order items
    EDropinStore.EsPermissionsApi acceptPermissionInvite POST /permissions/accept-invite/{inviteToken} Accept a permission invite
    EDropinStore.EsPermissionsApi hasPermission GET /permissions/{entityType}/{entityId}/accounts/{accountId} Check account has permission
    EDropinStore.EsPermissionsApi paginatePermissions GET /permissions/{entityType}/{entityId}/accounts Get permissions for entity
    EDropinStore.EsPermissionsApi removePermissionsForAccount DELETE /permissions/{entityType}/{entityId}/accounts/{accountId} Remove all permissions for account
    EDropinStore.EsPermissionsApi sendPermissionInvite POST /permissions/{entityType}/{entityId}/send-invite Send a permission invite
    EDropinStore.EsPermissionsApi setPermission PUT /permissions/{entityType}/{entityId}/accounts/{accountId} Set account permission
    EDropinStore.EsStoreApi createStoreItem POST /store Create a store item
    EDropinStore.EsStoreApi deleteStoreItem DELETE /store/{itemId} Delete an existing Store Item
    EDropinStore.EsStoreApi getMultipleStoreItems GET /store/get-multi Get multiple store items from the directory
    EDropinStore.EsStoreApi getStoreItem GET /store/{itemId} Get a store item from the directory
    EDropinStore.EsStoreApi listStoreItems GET /store Get all store items for merchant
    EDropinStore.EsStoreApi updateStoreItem PUT /store/{itemId} Update a store item
    EDropinStore.EsSubscriptionsApi deleteSubscription DELETE /subscriptions/{subscriptionId} Cancel a subscription
    EDropinStore.EsSubscriptionsApi retrieveSubscriptionsById GET /subscriptions/retrieve-multi Get multiple subscriptions. Must all belong to one merchant ID
    EDropinStore.EsTransactionsApi refreshChargeTransaction POST /charge-transactions/{transactionId}/refresh Refreshes a charge transaction against the stripe account in order to make sure all amounts are synced
    EDropinStore.EsTransactionsApi retrieveChargeTransactionsById GET /charge-transactions/retrieve-multi Get multiple charge transactions. Must all belong to one merchant ID
    EDropinStore.EsTransactionsApi retrieveRefundTransactionsById GET /refund-transactions/retrieve-multi Get multiple refund transactions. Must all belong to one merchant ID
    EDropinStore.EsUserMembershipsApi addUserMembership POST /user-memberships Add a membership to a user
    EDropinStore.EsUserMembershipsApi listUserMemberships GET /user-memberships List current user memberships
    EDropinStore.EsUserMembershipsApi removeUserMembership DELETE /user-memberships/{userMembershipId} Delete an existing membership
    EDropinStore.EsUserMembershipsApi updateUserMembership PUT /user-memberships/{userMembershipId} Update an existing user membership

    Documentation for Models

    Documentation for Authorization

    Authorization

    • Type: API key
    • API key parameter name: Authorization
    • Location: HTTP header

    AuthorizationOptional

    • Type: API key
    • API key parameter name: Authorization
    • Location: HTTP header

    ClientKey

    • Type: API key
    • API key parameter name: X-Client-Key
    • Location: HTTP header

    Keywords

    none

    Install

    npm i @edropin/store-svc

    DownloadsWeekly Downloads

    1

    Version

    1.0.43

    License

    UNLICENSED

    Unpacked Size

    1.02 MB

    Total Files

    348

    Last publish

    Collaborators

    • sajarora