Git Product home page Git Product logo

ezmax-sdk-android's Introduction

openapi-android-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>org.openapitools</groupId>
    <artifactId>openapi-android-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:openapi-android-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/openapi-android-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

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

import org.openapitools.client.api.GlobalCustomerApi;

public class GlobalCustomerApiExample {

    public static void main(String[] args) {
        GlobalCustomerApi apiInstance = new GlobalCustomerApi();
        String pksCustomerCode = null; // String | The customer code assigned to your account
        String sInfrastructureproductCode = null; // String | The infrastructure product Code  If undefined, \"appcluster01\" is assumed
        try {
            GlobalCustomerGetEndpointV1Response result = apiInstance.globalCustomerGetEndpointV1(pksCustomerCode, sInfrastructureproductCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalCustomerApi#globalCustomerGetEndpointV1");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Class Method HTTP request Description
GlobalCustomerApi globalCustomerGetEndpointV1 GET /1/customer/{pksCustomerCode}/endpoint Get customer endpoint
ModuleSsprApi ssprResetPasswordRequestV1 POST /1/module/sspr/resetPasswordRequest Reset Password Request
ModuleSsprApi ssprResetPasswordV1 POST /1/module/sspr/resetPassword Reset Password
ModuleSsprApi ssprSendUsernamesV1 POST /1/module/sspr/sendUsernames Send username(s)
ModuleSsprApi ssprUnlockAccountRequestV1 POST /1/module/sspr/unlockAccountRequest Unlock Account Request
ModuleSsprApi ssprUnlockAccountV1 POST /1/module/sspr/unlockAccount Unlock Account
ModuleSsprApi ssprValidateTokenV1 POST /1/module/sspr/validateToken Validate Token
ModuleUserApi userCreateEzsignuserV1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser
ObjectActivesessionApi activesessionGetCurrentV1 GET /1/object/activesession/getCurrent Get Current Activesession
ObjectApikeyApi apikeyCreateObjectV1 POST /1/object/apikey Create a new Apikey
ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsign Template to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocumentCreateObjectV1 POST /1/object/ezsigndocument Create a new Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentDeleteObjectV1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentGetChildrenV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getChildren Retrieve an existing Ezsigndocument's children IDs
ObjectEzsigndocumentApi ezsigndocumentGetDownloadUrlV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
ObjectEzsigndocumentApi ezsigndocumentGetObjectV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsignfolderApi ezsignfolderCreateObjectV1 POST /1/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderApi ezsignfolderDeleteObjectV1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderGetChildrenV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getChildren Retrieve an existing Ezsignfolder's children IDs
ObjectEzsignfolderApi ezsignfolderGetObjectV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderSendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationDeleteObjectV1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetChildrenV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getChildren Retrieve an existing Ezsignfoldersignerassociation's children IDs
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetInPersonLoginUrlV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
ObjectEzsignsignatureApi ezsignsignatureCreateObjectV1 POST /1/object/ezsignsignature Create a new Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureDeleteObjectV1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureGetChildrenV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getChildren Retrieve an existing Ezsignsignature's children IDs
ObjectEzsignsignatureApi ezsignsignatureGetObjectV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
ObjectFranchisebrokerApi franchisebrokerGetAutocompleteV1 GET /1/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
ObjectFranchiseofficeApi franchiseofficeGetAutocompleteV1 GET /1/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs
ObjectFranchisereferalincomeApi franchisereferalincomeCreateObjectV1 POST /1/object/franchisereferalincome Create a new Franchisereferalincome
ObjectPeriodApi periodGetAutocompleteV1 GET /1/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Authorization

  • 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

[email protected]

ezmax-sdk-android's People

Contributors

herrick19 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.