Skip to content

subscreasy/subscreasy-javascript-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
.swagger-codegen
.swagger-codegen
 
 
docs
docs
 
 
src
src
 
 
test
test
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

Repository files navigation

subscreasy-js-client

SubscreasyJsClient - JavaScript client for subscreasy-js-client Api Documentation This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.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 subscreasy-js-client --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your subscreasy-js-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 SubscreasyJsClient = require('subscreasy-js-client');

var defaultClient = SubscreasyJsClient.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['Authorization'] = "Token"

var api = new SubscreasyJsClient.AccountResourceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isAuthenticatedUsingGET(callback);

Documentation for API Endpoints

All URIs are relative to http://sandbox.subscreasy.com

Class Method HTTP request Description
SubscreasyJsClient.AccountResourceApi isAuthenticatedUsingGET GET /api/authenticate isAuthenticated
SubscreasyJsClient.AccountResourceApi registerAccountUsingPOST POST /api/register registerAccount
SubscreasyJsClient.AnalyticsResourceApi getDashboardAnalyticsUsingGET GET /api/analytics/dashboard getDashboardAnalytics
SubscreasyJsClient.BankAccountResourceApi createBankAccountUsingPOST POST /api/bank-accounts createBankAccount
SubscreasyJsClient.BankAccountResourceApi deleteBankAccountUsingDELETE DELETE /api/bank-accounts/{id} deleteBankAccount
SubscreasyJsClient.BankAccountResourceApi getAllBankAccountsUsingGET GET /api/bank-accounts getAllBankAccounts
SubscreasyJsClient.BankAccountResourceApi getBankAccountUsingGET GET /api/bank-accounts/{id} getBankAccount
SubscreasyJsClient.BankAccountResourceApi getBankAccountsByCompanyUsingGET GET /api/bank-accounts/company/{companyId} getBankAccountsByCompany
SubscreasyJsClient.BankAccountResourceApi updateBankAccountUsingPUT PUT /api/bank-accounts updateBankAccount
SubscreasyJsClient.CardResourceApi saveCardForSubscriberUsingPOST POST /api/card/subscriber saveCardForSubscriber
SubscreasyJsClient.CardResourceApi saveCardForSubscriptionUsingPOST POST /api/card/subscription saveCardForSubscription
SubscreasyJsClient.ChargingLogResourceApi createChargingLogUsingPOST POST /api/charging-logs createChargingLog
SubscreasyJsClient.ChargingLogResourceApi deleteChargingLogUsingDELETE DELETE /api/charging-logs/{id} deleteChargingLog
SubscreasyJsClient.ChargingLogResourceApi getAllChargingLogsUsingGET GET /api/charging-logs getAllChargingLogs
SubscreasyJsClient.ChargingLogResourceApi getChargingLogUsingGET GET /api/charging-logs/{id} getChargingLog
SubscreasyJsClient.ChargingLogResourceApi getChargingLogsByStatusUsingGET GET /api/charging-logs/status/{status} getChargingLogsByStatus
SubscreasyJsClient.ChargingLogResourceApi getPaymentsByMerchantSubscriberIdUsingGET GET /api/charging-logs/subscriber/m/{merchantSubscriberId} getPaymentsByMerchantSubscriberId
SubscreasyJsClient.ChargingLogResourceApi getPaymentsBySubscriberIdUsingGET GET /api/charging-logs/subscriber/id/{subscriberId} getPaymentsBySubscriberId
SubscreasyJsClient.ChargingLogResourceApi getPaymentsBySubscriberIdUsingGET1 GET /api/charging-logs/subscriber/{subscriberSecureId} getPaymentsBySubscriberId
SubscreasyJsClient.ChargingLogResourceApi getPaymentsBySubscriptionUsingGET GET /api/charging-logs/subscription/{id} getPaymentsBySubscription
SubscreasyJsClient.ChargingLogResourceApi refundUsingPOST POST /api/charging-logs/refund/{chargingLogId} refund
SubscreasyJsClient.ChargingLogResourceApi updateChargingLogUsingPUT PUT /api/charging-logs updateChargingLog
SubscreasyJsClient.CompanyPropsResourceApi createCompanyPropsUsingPOST POST /api/company-props createCompanyProps
SubscreasyJsClient.CompanyPropsResourceApi deleteCompanyPropsUsingDELETE DELETE /api/company-props/{id} deleteCompanyProps
SubscreasyJsClient.CompanyPropsResourceApi getAllCompanyPropsUsingGET GET /api/company-props getAllCompanyProps
SubscreasyJsClient.CompanyPropsResourceApi getCompanyPropsByCompanyIdUsingGET GET /api/company-props/company/{companyId} getCompanyPropsByCompanyId
SubscreasyJsClient.CompanyPropsResourceApi updateCompanyPropsUsingPUT PUT /api/company-props updateCompanyProps
SubscreasyJsClient.CompanyPropsResourceApi uploadCSSUsingPOST POST /api/company-props/uploadCSS uploadCSS
SubscreasyJsClient.CompanyPropsResourceApi uploadFileUsingPOST POST /api/company-props/uploadFile uploadFile
SubscreasyJsClient.CompanyResourceApi createCompanyUsingPOST POST /api/companies createCompany
SubscreasyJsClient.CompanyResourceApi deleteCompanyUsingDELETE DELETE /api/companies/{id} deleteCompany
SubscreasyJsClient.CompanyResourceApi getAllCompaniesUsingGET GET /api/companies getAllCompanies
SubscreasyJsClient.CompanyResourceApi getCompanyUsingGET GET /api/companies/{id} getCompany
SubscreasyJsClient.CompanyResourceApi updateCompanyUsingPUT PUT /api/companies updateCompany
SubscreasyJsClient.CouponResourceApi createCouponUsingPOST POST /api/coupons createCoupon
SubscreasyJsClient.CouponResourceApi deleteCouponUsingDELETE DELETE /api/coupons/{id} deleteCoupon
SubscreasyJsClient.CouponResourceApi getAllCouponsUsingGET GET /api/coupons getAllCoupons
SubscreasyJsClient.CouponResourceApi getCouponUsingGET GET /api/coupons/{id} getCoupon
SubscreasyJsClient.CouponResourceApi updateCouponUsingPUT PUT /api/coupons updateCoupon
SubscreasyJsClient.EndpointsApi authorizeUsingPUT PUT /api/authorize authorize
SubscreasyJsClient.EndpointsApi deductUsingPUT PUT /api/deduct deduct
SubscreasyJsClient.EndpointsApi getAuthorizedServicesUsingGET GET /api/service/subscriber/{secureId} getAuthorizedServices
SubscreasyJsClient.EndpointsApi getCustomerTotalAmountUsingGET GET /api/customer-totalAmountCharge/{id} getCustomerTotalAmount
SubscreasyJsClient.EndpointsApi getInvoiceDetailsUsingGET GET /api/getInvoiceDetails getInvoiceDetails
SubscreasyJsClient.EndpointsApi getMessageTemplateUsingGET GET /api/message-templates/email/{lifecycleEventName} getMessageTemplate
SubscreasyJsClient.EndpointsApi getServiceInstancesBySubscriptionUsingGET GET /api/service-instances/subscription/{id} getServiceInstancesBySubscription
SubscreasyJsClient.EndpointsApi getServiceOfferingsBySubscriptionPlanUsingGET GET /api/service-offerings/offer/{id} getServiceOfferingsBySubscriptionPlan
SubscreasyJsClient.EndpointsApi getTotalRevenuePerMonthUsingGET GET /api/charging-logs-totalamount-customer/{id} getTotalRevenuePerMonth
SubscreasyJsClient.EndpointsNoAuthApi startSubscription3dsUsingPOST POST /na/subscription/start/4ds startSubscription3ds
SubscreasyJsClient.HistoryResourceApi createHistoryUsingPOST POST /api/histories createHistory
SubscreasyJsClient.HistoryResourceApi deleteHistoryUsingDELETE DELETE /api/histories/{id} deleteHistory
SubscreasyJsClient.HistoryResourceApi getAllHistoriesUsingGET GET /api/histories getAllHistories
SubscreasyJsClient.HistoryResourceApi getHistoryUsingGET GET /api/histories/{id} getHistory
SubscreasyJsClient.HistoryResourceApi updateHistoryUsingPUT PUT /api/histories updateHistory
SubscreasyJsClient.InvoiceResourceApi createInvoiceUsingPOST POST /api/invoices createInvoice
SubscreasyJsClient.InvoiceResourceApi deleteInvoiceUsingDELETE DELETE /api/invoices/{id} deleteInvoice
SubscreasyJsClient.InvoiceResourceApi getAllInvoicesUsingGET GET /api/invoices getAllInvoices
SubscreasyJsClient.InvoiceResourceApi getInvoiceBySubscriberUsingGET GET /api/invoices/subscriber/{subscriberSecureId} getInvoiceBySubscriber
SubscreasyJsClient.InvoiceResourceApi getInvoiceUsingGET GET /api/invoices/{id} getInvoice
SubscreasyJsClient.InvoiceResourceApi updateInvoiceUsingPUT PUT /api/invoices updateInvoice
SubscreasyJsClient.MessageTemplateResourceApi createMessageTemplateUsingPOST POST /api/message-templates createMessageTemplate
SubscreasyJsClient.MessageTemplateResourceApi deleteMessageTemplateUsingDELETE DELETE /api/message-templates/{id} deleteMessageTemplate
SubscreasyJsClient.MessageTemplateResourceApi getAllMessageTemplatesUsingGET GET /api/message-templates getAllMessageTemplates
SubscreasyJsClient.MessageTemplateResourceApi getMessageTemplateUsingGET1 GET /api/message-templates/{id} getMessageTemplate
SubscreasyJsClient.MessageTemplateResourceApi updateMessageTemplateUsingPUT PUT /api/message-templates updateMessageTemplate
SubscreasyJsClient.OfferResourceApi archiveOfferUsingPUT PUT /api/offers/archive/{id} archiveOffer
SubscreasyJsClient.OfferResourceApi createOfferUsingPOST POST /api/offers createOffer
SubscreasyJsClient.OfferResourceApi deleteOfferUsingDELETE DELETE /api/offers/{id} deleteOffer
SubscreasyJsClient.OfferResourceApi getAllOffersUsingGET GET /api/offers getAllOffers
SubscreasyJsClient.OfferResourceApi getOfferUsingGET GET /api/offers/{id} getOffer
SubscreasyJsClient.OfferResourceApi sendOfferPriceChangedEmailUsingPUT PUT /api/offers/sendOfferPriceChangedEmail/{offerId} sendOfferPriceChangedEmail
SubscreasyJsClient.OfferResourceApi updateOfferUsingPUT PUT /api/offers updateOffer
SubscreasyJsClient.OfferResourceApi uploadFileUsingPOST1 POST /api/offers/uploadFile/{offerId} uploadFile
SubscreasyJsClient.OrderResourceApi createOrderUsingPOST POST /api/orders createOrder
SubscreasyJsClient.OrderResourceApi deleteOrderUsingDELETE DELETE /api/orders/{id} deleteOrder
SubscreasyJsClient.OrderResourceApi getAllOrdersUsingGET GET /api/orders getAllOrders
SubscreasyJsClient.OrderResourceApi getOrderUsingGET GET /api/orders/{id} getOrder
SubscreasyJsClient.OrderResourceApi updateOrderUsingPUT PUT /api/orders updateOrder
SubscreasyJsClient.PaymentResourceApi chargeUsingSavedCardUsingPOST POST /api/pay/by-saved-card chargeUsingSavedCard
SubscreasyJsClient.PaymentResourceApi createPaymentUsingPOST POST /api/pay/create-payment createPayment
SubscreasyJsClient.ProfileInfoResourceApi getActiveProfilesUsingGET GET /api/profile-info getActiveProfiles
SubscreasyJsClient.SavedCardResourceApi createCardUsingPOST POST /api/saved-cards createCard
SubscreasyJsClient.SavedCardResourceApi deleteCardUsingDELETE DELETE /api/saved-cards/{id} deleteCard
SubscreasyJsClient.SavedCardResourceApi getAllCardsUsingGET GET /api/saved-cards getAllCards
SubscreasyJsClient.SavedCardResourceApi getCardUsingGET GET /api/saved-cards/{id} getCard
SubscreasyJsClient.SavedCardResourceApi updateCardUsingPUT PUT /api/saved-cards updateCard
SubscreasyJsClient.ServiceInstanceResourceApi createServiceInstanceUsingPOST POST /api/service-instances createServiceInstance
SubscreasyJsClient.ServiceInstanceResourceApi deleteServiceInstanceUsingDELETE DELETE /api/service-instances/{id} deleteServiceInstance
SubscreasyJsClient.ServiceInstanceResourceApi getAllServiceInstancesUsingGET GET /api/service-instances getAllServiceInstances
SubscreasyJsClient.ServiceInstanceResourceApi getServiceInstanceUsingGET GET /api/service-instances/{id} getServiceInstance
SubscreasyJsClient.ServiceInstanceResourceApi updateServiceInstanceUsingPUT PUT /api/service-instances updateServiceInstance
SubscreasyJsClient.ServiceOfferingResourceApi createServiceOfferingUsingPOST POST /api/service-offerings createServiceOffering
SubscreasyJsClient.ServiceOfferingResourceApi deleteServiceOfferingUsingDELETE DELETE /api/service-offerings/{id} deleteServiceOffering
SubscreasyJsClient.ServiceOfferingResourceApi getAllServiceOfferingsUsingGET GET /api/service-offerings getAllServiceOfferings
SubscreasyJsClient.ServiceOfferingResourceApi getServiceOfferingUsingGET GET /api/service-offerings/{id} getServiceOffering
SubscreasyJsClient.ServiceOfferingResourceApi updateServiceOfferingUsingPUT PUT /api/service-offerings updateServiceOffering
SubscreasyJsClient.ServiceResourceApi createServiceUsingPOST POST /api/services createService
SubscreasyJsClient.ServiceResourceApi deleteServiceUsingDELETE DELETE /api/services/{id} deleteService
SubscreasyJsClient.ServiceResourceApi getAllServicesUsingGET GET /api/services getAllServices
SubscreasyJsClient.ServiceResourceApi getServiceUsingGET GET /api/services/{id} getService
SubscreasyJsClient.ServiceResourceApi updateServiceUsingPUT PUT /api/services updateService
SubscreasyJsClient.SubscriberResourceApi createSubscriberUsingPOST POST /api/subscribers createSubscriber
SubscreasyJsClient.SubscriberResourceApi deleteSubscriberUsingDELETE DELETE /api/subscribers/{id} deleteSubscriber
SubscreasyJsClient.SubscriberResourceApi findAllSubscribersUsingGET GET /api/subscribers/find-all findAllSubscribers
SubscreasyJsClient.SubscriberResourceApi getAllSubscribersUsingGET GET /api/subscribers getAllSubscribers
SubscreasyJsClient.SubscriberResourceApi getSubscriberByEmailUsingGET GET /api/subscribers/email/{email} getSubscriberByEmail
SubscreasyJsClient.SubscriberResourceApi getSubscriberByNameUsingGET GET /api/subscribers/name/{name} getSubscriberByName
SubscreasyJsClient.SubscriberResourceApi getSubscriberBySecureIdUsingGET GET /api/subscribers/secureId/{secureId} getSubscriberBySecureId
SubscreasyJsClient.SubscriberResourceApi getSubscriberUsingGET GET /api/subscribers/{id} getSubscriber
SubscreasyJsClient.SubscriberResourceApi updateSubscriberUsingPUT PUT /api/subscribers updateSubscriber
SubscreasyJsClient.SubscriptionResourceApi cancelSubscriptionUsingPUT PUT /api/subscriptions/cancel cancelSubscription
SubscreasyJsClient.SubscriptionResourceApi changePaymentMethodUsingPUT PUT /api/subscriptions/change-payment-method/{subscriptionId} changePaymentMethod
SubscreasyJsClient.SubscriptionResourceApi chargeEarlyUsingPUT PUT /api/subscriptions/charge/{subscriptionId} chargeEarly
SubscreasyJsClient.SubscriptionResourceApi getActiveSubscriptionsByEmailUsingGET GET /api/subscriptions/subscriber/email/{email} getActiveSubscriptionsByEmail
SubscreasyJsClient.SubscriptionResourceApi getActiveSubscriptionsUsingGET GET /api/subscriptions/subscriber/{secureId} getActiveSubscriptions
SubscreasyJsClient.SubscriptionResourceApi getAllCompanySubscriptionsUsingGET GET /api/subscriptions/company/{id} getAllCompanySubscriptions
SubscreasyJsClient.SubscriptionResourceApi getAllSubscriptionsByOfferUsingGET GET /api/subscriptions/offer/{id} getAllSubscriptionsByOffer
SubscreasyJsClient.SubscriptionResourceApi getSubscriptionUsingGET GET /api/subscriptions/{id} getSubscription
SubscreasyJsClient.SubscriptionResourceApi getSubscriptionsByMerchantSubscriberIdUsingGET GET /api/subscriptions/subscriber/m/{merchantSubscriberId} getSubscriptionsByMerchantSubscriberId
SubscreasyJsClient.SubscriptionResourceApi getSubscriptionsByStatusUsingGET GET /api/subscriptions/status/{status} getSubscriptionsByStatus
SubscreasyJsClient.SubscriptionResourceApi startSubscriptionUsingPOST POST /api/subscriptions/start startSubscription
SubscreasyJsClient.SubscriptionResourceApi switchSubscriptionUsingPUT PUT /api/subscriptions/switch switchSubscription
SubscreasyJsClient.UserJwtControllerApi authorizeUsingPOST POST /api/authenticate authorize
SubscreasyJsClient.UserResourceApi createCompanyUserUsingPOST POST /api/users/company createCompanyUser
SubscreasyJsClient.UserResourceApi createUserUsingPOST POST /api/users createUser
SubscreasyJsClient.UserResourceApi deleteUserUsingDELETE DELETE /api/users/{login} deleteUser
SubscreasyJsClient.UserResourceApi getAllUsersByAuthenticatedCompanyUsingGET GET /api/users/company getAllUsersByAuthenticatedCompany
SubscreasyJsClient.UserResourceApi getAllUsersByCompanyIdUsingGET GET /api/users/company/{companyId} getAllUsersByCompanyId
SubscreasyJsClient.UserResourceApi getAllUsersUsingGET GET /api/users getAllUsers
SubscreasyJsClient.UserResourceApi getAuthoritiesUsingGET GET /api/users/authorities getAuthorities
SubscreasyJsClient.UserResourceApi getUserUsingGET GET /api/users/{login} getUser
SubscreasyJsClient.UserResourceApi updateUserUsingPUT PUT /api/users updateUser
SubscreasyJsClient.WebHookResourceApi createWebHookUsingPOST POST /api/web-hooks createWebHook
SubscreasyJsClient.WebHookResourceApi deleteWebHookUsingDELETE DELETE /api/web-hooks/{id} deleteWebHook
SubscreasyJsClient.WebHookResourceApi getAllWebHooksUsingGET GET /api/web-hooks getAllWebHooks
SubscreasyJsClient.WebHookResourceApi getWebHookUsingGET GET /api/web-hooks/{id} getWebHook
SubscreasyJsClient.WebHookResourceApi updateWebHookUsingPUT PUT /api/web-hooks updateWebHook

Documentation for Models

Documentation for Authorization

apiKey

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

About

subscreasy Javascript Client

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages