Skip to content
subscreasy Java Client
Java Other
  1. Java 99.8%
  2. Other 0.2%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen
docs
gradle/wrapper
src
.gitignore
.swagger-codegen-ignore
.travis.yml
README.md
build.gradle
build.sbt
git_push.sh
gradle.properties
gradlew
gradlew.bat
pom.xml
settings.gradle

README.md

java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.kodfarki.subscreasy</groupId>
    <artifactId>java-client</artifactId>
    <version>1.0.18</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.kodfarki.subscreasy:java-client:1.0.18"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/java-client-1.0.18.jar
  • target/lib/*.jar

Getting Started

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

import com.kodfarki.subscreasy.*;
import com.kodfarki.subscreasy.auth.*;
import com.kodfarki.subscreasy.client.model.*;
import com.kodfarki.subscreasy.client.AnalyticsResourceApi;

import java.io.File;
import java.util.*;

public class AnalyticsResourceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        AnalyticsResourceApi apiInstance = new AnalyticsResourceApi();
        try {
            Object result = apiInstance.getDashboardAnalyticsUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsResourceApi#getDashboardAnalyticsUsingGET");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost:8080

Class Method HTTP request Description
AnalyticsResourceApi getDashboardAnalyticsUsingGET GET /api/analytics/dashboard getDashboardAnalytics
CardResourceApi createCardUsingPOST POST /api/cards createCard
CardResourceApi deleteCardUsingDELETE DELETE /api/cards/{id} deleteCard
CardResourceApi getAllCardsUsingGET GET /api/cards getAllCards
CardResourceApi getCardUsingGET GET /api/cards/{id} getCard
CardResourceApi updateCardUsingPUT PUT /api/cards updateCard
ChargingLogResourceApi createChargingLogUsingPOST POST /api/charging-logs createChargingLog
ChargingLogResourceApi deleteChargingLogUsingDELETE DELETE /api/charging-logs/{id} deleteChargingLog
ChargingLogResourceApi getAllChargingLogsUsingGET GET /api/charging-logs getAllChargingLogs
ChargingLogResourceApi getChargingLogUsingGET GET /api/charging-logs/{id} getChargingLog
ChargingLogResourceApi refundUsingPOST POST /api/charging-logs/refund/{chargingLogId} refund
ChargingLogResourceApi updateChargingLogUsingPUT PUT /api/charging-logs updateChargingLog
CompanyPropsResourceApi createCompanyPropsUsingPOST POST /api/company-props createCompanyProps
CompanyPropsResourceApi deleteCompanyPropsUsingDELETE DELETE /api/company-props/{id} deleteCompanyProps
CompanyPropsResourceApi getAllCompanyPropsUsingGET GET /api/company-props getAllCompanyProps
CompanyPropsResourceApi getCompanyPropsByCompanyIdUsingGET GET /api/company-props/company/{companyId} getCompanyPropsByCompanyId
CompanyPropsResourceApi updateCompanyPropsUsingPUT PUT /api/company-props updateCompanyProps
CompanyResourceApi createCompanyUsingPOST POST /api/companies createCompany
CompanyResourceApi deleteCompanyUsingDELETE DELETE /api/companies/{id} deleteCompany
CompanyResourceApi getAllCompaniesUsingGET GET /api/companies getAllCompanies
CompanyResourceApi getCompanyUsingGET GET /api/companies/{id} getCompany
CompanyResourceApi updateCompanyUsingPUT PUT /api/companies updateCompany
CouponResourceApi createCouponUsingPOST POST /api/coupons createCoupon
CouponResourceApi deleteCouponUsingDELETE DELETE /api/coupons/{id} deleteCoupon
CouponResourceApi getAllCouponsUsingGET GET /api/coupons getAllCoupons
CouponResourceApi getCouponUsingGET GET /api/coupons/{id} getCoupon
CouponResourceApi updateCouponUsingPUT PUT /api/coupons updateCoupon
EndpointsApi authorizeUsingPUT PUT /api/authorize authorize
EndpointsApi deductUsingPUT PUT /api/deduct deduct
EndpointsApi getAuthorizedServicesUsingGET GET /api/service/subscriber/{secureId} getAuthorizedServices
EndpointsApi getChargingLogBySubscriptionUsingGET GET /api/charging-logs/subscription/{id} getChargingLogBySubscription
EndpointsApi getCustomerTotalAmountUsingGET GET /api/customer-totalAmountCharge/{id} getCustomerTotalAmount
EndpointsApi getInvoiceDetailsUsingGET GET /api/getInvoiceDetails getInvoiceDetails
EndpointsApi getMessageTemplateUsingGET GET /api/message-templates/email/{lifecycleEventName} getMessageTemplate
EndpointsApi getServiceInstancesBySubscriptionUsingGET GET /api/service-instances/subscription/{id} getServiceInstancesBySubscription
EndpointsApi getServiceOfferingsBySubscriptionPlanUsingGET GET /api/service-offerings/offer/{id} getServiceOfferingsBySubscriptionPlan
EndpointsApi getTotalRevenuePerMonthUsingGET GET /api/charging-logs-totalamount-customer/{id} getTotalRevenuePerMonth
HistoryResourceApi createHistoryUsingPOST POST /api/histories createHistory
HistoryResourceApi deleteHistoryUsingDELETE DELETE /api/histories/{id} deleteHistory
HistoryResourceApi getAllHistoriesUsingGET GET /api/histories getAllHistories
HistoryResourceApi getHistoryUsingGET GET /api/histories/{id} getHistory
HistoryResourceApi updateHistoryUsingPUT PUT /api/histories updateHistory
InvoiceResourceApi createInvoiceUsingPOST POST /api/invoices createInvoice
InvoiceResourceApi deleteInvoiceUsingDELETE DELETE /api/invoices/{id} deleteInvoice
InvoiceResourceApi getAllInvoicesUsingGET GET /api/invoices getAllInvoices
InvoiceResourceApi getInvoiceBySubscriberUsingGET GET /api/invoices/subscriber/{subscriberSecureId} getInvoiceBySubscriber
InvoiceResourceApi getInvoiceUsingGET GET /api/invoices/{id} getInvoice
InvoiceResourceApi updateInvoiceUsingPUT PUT /api/invoices updateInvoice
MessageTemplateResourceApi createMessageTemplateUsingPOST POST /api/message-templates createMessageTemplate
MessageTemplateResourceApi deleteMessageTemplateUsingDELETE DELETE /api/message-templates/{id} deleteMessageTemplate
MessageTemplateResourceApi getAllMessageTemplatesUsingGET GET /api/message-templates getAllMessageTemplates
MessageTemplateResourceApi getMessageTemplateUsingGET1 GET /api/message-templates/{id} getMessageTemplate
MessageTemplateResourceApi updateMessageTemplateUsingPUT PUT /api/message-templates updateMessageTemplate
OfferResourceApi createOfferUsingPOST POST /api/offers createOffer
OfferResourceApi deleteOfferUsingDELETE DELETE /api/offers/{id} deleteOffer
OfferResourceApi getAllOffersUsingGET GET /api/offers getAllOffers
OfferResourceApi getOfferUsingGET GET /api/offers/{id} getOffer
OfferResourceApi updateOfferUsingPUT PUT /api/offers updateOffer
ProfileInfoResourceApi getActiveProfilesUsingGET GET /api/profile-info getActiveProfiles
ServiceInstanceResourceApi createServiceInstanceUsingPOST POST /api/service-instances createServiceInstance
ServiceInstanceResourceApi deleteServiceInstanceUsingDELETE DELETE /api/service-instances/{id} deleteServiceInstance
ServiceInstanceResourceApi getAllServiceInstancesUsingGET GET /api/service-instances getAllServiceInstances
ServiceInstanceResourceApi getServiceInstanceUsingGET GET /api/service-instances/{id} getServiceInstance
ServiceInstanceResourceApi updateServiceInstanceUsingPUT PUT /api/service-instances updateServiceInstance
ServiceOfferingResourceApi createServiceOfferingUsingPOST POST /api/service-offerings createServiceOffering
ServiceOfferingResourceApi deleteServiceOfferingUsingDELETE DELETE /api/service-offerings/{id} deleteServiceOffering
ServiceOfferingResourceApi getAllServiceOfferingsUsingGET GET /api/service-offerings getAllServiceOfferings
ServiceOfferingResourceApi getServiceOfferingUsingGET GET /api/service-offerings/{id} getServiceOffering
ServiceOfferingResourceApi updateServiceOfferingUsingPUT PUT /api/service-offerings updateServiceOffering
ServiceResourceApi createServiceUsingPOST POST /api/services createService
ServiceResourceApi deleteServiceUsingDELETE DELETE /api/services/{id} deleteService
ServiceResourceApi getAllServicesUsingGET GET /api/services getAllServices
ServiceResourceApi getServiceUsingGET GET /api/services/{id} getService
ServiceResourceApi updateServiceUsingPUT PUT /api/services updateService
SubscriberResourceApi createSubscriberUsingPOST POST /api/subscribers createSubscriber
SubscriberResourceApi deleteSubscriberUsingDELETE DELETE /api/subscribers/{id} deleteSubscriber
SubscriberResourceApi getAllSubscribersUsingGET GET /api/subscribers getAllSubscribers
SubscriberResourceApi getSubscriberByEmailUsingGET GET /api/subscribers/email/{email} getSubscriberByEmail
SubscriberResourceApi getSubscriberByNameUsingGET GET /api/subscribers/name/{name} getSubscriberByName
SubscriberResourceApi getSubscriberUsingGET GET /api/subscribers/{id} getSubscriber
SubscriberResourceApi updateSubscriberUsingPUT PUT /api/subscribers updateSubscriber
SubsriptionResourceApi cancelSubscriptionUsingPUT PUT /api/subscriptions/cancel cancelSubscription
SubsriptionResourceApi getActiveSubscriptionsUsingGET GET /api/subsriptions/subscriber/{secureId} getActiveSubscriptions
SubsriptionResourceApi getAllCompanySubscriptionsUsingGET GET /api/subscriptions/company/{id} getAllCompanySubscriptions
SubsriptionResourceApi getSubsriptionUsingGET GET /api/subsriptions/{id} getSubsription
SubsriptionResourceApi startSubscriptionUsingPOST POST /api/subscriptions/start startSubscription
UsageNotificationResourceApi createUsageNotificationUsingPOST POST /api/usage-notifications createUsageNotification
UsageNotificationResourceApi deleteUsageNotificationUsingDELETE DELETE /api/usage-notifications/{id} deleteUsageNotification
UsageNotificationResourceApi getAllUsageNotificationsUsingGET GET /api/usage-notifications getAllUsageNotifications
UsageNotificationResourceApi getUsageNotificationUsingGET GET /api/usage-notifications/{id} getUsageNotification
UsageNotificationResourceApi updateUsageNotificationUsingPUT PUT /api/usage-notifications updateUsageNotification
UserResourceApi createUserUsingPOST POST /api/users createUser
UserResourceApi deleteUserUsingDELETE DELETE /api/users/{login} deleteUser
UserResourceApi getAllUsersUsingGET GET /api/users getAllUsers
UserResourceApi getAuthoritiesUsingGET GET /api/users/authorities getAuthorities
UserResourceApi getUserUsingGET GET /api/users/{login} getUser
UserResourceApi updateUserUsingPUT PUT /api/users updateUser

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

You can’t perform that action at this time.