Skip to content

Latest commit

 

History

History
365 lines (323 loc) · 29.8 KB

README.md

File metadata and controls

365 lines (323 loc) · 29.8 KB
Raw

Go API client for eZmaxApi

This API expose all the functionnalities for the eZmax and eZsign applications.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.1.3
  • Package version: 1.1.3
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./eZmaxApi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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
ModuleAuthenticateApi AuthenticateAuthenticateV2 Post /2/module/authenticate/authenticate/{eSessionType} Authenticate a user
ModuleListApi ListGetListpresentationV1 Get /1/module/list/listpresentation/{sListName} Get all Listpresentation for a specific list
ModuleListApi ListSaveListpresentationV1 Post /1/module/list/listpresentation/{sListName} Save all Listpresentation for a specific list
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
ObjectEzsignbulksendApi EzsignbulksendGetListV1 Get /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
ObjectEzsigndocumentApi EzsigndocumentApplyEzsigntemplateV1 Post /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsign Template to the Ezsigndocument.
ObjectEzsigndocumentApi EzsigndocumentApplyEzsigntemplateV2 Post /2/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 EzsigndocumentGetEzsignpagesV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
ObjectEzsigndocumentApi EzsigndocumentGetFormDataV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
ObjectEzsigndocumentApi EzsigndocumentGetObjectV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsigndocumentApi EzsigndocumentGetWordsPositionsV1 Post /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a 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 EzsignfolderGetFormsDataV1 Get /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
ObjectEzsignfolderApi EzsignfolderGetListV1 Get /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
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
ObjectEzsignfolderApi EzsignfolderUnsendV1 Post /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder
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
ObjectEzsignfoldertypeApi EzsignfoldertypeGetAutocompleteV1 Get /1/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ObjectEzsignfoldertypeApi EzsignfoldertypeGetListV1 Get /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
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
ObjectEzsigntemplatepackageApi EzsigntemplatepackageGetListV1 Get /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
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

Authorization

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

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

support-api@ezmax.ca