Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.

eZmaxinc/eZmax-SDK-swift5

The Official eZmax and eZsign Typescript Switft 5 SDK for interacting with the REST API.

Swift5 API client for OpenAPIClient

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.0.31
Package version:
Build package: org.openapitools.codegen.languages.Swift5ClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

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

Authorization

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

Author

support-api@ezmax.ca

Github

link

Stars: 0

Last commit: 2 days ago

You may find interesting

Crash Reporting for Server-side Swift Apps