fwrepae/fwrepae

The Inter TT REST API is described using OpenAPI 3.0. The descriptor for the api can be downloaded in both [YAML](http://localhost:8080/cyclos/api/openapi.yaml) or [JSON](http://localhost:8080/cyclos/api/openapi.json) formats. These files can be used in tools that support the OpenAPI specification,

v1.0-alpha 2024-01-30 06:57 UTC

This package is not auto-updated.

Last update: 2024-04-24 07:25:54 UTC


README

The Inter TT REST API is described using OpenAPI 3.0. The descriptor for the api can be downloaded in both YAML or JSON formats. These files can be used in tools that support the OpenAPI specification, such as the OpenAPI Generator.

In the API, whenever some data is referenced, for example, a group, or payment type, either id or internal name can be used. When an user is to be referenced, the special word 'self' (sans quotes) always refers to the currently authenticated user, and any identification method (login name, e-mail, mobile phone, account number or custom field) that can be used on keywords search (as configured in the products) can also be used to identify users. Some specific data types have other identification fields, like accounts can have a number and payments can have a transaction number. This all depends on the current configuration.

Most of the operations that return data allow selecting which fields to include in the response. This is useful to avoid calculating data that finally won't be needed and also for reducing the transfer over the network. If nothing is set, all object fields are returned. Fields are handled in 3 modes. Given an example object {\"a\": {\"x\": 1, \"y\": 2, \"z\": 3}, \"b\": 0}, the modes are:

  • Include: the field is unprefixed or prefixed with +. All fields which are not explicitly included are excluded from the result. Examples:

    • [\"a\"] results in {\"a\": {\"x\": 1, \"y\": 2, \"z\": 3}}
    • [\"+b\"] results in {\"b\": 0}
    • [\"a.x\"] results in {\"a\": {\"x\": 1}}. This is a nested include. At root level, includes only a then, on a's level, includes only x.
  • Exclude: the field is prefixed by - (or, for compatibility purposes, !). Only explicitly excluded fields are excluded from the result. Examples:

    • [\"-a\"] results in {\"b\": 0}
    • [\"-b\"] results in {\"a\": {\"x\": 1, \"y\": 2, \"z\": 3}}
    • [\"a.-x\"] results in {\"a\": {\"y\": 2, \"z\": 3}}. In this example, a is actually an include at the root level, hence, excludes b.
  • Nested only: when a field is prefixed by * and has a nested path, it only affects includes / excludes for the nested fields, without affecting the current level. Only nested fields are configured. Examples:

    • [\"*a.x\"] results in {\"a\": {\"x\": 1}, \"b\": 0}. In this example, a is configured to include only x. b is also included because, there is no explicit includes at root level.
    • [\"*a.-x\"] results in {\"a\": {\"y\": 2, \"z\": 3}, \"b\": 0}. In this example, a is configured to exclude only x. b is also included because there is no explicit includes at the root level. For backwards compatibility, this can also be expressed in a special syntax -a.x. Also, keep in mind that -x.y.z is equivalent to *x.*y.-z.

You cannot have the same field included and excluded at the same time - a HTTP 422 status will be returned. Also, when mixing nested excludes with explicit includes or excludes, the nested exclude will be ignored. For example, using [\"*a.x\", \"a.y\"] will ignore the *a.x definition, resulting in {\"a\": {\"y\": 2}}.

For details of the deprecated elements (operations and model) please visit the deprecation notes page for this version.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: session
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Session-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Session-Token', 'Bearer');

// Configure HTTP basic authorization: basic
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure API key authorization: accessClient
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Access-Client-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Client-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AccountVisibilityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user = 'user_example'; // string | Can be one of:  - a user identification value, such as id, username, e-mail, phone, etc.   Id is always allowed, others depend on Cyclos configuration. Note that   a valid numeric value is always considered as id. For example, when   using another identification method that can be numeric only, prefix\\   the value with a single quote (like in Excel spreadsheets);  -  `self` for the currently authenticated user.
$fields = array('fields_example'); // string[] | Select which fields to include on returned data. On the beginning of this page is an explanation on how this parameter works.

try {
    $result = $apiInstance->getUserAccountVisibilityData($user, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountVisibilityApi->getUserAccountVisibilityData: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost:8080/cyclos/api

Class Method HTTP request Description
AccountVisibilityApi getUserAccountVisibilityData GET /{user}/account-visibility Returns data for setting the account visibility.
AccountVisibilityApi saveUserAccountVisibility PUT /{user}/account-visibility Saves at once the visibility for all accounts.
AccountVisibilityApi setUserAccountVisibilityAsHidden POST /{user}/account-visibility/{accountType}/hide Sets the visibility for a single user account.
AccountVisibilityApi setUserAccountVisibilityAsVisible POST /{user}/account-visibility/{accountType}/show Sets the visibility for a single user account.
AccountsApi exportAccountHistory GET /{owner}/accounts/{accountType}/export/{format} Exports the accounts history entries as file
AccountsApi exportUsersWithBalances GET /accounts/{accountType}/user-balances/export/{format} Exports the user listing together with their balances as file
AccountsApi getAccountBalanceHistory GET /{owner}/accounts/{accountType}/balances-history Returns the account balances over time
AccountsApi getAccountHistoryDataByOwnerAndType GET /{owner}/accounts/{accountType}/data-for-history Returns data for searching an account history by owner and type
AccountsApi getAccountStatusByOwnerAndType GET /{owner}/accounts/{accountType} Returns the status of an account by owner and type
AccountsApi getOwnerAccountsListData GET /{owner}/accounts/list-data Returns data for listing accounts of the given owner with their statuses.
AccountsApi getUserBalancesData GET /accounts/data-for-user-balances Returns data for searching users together with their balances
AccountsApi getUserBalancesSummary GET /accounts/{accountType}/user-balances/summary Returns summarized information for the user balances search
AccountsApi listAccountsByOwner GET /{owner}/accounts Lists accounts of the given owner with their statuses
AccountsApi searchAccountHistory GET /{owner}/accounts/{accountType}/history Search an account history
AccountsApi searchUsersWithBalances GET /accounts/{accountType}/user-balances Searches for users together with balance information
AdInterestsApi createAdInterest POST /{user}/marketplace-interests Creates a new advertisement interest for a given user.
AdInterestsApi deleteAdInterest DELETE /marketplace-interests/{id} Removes an advertisement interest.
AdInterestsApi getAdInterestDataForEdit GET /marketplace-interests/{id}/data-for-edit Returns data for modifying an advertisement interest.
AdInterestsApi getAdInterestDataForNew GET /{user}/marketplace-interests/data-for-new Returns data for creating a new advertisement interest for a given user.
AdInterestsApi getUserAdInterestsListData GET /{user}/marketplace-interests/list-data Returns data for advertisement interests listing of the given user.
AdInterestsApi updateAdInterest PUT /marketplace-interests/{id} Updates an existing advertisement interest.
AdInterestsApi viewAdInterest GET /marketplace-interests/{id} Returns details of an advertisement interest.
AdQuestionsApi answerAdQuestion POST /questions/{id}/answer Answers an advertisement question as the authenticated user.
AdQuestionsApi createAdQuestion POST /marketplace/{ad}/questions Creates a new advertisement question.
AdQuestionsApi deleteAdQuestion DELETE /questions/{id} Removes an advertisement question.
AdQuestionsApi getAdQuestion GET /questions/{id} Returns details of an advertisement question.
AdQuestionsApi searchUnansweredAdQuestions GET /{user}/unanswered-questions Searches for unanswered questions for a specific user
AddressesApi createAddress POST /{user}/addresses Creates a new address for the given user
AddressesApi deleteAddress DELETE /addresses/{id} Removes an address
AddressesApi getAddressDataForEdit GET /addresses/{id}/data-for-edit Returns data to edit an existing address
AddressesApi getAddressDataForNew GET /{user}/addresses/data-for-new Returns data to create a new address
AddressesApi getPasswordInputForRemoveAddress GET /addresses/{id}/password-for-remove Returns a confirmation `PasswordInput` for removing an address, if any
AddressesApi getUserAddressesListData GET /{user}/addresses/list-data Returns data for addresses listing of the given user
AddressesApi getUserPrimaryAddress GET /{user}/addresses/primary Returns the primary address of a given user
AddressesApi listAddressesByUser GET /{user}/addresses Lists all (visible) user addresses
AddressesApi listCountries GET /addresses/countries Lists all known countries with the ISO code and display name
AddressesApi updateAddress PUT /addresses/{id} Updates an existing address
AddressesApi viewAddress GET /addresses/{id} Returns details of a specific address
AgreementsApi acceptOptionalAgreements POST /agreements/optional Saves the optional agreements for the authenticated user.
AgreementsApi acceptPendingAgreement POST /agreements/accept Accept one or more agreements
AgreementsApi getAgreementContent GET /agreements/{key}/content Returns the content of an agreement
AgreementsApi getUserAgreements GET /{user}/agreements Returns agreements information for the given user
AgreementsApi listPendingAgreements GET /agreements/pending Returns the agreements the authenticated user needs to accept in order to use the system
AlertsApi getUserAlertDataForSearch GET /alerts/user/data-for-search Returns configuration data for searching user alerts.
AlertsApi searchUserAlerts GET /alerts/user Searches for user alerts.
AuthApi changeForgottenPassword POST /auth/forgotten-password Changes the a forgotten password after have completed the request
AuthApi confirmLogin POST /auth/session/login-confirmation Confirms the login in the current session.
AuthApi disconnectCurrentClient DELETE /auth/access-client Disconnect the current access client
AuthApi forgottenPasswordRequest POST /auth/forgotten-password/request Requests a forgotten password, notifying the user with instructions to reset it
AuthApi getCurrentAuth GET /auth Returns data about the currently authenticated user
AuthApi getDataForChangeForgottenPassword GET /auth/forgotten-password/data-for-change Returns configuration data used to change a forgotten password after the initial request
AuthApi getDataForLogin GET /auth/data-for-login Returns data containing the configuration for logging-in
AuthApi getLoginConfirmation GET /auth/session/login-confirmation Returns the data for entering the login confirmation.
AuthApi getSecondaryPasswordInput GET /auth/session/secondary-password Use `GET /auth/session/login-confirmation` instead.
AuthApi getSessionProperties GET /auth/session Returns properties of the current session
AuthApi login POST /auth/session Logs-in the currently authenticated user or perform a login through a trusted device.
AuthApi logout DELETE /auth/session Log-out the current session
AuthApi newOtp POST /auth/otp Generates a new One-Time-Password (OTP) for the authenticated user
AuthApi newOtpForLoginConfirmation POST /auth/session/login-confirmation/otp Generates a new One-Time-Password (OTP) for the login confirmation.
AuthApi newOtpForSecondaryPassword POST /auth/session/secondary-password/otp Use `POST /auth/session/login-confirmation/otp` instead.
AuthApi replaceSession POST /auth/session/replace/{sessionToken} Replaces a session token previously obtained
AuthApi setSessionProperties PUT /auth/session Sets properties of the current session
AuthApi validateSecondaryPassword POST /auth/session/secondary-password Use `POST /auth/session/login-confirmation` instead.
BalanceLimitsApi exportAccountBalanceLimits GET /accounts/balance-limits/export/{format} Exports the account balance limits results as file.
BalanceLimitsApi getAccountBalanceLimits GET /{user}/accounts/{accountType}/balance-limits Returns data for the limits of a given account
BalanceLimitsApi getAccountBalanceLimitsData GET /accounts/data-for-balance-limits Returns data for a general search of account balance limits.
BalanceLimitsApi getDataForUserBalanceLimits GET /{user}/accounts/data-for-balance-limits Returns data regarding the limits of all accounts of a given user.
BalanceLimitsApi searchAccountBalanceLimits GET /accounts/balance-limits Searches for account balance limits.
BalanceLimitsApi setAccountBalanceLimits PUT /{user}/accounts/{accountType}/balance-limits Sets the limits for a given user account.
BrokeringApi addBroker POST /{user}/brokers/{broker} Adds a brokering relation between the given user and broker.
BrokeringApi getBrokerDataForAdd GET /{user}/brokers/data-for-add Returns configuration data to add another broker to a user.
BrokeringApi getUserBrokersData GET /{user}/brokers Returns the current broker(s), together with additional information
BrokeringApi removeBroker DELETE /{user}/brokers/{broker} Removes a brokering relation between the given user and broker.
BrokeringApi setMainBroker POST /{user}/brokers/{broker}/set-main Sets a broker as the main broker of the user.
BrokeringApi viewBrokering GET /{user}/brokers/{broker} Returns details of the brokering relation for the given user and broker.
CaptchaApi deleteCaptcha DELETE /captcha/{id} Deletes a previously generated captcha.
CaptchaApi getCaptchaContent GET /captcha/{id} Returns a captcha image content
CaptchaApi newCaptcha POST /captcha Returns a new captcha challenge
ClientsApi activateClient POST /clients/activate Activates an unassigned access client
ClientsApi createAndActivateClient POST /clients/{type} Creates and activates a new access client.
ClientsApi getDataForClientActivation GET /clients/data-for-activation Returns data for a client creation and activation.
ClientsApi listClientTypesForUser GET /{user}/client-types Returns the list of access clients types for a user
ClientsApi sendClientActivationCode POST /clients/send-activaction-code Sends an activation code, so the user identity is validated before activating a new client.
ClientsApi unassignClient POST /clients/{key}/unassign Unassign (disconnects) an access client
ClientsApi viewClient GET /clients/{key} Returns details of an access client
ContactInfosApi createContactInfo POST /{user}/contact-infos Creates a new public contact information for the given user
ContactInfosApi deleteContactInfo DELETE /contact-infos/{id} Removes an existing public contact information
ContactInfosApi getContactInfoDataForEdit GET /contact-infos/{id}/data-for-edit Returns data to edit an existing public contact information
ContactInfosApi getContactInfoDataForNew GET /{user}/contact-infos/data-for-new Returns data to create a new public contact information
ContactInfosApi getPasswordInputForRemoveContactInfo GET /contact-infos/{id}/password-for-remove Returns a confirmation `PasswordInput` for removing a public contact information, if any.
ContactInfosApi getUserContactInfosListData GET /{user}/contact-infos/list-data Returns data for listing public contact informations of the given user.
ContactInfosApi listContactInfosByUser GET /{user}/contact-infos Lists all (visible) public contact informations for the user
ContactInfosApi updateContactInfo PUT /contact-infos/{id} Updates an existing public contact information
ContactInfosApi viewContactInfo GET /contact-infos/{id} Returns details of a specific public contact information
ContactsApi createContact POST /{user}/contact-list Creates a new contact
ContactsApi deleteContact DELETE /contact-list/{id} Removes a contact
ContactsApi getContactDataForEdit GET /contact-list/{id}/data-for-edit Returns data to edit an existing contact
ContactsApi getContactListDataForNew GET /{user}/contact-list/data-for-new Returns configuration data for creating a new contact
ContactsApi getContactListDataForSearch GET /{user}/contact-list/data-for-search Returns configuration data used when searching for contacts
ContactsApi searchContactList GET /{user}/contact-list Searches the contact list of a given user
ContactsApi searchContacts GET /{user}/contacts Search users which are contacts of a specific user
ContactsApi updateContact PUT /contact-list/{id} Updates an existing contact
ContactsApi viewContact GET /contact-list/{id} Returns details of a specific contact
DeliveryMethodsApi createDeliveryMethod POST /{user}/delivery-methods Creates a new webshop delivery method for a given user.
DeliveryMethodsApi deleteDeliveryMethod DELETE /delivery-methods/{id} Removes a webshop delivery method.
DeliveryMethodsApi getDeliveryMethodDataForEdit GET /delivery-methods/{id}/data-for-edit Returns data for modifying a webshop delivery method.
DeliveryMethodsApi getDeliveryMethodDataForNew GET /{user}/delivery-methods/data-for-new Returns data for creating a new webshop delivery method for a given user.
DeliveryMethodsApi getUserDeliveryMethodsListData GET /{user}/delivery-methods/list-data Returns data for webshop delivery methods listing of the given user.
DeliveryMethodsApi updateDeliveryMethod PUT /delivery-methods/{id} Updates an existing webshop delivery method.
DeliveryMethodsApi viewDeliveryMethod GET /delivery-methods/{id} Returns details of a webshop delivery method.
DeviceConfirmationsApi approveDeviceConfirmation POST /device-confirmations/{id}/approve Approves a pending device confirmation.
DeviceConfirmationsApi createDeviceConfirmation POST /device-confirmations Creates a pending device confirmation for the authenticated user.
DeviceConfirmationsApi dataForDeviceConfirmationApproval GET /device-confirmations/data-for-approval Return data for approve / reject device confirmations.
DeviceConfirmationsApi deleteDeviceConfirmation DELETE /device-confirmations/{id} Deletes a device confirmation for the authenticated user.
DeviceConfirmationsApi getDeviceConfirmationQrCode GET /device-confirmations/{id}/qr-code Returns the QR-code image for the given confirmation only if not already approved / rejected.
DeviceConfirmationsApi rejectDeviceConfirmation POST /device-confirmations/{id}/reject Rejects a pending device confirmation.
DeviceConfirmationsApi viewDeviceConfirmation GET /device-confirmations/{id} Shows the details of a device confirmation for the authenticated user.
DevicePinsApi deleteDevicePin DELETE /device-pins/{key} Removes a device PIN.
DevicePinsApi getDevicePinDataForEdit GET /device-pins/{key}/data-for-edit Returns data for editing the PIN name.
DevicePinsApi getPasswordInputForCreatePin GET /device-pins/password-for-create Returns a `PasswordInput` for create a device pin.
DevicePinsApi listDevicePins GET /{user}/device-pins Returns the list of device PIN for a user.
DevicePinsApi setDevicePin POST /device-pins Creates a new PIN or modify the current existing one.
DevicePinsApi updateDevicePin PUT /device-pins/{key} Updates the device PIN name.
DevicePinsApi validateDevicePinValue GET /device-pins/validate Validates a value to be used as a pin.
DevicePinsApi viewDevicePin GET /device-pins/{key} Returns details of a specific device PIN
DevicesApi deleteDevice DELETE /devices/{id} Removes a device.
DevicesApi deviceActivation POST /devices/activate Activates a device by code.
DevicesApi deviceActivationIfPossible POST /devices/activate-if-possible Activates a device without requiring a code if the email was already verified.
DevicesApi getDeviceDataForEdit GET /devices/{id}/data-for-edit Returns data to edit an existing device.
DevicesApi getDeviceDataForSend GET /devices/data-for-send Returns data for send / resend an activation code.
DevicesApi getPasswordInputForRemoveDevice GET /devices/{id}/password-for-remove Returns a confirmation `PasswordInput` for removing a device, if any
DevicesApi listDevices GET /{user}/devices Returns the list of trusted devices for a user.
DevicesApi resendDeviceActivationCode POST /devices/{id}/resend-activation-code Resends the activation code for the given pending device.
DevicesApi sendDeviceActivationCode POST /devices/send-activation-code Sends a new device activation code.
DevicesApi updateDevice PUT /devices/{id} Updates a device.
DocumentsApi createSharedDocument POST /documents Creates a new static shared document.
DocumentsApi createSharedDocumentWithUpload POST /documents/upload Creates a new static shared document with a file
DocumentsApi createUserDocument POST /{user}/documents Creates a new individual document for the given user.
DocumentsApi createUserDocumentWithUpload POST /{user}/documents/upload Creates a new individual document for the given user with a file.
DocumentsApi deleteDocument DELETE /documents/{id} Removes a document.
DocumentsApi downloadDocumentFile GET /documents/{id}/file Returns the content of the document file.
DocumentsApi getDataForDynamicDocument GET /documents/{id}/dynamic/{user} Returns data to process a dynamic document
DocumentsApi getDocumentDataForEdit GET /documents/{id}/data-for-edit Returns data to edit an existing document
DocumentsApi getDocumentsDataForSearch GET /documents/data-for-search Returns configuration data for searching documents.
DocumentsApi getSharedDocumentDataForNew GET /documents/data-for-new Returns data to create a new shared static document
DocumentsApi getUserDocumentDataForNew GET /{user}/documents/data-for-new Returns data to create a new shared individual document
DocumentsApi listUserDocuments GET /{user}/documents Lists the enabled documents for the given user
DocumentsApi processDynamicDocument POST /documents/{id}/dynamic/{user} Processes a dynamic document
DocumentsApi searchDocuments GET /documents General documents search
DocumentsApi updateDocument PUT /documents/{id} Updates the details of a document.
DocumentsApi updateDocumentWithUpload POST /documents/{id}/upload Updates the details of a document and the file content.
DocumentsApi uploadDocumentFile POST /documents/{id}/file Saves the content of the document file.
DocumentsApi viewDocument GET /documents/{id} Returns details of a specific document.
EasyInvoicesApi dataForPerformEasyInvoice GET /easy-invoices/data-for-perform/{to} Returns data for an easy invoice to the given user.
EasyInvoicesApi getEasyInvoiceQrCode GET /easy-invoices/qr-code/{to} Returns the QR-code image for the given easy invoice's parameters
EasyInvoicesApi performEasyInvoice POST /easy-invoices Performs a direct payment from an easy invoice.
EasyInvoicesApi previewEasyInvoice POST /easy-invoices/preview Previews a direct payment from an easy invoice before performing it.
ExternalPaymentsApi cancelExternalPayment POST /external-payments/{key}/cancel Cancels an external payment.
ExternalPaymentsApi dataForPerformExternalPayment GET /{owner}/external-payments/data-for-perform Returns configuration data for performing an external payment
ExternalPaymentsApi performExternalPayment POST /{owner}/external-payments Performs an external payment from the given owner
ExternalPaymentsApi previewExternalPayment POST /{owner}/external-payments/preview Previews an external payment before performing it
FilesApi deleteRawFile DELETE /files/{id} Removes a file by id
FilesApi getRawFileContent GET /files/{id}/content Returns the content of a raw file (temp or custom field value)
FilesApi listTempFiles GET /files/temp Lists temporary files related to the currently authenticated user or guest
FilesApi uploadTempFile POST /files/temp Adds a new temporary file for the currently authenticated user or guest.
FilesApi viewRawFile GET /files/{id} Returns a file details by id
FirebaseApi assignFcmToken POST /firebase/fcm-tokens Assign a new FCM registration token to the authenticated user
FirebaseApi deleteFcmToken DELETE /firebase/fcm-tokens Removes a FCM token from a set of users
FirebaseApi updateFcmTokens PUT /firebase/fcm-tokens Updates an existing FCM token
FrontendApi dataForFrontend GET /frontend/data Returns data required for displaying the new frontend.
FrontendApi dataForFrontendHome GET /frontend/home Returns the data for the home page / dashboard.
FrontendApi getDataForUserQuickAccess GET /frontend/{user}/quick-access Returns data for quick access settings in the new frontend.
FrontendApi getFrontendHelp GET /frontend/help Returns the new frontend help page.
FrontendApi getFrontendIcons GET /frontend/icons Returns a JSON object keyed by icon name and whose values are the SVG contents
FrontendApi restoreUserQuickAccessDefaults POST /frontend/{user}/quick-access/defaults Restores the default quick access items.
FrontendApi saveFrontendSettings POST /frontend/settings Saves user preferences regarding the Cyclos frontend
FrontendApi saveUserQuickAccess PUT /frontend/{user}/quick-access Saves the quick access items.
FrontendApi viewFrontendPage GET /frontend/page/{key} Returns a frontend page with its content.
GroupMembershipApi changeGroupMembership POST /{user}/group Changes the user / operator group
GroupMembershipApi getGroupMembershipData GET /{user}/group Returns the current user / operator group and the change history
IdentityProvidersApi deleteUserIdentityProvider DELETE /{user}/identity-providers/{identityProvider} Removes the link between a user and an identity provider, optionally disabling it
IdentityProvidersApi getUserIdentityProvidersListData GET /{user}/identity-providers/list-data Returns data for identity providers links of the given user.
IdentityProvidersApi identityProviderCallback GET /identity-providers/callback The callback URL which handles redirect callbacks for identity providers.
IdentityProvidersApi identityProviderRedirect GET /identity-providers/redirect/{requestId} An internal URL used to store a cookie with the request id before redirecting to the external identity provider.
IdentityProvidersApi prepareIdentityProviderLink POST /identity-providers/{identityProvider}/link Prepares an operation to link the authenticated user to an identity provider.
IdentityProvidersApi prepareIdentityProviderLogin POST /identity-providers/{identityProvider}/login Prepares an operation to login a user from an identity provider.
IdentityProvidersApi prepareIdentityProviderRegistration POST /identity-providers/{identityProvider}/register Prepares an operation to register a user from an identity provider.
IdentityProvidersApi prepareIdentityProviderWizard POST /identity-providers/{identityProvider}/wizard Prepares an operation to fill in a registration wizard from an identity provider.
ImagesApi deleteImage DELETE /images/{idOrKey} Removes an image by id or key
ImagesApi getAdImagesListData GET /marketplace/{ad}/images/list-data Returns the images of an advertisement, plus additional permissions and data.
ImagesApi getConfigurationLogoContent GET /logos/{configuration}/{kind} Returns a logo content for a given configuration and type
ImagesApi getCurrentLogoContent GET /logos/{kind} Returns a logo content for the current configuration and the given kind
ImagesApi getCurrentThemeImageContent GET /themes/images/{kind}/{name} Returns a theme image content for the current theme.
ImagesApi getImageContent GET /images/content/{idOrKey} Returns an image content by id or key
ImagesApi getSvgIcons GET /svg-icons Returns a JSON object keyed by icon name and whose values are the SVG contents
ImagesApi getSystemCustomImagesListData GET /system-images/list-data Returns data containing the system custom images, as well as categories.
ImagesApi getThemeImageContent GET /themes/{theme}/images/{kind}/{name} Returns a theme image content for a given theme.
ImagesApi getUserImagesListData GET /{user}/images/list-data Returns either `profile` or `custom` images for a given user, plus additional permissions and data
ImagesApi listAdImages GET /marketplace/{ad}/images Lists the images of an advertisement
ImagesApi listTempImages GET /images/temp Lists temporary images related to the currently authenticated user or guest
ImagesApi listUserImages GET /{user}/images Lists either `profile` or `custom` images for a given user.
ImagesApi reorderAdImages PUT /marketplace/{ad}/images/order Changes the order of an advertisement's images removing the ones not given
ImagesApi reorderProfileImages PUT /{user}/images/order Changes the order of a user's profile images removing the ones not given
ImagesApi uploadAdImage POST /marketplace/{ad}/images Adds a new image for the given advertisement.
ImagesApi uploadContactInfoImage POST /contact-infos/{id}/image Uploads a new image for the given public contact information.
ImagesApi uploadSystemCustomImage POST /system-images/{category} Adds a new system custom image under a given category
ImagesApi uploadTempImage POST /images/temp Adds a new temporary image for the currently authenticated user or guest.
ImagesApi uploadUserImage POST /{user}/images Adds a new image for the given user. The image kind is either `profile` or `custom`.
ImagesApi viewImage GET /images/{idOrKey} Returns an image details by id or key
ImagesApi viewSvgIcon GET /svg-icons/{name}.svg Returns an SVG icon by name
ImportsApi abortImportedFile POST /imported-file/{id}/abort Aborts the importing of a given file
ImportsApi deleteImportedFile DELETE /imported-file/{id} Deletes an imported file.
ImportsApi getGeneralImportedFileDataForNew GET /imported-files/{kind}/data-for-new Returns data for a new general import of a given kind.
ImportsApi getGeneralImportedFilesDataForSearch GET /imported-files/{context}/data-for-search Returns data for searching imported files.
ImportsApi getImportedFileDataForEdit GET /imported-file/{id}/data-for-edit Returns data for editing an imported file.
ImportsApi getImportedLineDataForEdit GET /imported-line/{id}/data-for-edit Returns data for editing an imported line.
ImportsApi getImportedLinesDataForSearch GET /imported-file/{id}/lines/data-for-search Searches for imported lines of a given file.
ImportsApi getUserImportedFileDataForNew GET /{user}/imported-files/{kind}/data-for-new Returns data for importing a new file of a given kind and user.
ImportsApi getUserImportedFilesDataForSearch GET /{user}/imported-files/{context}/data-for-search Returns data for searching imported files of a user.
ImportsApi importGeneralFile POST /imported-files/{kind} Starts a general file import for a given kind.
ImportsApi importUserFile POST /{user}/imported-files/{kind} Starts a file import for a given user and kind.
ImportsApi includeImportedLines POST /imported-file/{id}/include Marks a set of lines to be included.
ImportsApi processImportedFile POST /imported-file/{id}/process Starts processing rows of the given imported file.
ImportsApi searchGeneralImportedFiles GET /imported-files/{context} Searches for general imported files.
ImportsApi searchImportedLines GET /imported-file/{id}/lines Searches for imported lines in a given file.
ImportsApi searchUserImportedFiles GET /{user}/imported-files/{context} Searches for imports of a given user and context.
ImportsApi skipImportedLines POST /imported-file/{id}/skip Marks a set of lines to be skipped.
ImportsApi updateImportedFile PUT /imported-file/{id} Updates details of an imported file.
ImportsApi updateImportedLine PUT /imported-line/{id} Updates the values of an imported line.
ImportsApi viewImportedFile GET /imported-file/{id} Returns details of an imported file.
ImportsApi viewImportedLine GET /imported-line/{id} Returns details of an imported line.
InstallmentsApi exportInstallments GET /{owner}/installments/export/{format} Exports the owner installments search results as file
InstallmentsApi exportInstallmentsOverview GET /installments/export/{format} Exports the installments overview search results as file
InstallmentsApi getInstallmentsDataForSearch GET /{owner}/installments/data-for-search Returns data for searching installments of an account owner
InstallmentsApi getInstallmentsOverviewDataForSearch GET /installments/data-for-search Returns data for searching installments regardless of a owner
InstallmentsApi processInstallment POST /installments/{key}/process Processes a installment, generating its corresponding transfer.
InstallmentsApi searchInstallments GET /{owner}/installments Searches installments of an account owner
InstallmentsApi searchInstallmentsOverview GET /installments Searches installments regardless of a owner
InstallmentsApi settleInstallment POST /installments/{key}/settle Settles a scheduled payment installment.
InviteApi getDataForInvite GET /invite/data-for-send Returns data for inviting external users to join the system
InviteApi sendInvitation POST /invite Sends invitation e-mails for external users.
LocalizationApi getLocales GET /localization/locales Returns the list of available locales, this collection is already sent in DataForUI or MobileBaseData.
LocalizationApi saveLocalizationSettings POST /localization/settings Saves the localization settings for the authenticated user.
MarketplaceApi approveAd POST /marketplace/{ad}/approve Approves a pending advertisement.
MarketplaceApi createAd POST /{user}/marketplace Creates a new advertisement for the given user.
MarketplaceApi deleteAd DELETE /marketplace/{ad} Removes an advertisement.
MarketplaceApi exportAd GET /marketplace/{ad}/export/{format} Exports the advertisement details to a file.
MarketplaceApi getAdDataForEdit GET /marketplace/{ad}/data-for-edit Returns configuration data for editing an advertisement.
MarketplaceApi getAdDataForNew GET /{user}/marketplace/data-for-new Returns configuration data for creating a new advertisement for a user and kind.
MarketplaceApi getAdDataForSearch GET /marketplace/data-for-search Returns configuration data for searching advertisements.
MarketplaceApi getUserAdsDataForSearch GET /{user}/marketplace/data-for-search Returns configuration data for searching advertisements of a user.
MarketplaceApi getUserFavoriteAdsListData GET /{user}/marketplace/list-favorites-data Returns data for advertisement favorites listing of the given user.
MarketplaceApi hideAd POST /marketplace/{ad}/hide Hides an advertisement by id.
MarketplaceApi markAsFavorite POST /marketplace/{ad}/mark-as-favorite Marks an advertisement as favorite.
MarketplaceApi rejectAd POST /marketplace/{ad}/reject Rejects a pending advertisement.
MarketplaceApi searchAds GET /marketplace Searches for advertisements.
MarketplaceApi searchUserAds GET /{user}/marketplace Searches for advertisements of a specific user.
MarketplaceApi setAdAsDraft POST /marketplace/{ad}/set-as-draft Change the advertisement status to `draft`.
MarketplaceApi submitAdForAuthorization POST /marketplace/{ad}/request-authorization Request for authorization for an advertisement.
MarketplaceApi unhideAd POST /marketplace/{ad}/unhide Unhides an advertisement by id.
MarketplaceApi unmarkAsFavorite POST /marketplace/{ad}/unmark-as-favorite Makes the advertisement no more a favorite.
MarketplaceApi updateAd PUT /marketplace/{ad} Updates an existing advertisement.
MarketplaceApi viewAd GET /marketplace/{ad} Returns details of an advertisement.
MessagesApi deleteMessage DELETE /messages/{id} Removes a message.
MessagesApi getMessageDataForReply GET /messages/{id}/data-for-reply Returns configuration data for replying a message.
MessagesApi getMessageDataForSearch GET /messages/data-for-search Returns configuration data for searching messages.
MessagesApi getMessageDataForSend GET /messages/data-for-send Returns configuration data for sending messages.
MessagesApi markMessagesAsRead POST /messages/mark-as-read Marks a list of messages as read.
MessagesApi markMessagesAsUnread POST /messages/mark-as-unread Marks a list of messages as unread.
MessagesApi messagesStatus GET /messages/status Returns information about the received messages.
MessagesApi moveMessagesToTrash POST /messages/move-to-trash Moves a list of messages to the trash message box.
MessagesApi replyMessage POST /messages/{id}/reply Replies a message.
MessagesApi restoreMessagesFromTrash POST /messages/restore-from-trash Restores a list of messages from the trash message box.
MessagesApi searchMessages GET /messages Searches for the messages of a user.
MessagesApi sendMessage POST /messages Sends a new message.
MessagesApi updateLastViewDateForMessages POST /messages/viewed Updates the last view date for the messages.
MessagesApi viewMessage GET /messages/{id} Returns the message details.
MobileApi dataForMobileGuest GET /mobile/data-for-guest Returns data the mobile application uses while in guest mode
MobileApi dataForMobileUser GET /mobile/data-for-user Returns data the mobile application uses in either user or POS mode
MobileApi mobilePageContent GET /mobile/page/{key} Returns the content of a mobile page
NFCApi cancelNfc POST /nfc/cancel Cancels a NFC tag
NFCApi createDeviceConfirmationForPersonalizeNfc POST /nfc/personalize/device-confirmations Creates a pending device confirmation for personalizing a NFC tag.
NFCApi deleteDeviceConfirmationForPersonalizeNfc DELETE /nfc/personalize/device-confirmations/{id} Deletes a device confirmation that was created to confirm the personalize nfc-tag operation.
NFCApi getDeviceConfirmationQrCodeForPersonalizeNfc GET /nfc/personalize/device-confirmations/{id}/qr-code Returns the QR-code image for the given device confirmation only if it was not yet approved / rejected
NFCApi getNfcDataForInitialize GET /nfc/data-for-initialize Returns data for NFC tag initialization. Optionally the user can personalize the tag too.
NFCApi getNfcDataForPersonalize GET /nfc/data-for-personalize Returns data for perfornalizing an initialized NFC tag for a user
NFCApi getNfcToken GET /nfc/{tokenType}/{value} Retrieve the NFC token detailed data
NFCApi getOtpForPersonalizeNfc POST /nfc/personalize/otp Generates a new One-Time-Password (OTP) for personalizing a NFC tag
NFCApi initializeNfc POST /nfc/initialize Initializes a NFC tag
NFCApi nfcExternalAuth POST /nfc/external-auth NFC external authentication
NFCApi personalizeNfc POST /nfc/personalize Personalizes a NFC tag
NFCApi viewDeviceConfirmationForPersonalizeNfc GET /nfc/personalize/device-confirmations/{id} Shows the details of a device confirmation that was created to confirm the personalize nfc-tag operation.
NotificationSettingsApi emailUnsubscribe POST /email-unsubscribe/{key} Unsubscribes from a specific type of received e-mail.
NotificationSettingsApi getDataForEmailUnsubscribe GET /email-unsubscribe/{key} Returns data for unsubscribing a specific type of received e-mail.
NotificationSettingsApi getNotificationSettingsDataForEdit GET /{user}/notification-settings/data-for-edit Returns configuration data to edit the notification settings of a user.
NotificationSettingsApi saveNotificationSettings POST /{user}/notification-settings Saves the notification settings for a given user.
NotificationSettingsApi viewNotificationSettings GET /{user}/notification-settings Returns the notification settings for a given user.
NotificationsApi deleteNotification DELETE /notifications/{id} Removes a notification by id.
NotificationsApi markNotificationsAsRead POST /notifications/mark-as-read Marks a list of notifications as read.
NotificationsApi notificationsStatus GET /notifications/status Return information about the received notifications.
NotificationsApi searchNotifications GET /notifications Searches for the notifications the authenticated user has received.
NotificationsApi updateLastViewDateForNotifications POST /notifications/viewed Update the last view date for the notifications.
NotificationsApi viewNotification GET /notifications/{id} Returns the notification details.
OIDCApi oidcAuthorize GET /oidc/authorize The standard OAuth2 / OpenID Connect authorization endpoint.
OIDCApi oidcJwks GET /oidc/jwks The standard OpenID Connect JWKS endpoint.
OIDCApi oidcRegister POST /oidc/register The standard OAuth2 / OpenID dynamic client registration endpoint.
OIDCApi oidcRevoke POST /oidc/revoke The standard OAuth2 token revocation endpoint.
OIDCApi oidcToken POST /oidc/token The standard OAuth2 / OpenID Connect token endpoint.
OIDCApi oidcUserInfoGet GET /oidc/userinfo The standard OpenID Connect UserInfo endpoint, using the `GET` method.
OIDCApi oidcUserInfoPost POST /oidc/userinfo The standard OpenID Connect UserInfo endpoint, using the `POST` method.
OperationsApi getAdOperationDataForRun GET /marketplace/{ad}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over an advertisement
OperationsApi getContactInfoOperationDataForRun GET /contact-infos/{id}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over a public contact information
OperationsApi getContactOperationDataForRun GET /contact-list/{id}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over a contact
OperationsApi getMenuOperationDataForRun GET /menu/{menu}/operations/data-for-run Returns configuration data for running a custom operation which is in a custom menu
OperationsApi getOperationDataForRun GET /operations/{operation}/data-for-run Returns configuration data for running a custom operation without additional scope
OperationsApi getOwnerOperationDataForRun GET /{owner}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over an owner
OperationsApi getRecordOperationDataForRun GET /records/{id}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over a record
OperationsApi getTransferOperationDataForRun GET /transfer/{key}/operations/{operation}/data-for-run Returns configuration data for running a custom operation over a transfer
OperationsApi listOperationsByAd GET /marketplace/{ad}/operations Lists the custom operations over the given advertisement
OperationsApi listOperationsByContact GET /contact-list/{id}/operations Lists the custom operations over the given contact
OperationsApi listOperationsByContactInfo GET /contact-infos/{id}/operations Lists the custom operations over the given public contact information
OperationsApi listOperationsByOwner GET /{owner}/operations Lists the custom operations over the system or user
OperationsApi listOperationsByRecord GET /records/{id}/operations Lists the custom operations over the given record
OperationsApi listOperationsByTransfer GET /transfers/{key}/operations Lists the custom operations over the given transfer
OperationsApi runAdOperation POST /marketplace/{ad}/operations/{operation}/run Runs a custom operation over an advertisement
OperationsApi runAdOperationWithUpload POST /marketplace/{ad}/operations/{operation}/run-upload Runs a custom operation over an advertisement while uploading a file
OperationsApi runContactInfoOperation POST /contact-infos/{id}/operations/{operation}/run Runs a custom operation over a public contact information
OperationsApi runContactInfoOperationWithUpload POST /contact-infos/{id}/operations/{operation}/run-upload Runs a custom operation over a public contact information while uploading a file
OperationsApi runContactOperation POST /contact-list/{id}/operations/{operation}/run Runs a custom operation over a contact
OperationsApi runContactOperationWithUpload POST /contact-list/{id}/operations/{operation}/run-upload Runs a custom operation over an contact while uploading a file
OperationsApi runCustomOperationCallback POST /operations/callback/{id} Runs the callback of an external redirect custom operation
OperationsApi runMenuOperation POST /menu/{menu}/operations/run Runs a custom operation from a custom menu item
OperationsApi runMenuOperationWithUpload POST /menu/{menu}/operations/run-upload Runs a custom operation from a custom menu while uploading a file
OperationsApi runOperation POST /operations/{operation}/run Runs a custom operation without additional scope
OperationsApi runOperationWithUpload POST /operations/{operation}/run-upload Runs a custom operation without additional scope while uploading a file
OperationsApi runOwnerOperation POST /{owner}/operations/{operation}/run Runs a custom operation either for system or user
OperationsApi runOwnerOperationWithUpload POST /{owner}/operations/{operation}/run-upload Runs a custom operation either for system or user while uploading a file
OperationsApi runRecordOperation POST /records/{id}/operations/{operation}/run Runs a custom operation over a record
OperationsApi runRecordOperationWithUpload POST /records/{id}/operations/{operation}/run-upload Runs a custom operation over a record while uploading a file
OperationsApi runTransferOperation POST /transfers/{key}/operations/{operation}/run Runs a custom operation over a transfer
OperationsApi runTransferOperationWithUpload POST /transfers/{key}/operations/{operation}/run-upload Runs a custom operation over a transfer while uploading a file
OperatorGroupsApi createOperatorGroup POST /{user}/operator-groups Creates a new operator group for the given user
OperatorGroupsApi deleteOperatorGroup DELETE /operator-groups/{id} Removes an operator group.
OperatorGroupsApi getOperatorGroupDataForEdit GET /operator-groups/{id}/data-for-edit Returns data for editing an operator group
OperatorGroupsApi getOperatorGroupDataForNew GET /{user}/operator-groups/data-for-new Returns data for creating an operator group
OperatorGroupsApi getUserOperatorGroupsListData GET /{user}/operator-groups/list-data Returns data for operator groups listing of the given user
OperatorGroupsApi listOperatorGroupsByUser GET /{user}/operator-groups Lists all operator groups for a given user
OperatorGroupsApi updateOperatorGroup PUT /operator-groups/{id} Updates an existing operator group.
OperatorGroupsApi viewOperatorGroup GET /operator-groups/{id} Returns details of a specific operator group
OperatorsApi getGeneralOperatorsDataForSearch GET /operators/data-for-search Get configuration data for searching operators of any managed user
OperatorsApi getOperatorDataForNew GET /{user}/operators/data-for-new Get configuration data for registering a new operator
OperatorsApi getUserOperatorsDataForSearch GET /{user}/operators/data-for-search Get configuration data for searching operators of the given user
OperatorsApi registerOperator POST /{user}/operators Registers a new operator
OperatorsApi searchGeneralOperators GET /operators Search the visible operators (of any managed user)
OperatorsApi searchUserOperators GET /{user}/operators Search the operators of a given user
OrdersApi acceptOrderByBuyer POST /orders/{order}/buyer/accept Accepts a pending order by buyer.
OrdersApi acceptOrderBySeller POST /orders/{order}/seller/accept Accepts a pending order by seller.
OrdersApi createOrder POST /{user}/orders Creates a new order as the seller for a specific buyer
OrdersApi deleteOrder DELETE /orders/{order} Removes an order.
OrdersApi exportOrder GET /orders/{order}/export/{format} Exports the order details to a file.
OrdersApi getDataForSetDeliveryMethod GET /orders/{order}/seller/data-for-set-delivery Returns configuration data to set delivery method data by seller.
OrdersApi getOrderDataForAcceptByBuyer GET /orders/{order}/buyer/data-for-accept Returns configuration data for accept an order by buyer.
OrdersApi getOrderDataForEdit GET /orders/{order}/data-for-edit Returns data for modifying an order as the seller.
OrdersApi getOrderDataForNew GET /{user}/orders/data-for-new Returns data for creating orders as the seller for a specific buyer.
OrdersApi getOrderDataForSearch GET /{user}/orders/data-for-search Returns data for searching orders (purchases / sales) of a specific user.
OrdersApi rejectOrder POST /orders/{order}/reject Rejects a pending order.
OrdersApi searchUserOrders GET /{user}/orders Searches for orders of a specific user.
OrdersApi setDeliveryMethod POST /orders/{order}/seller/set-delivery Sets delivery method data by seller.
OrdersApi updateOrder PUT /orders/{order} Updates an existing order.
OrdersApi viewOrder GET /orders/{order} Returns details of an order.
POSApi calculateReceivePaymentInstallments GET /pos/installments Calculates the default installments for a scheduled payment
POSApi dataForReceivePayment GET /pos/data-for-pos Returns configuration data for receiving a payment (POS)
POSApi previewReceivePayment POST /pos/preview Previews a POS payment before receiving it
POSApi receivePayment POST /pos Receives a payment (POS)
POSApi receivePaymentCreateDeviceConfirmation POST /pos/device-confirmations Creates a pending device confirmation for a pos payment.
POSApi receivePaymentDeleteDeviceConfirmation DELETE /pos/device-confirmations/{id} Deletes a device confirmation for a POS payer.
POSApi receivePaymentDeviceConfirmationQrCode GET /pos/device-confirmations/{id}/qr-code Returns the QR-code image for the given device confirmation only if it was not yet approved / rejected
POSApi receivePaymentOtp POST /pos/otp Generates a new One-Time-Password (OTP) for a pos payment
POSApi receivePaymentViewDeviceConfirmation GET /pos/device-confirmations/{id} Shows the details of a device confirmation for a POS payer.
PasswordsApi allowGeneration POST /{user}/passwords/{type}/allow-generation Allows the given user to generate the password for the first time for the given type.
PasswordsApi changeGenerated POST /passwords/{type}/change-generated Generates a new value for an active generated password.
PasswordsApi changePassword POST /{user}/passwords/{type}/change Changes a manual password
PasswordsApi disablePassword POST /{user}/passwords/{type}/disable Disables a password, making it unusable until manually re-enabled
PasswordsApi enablePassword POST /{user}/passwords/{type}/enable Re-enables a disabled a password
PasswordsApi generatePassword POST /passwords/{type}/generate Generates the value of a generated password for the first time or if expired.
PasswordsApi getUserPasswordsData GET /{user}/passwords/{type} Returns complete data of the given password the given user have.
PasswordsApi getUserPasswordsListData GET /{user}/passwords/list-data Returns complete data for each passwords the given user have.
PasswordsApi listUserPasswords GET /{user}/passwords Returns the status for each passwords the given user have.
PasswordsApi resetAndSendPassword POST /{user}/passwords/{type}/reset-and-send Generates a new value for a manual password and send it to the user via e-mail
PasswordsApi resetGeneratedPassword POST /{user}/passwords/{type}/reset-generated Resets a generated password, allowing it to be generated again
PasswordsApi resetUserSecurityAnswer DELETE /{user}/security-answer Resets a user security answer, allowing they to change it
PasswordsApi setSecurityAnswer POST /security-answer Sets the security answer if the current authenticated user
PasswordsApi unblockPassword POST /{user}/passwords/{type}/unblock Unblocks a password that has been blocked by exceeding the wrong tries
PaymentFeedbacksApi addPaymentFeedbackIgnoredUser POST /{user}/payment-feedback-ignored-users Adds a user as ignored for payment feedback.
PaymentFeedbacksApi getPaymentFeedbackDataForEdit GET /payment-feedbacks/{key}/data-for-edit Returns configuration data for editing a payment feedback as manager.
PaymentFeedbacksApi getPaymentFeedbackStatistics GET /{user}/payment-feedbacks/statistics Returns payment feedback statistics of a specific user.
PaymentFeedbacksApi getPaymentFeedbacksDataForGive GET /payment-feedbacks/{key}/data-for-give Returns data for create or update a payment feedback.
PaymentFeedbacksApi getPaymentFeedbacksDataForReply GET /payment-feedbacks/{key}/data-for-reply Returns data for reply a given payment feedback.
PaymentFeedbacksApi getPaymentFeedbacksDataForSearch GET /{user}/payment-feedbacks/data-for-search Returns data for searching payment feedbacks of a specific user.
PaymentFeedbacksApi givePaymentFeedback POST /payment-feedbacks/{key}/give Creates or updates a payment feedback.
PaymentFeedbacksApi listPaymentFeedbackIgnoredUsers GET /{user}/payment-feedback-ignored-users Lists the users marked as ignored for payment feedbacks.
PaymentFeedbacksApi removePaymentFeedback DELETE /payment-feedbacks/{key} Deletes an existing payment feedback as manager.
PaymentFeedbacksApi removePaymentFeedbackIgnoredUser DELETE /{user}/payment-feedback-ignored-users/{ignored} Removes a user from the ignored users list.
PaymentFeedbacksApi replyPaymentFeedback POST /payment-feedbacks/{key}/reply Replies an already given payment feedback.
PaymentFeedbacksApi searchPaymentAwaitingFeedback GET /{user}/payments-awaiting-feedback Searches for payments performed by the user without feedback.
PaymentFeedbacksApi searchPaymentFeedbacks GET /{user}/payment-feedbacks Searches for payment feedbacks of a specific user.
PaymentFeedbacksApi updatePaymentFeedback PUT /payment-feedbacks/{key} Updates an existing payment feedback as manager.
PaymentFeedbacksApi viewPaymentFeedback GET /payment-feedbacks/{key} Returns details of a specific payment feedback.
PaymentLimitsApi exportAccountPaymentLimits GET /accounts/payment-limits/export/{format} Exports the account payment limits results as file.
PaymentLimitsApi getAccountPaymentLimits GET /{user}/accounts/{accountType}/payment-limits Returns data for the limits of a given account
PaymentLimitsApi getAccountPaymentLimitsData GET /accounts/data-for-payment-limits Returns data for a general search of account payment limits.
PaymentLimitsApi getDataForUserPaymentLimits GET /{user}/accounts/data-for-payment-limits Returns data regarding the limits of all accounts of a given user.
PaymentLimitsApi searchAccountPaymentLimits GET /accounts/payment-limits Searches for account payment limits.
PaymentLimitsApi setAccountPaymentLimits PUT /{user}/accounts/{accountType}/payment-limits Sets the limits for a given user account.
PaymentRequestsApi acceptPaymentRequest POST /payment-requests/{key}/accept Accepts a payment request.
PaymentRequestsApi cancelPaymentRequest POST /payment-requests/{key}/cancel Cancels a payment request.
PaymentRequestsApi changePaymentRequestExpirationDate POST /payment-requests/{key}/change-expiration Changes the payment request expiration.
PaymentRequestsApi dataForSendPaymentRequest GET /{owner}/payment-requests/data-for-send Returns configuration data for sending a payment request
PaymentRequestsApi previewPaymentRequest GET /payment-requests/{key}/preview Previews the payment performed when accepting the given payment request.
PaymentRequestsApi rejectPaymentRequest POST /payment-requests/{key}/reject Rejects a payment request.
PaymentRequestsApi reschedulePaymentRequest POST /payment-requests/{key}/reschedule Reschedules a payment request.
PaymentRequestsApi sendPaymentRequest POST /{owner}/payment-requests Sends a payment request from the given owner
PaymentsApi calculatePerformPaymentInstallments GET /{owner}/payments/installments Calculates the default installments for a scheduled payment
PaymentsApi dataForPerformPayment GET /{owner}/payments/data-for-perform Returns configuration data for performing a payment
PaymentsApi performPayment POST /{owner}/payments Performs a payment from the given owner
PaymentsApi previewPayment POST /{owner}/payments/preview Previews a payment before performing it
PendingPaymentsApi authorizePendingPayment POST /pending-payments/{key}/authorize Authorizes a pending payment.
PendingPaymentsApi cancelPendingPayment POST /pending-payments/{key}/cancel Cancels the authorization process of a pending payment.
PendingPaymentsApi denyPendingPayment POST /pending-payments/{key}/deny Denies a pending payment.
PhonesApi createPhone POST /{user}/phones Creates a new phone for the given user
PhonesApi deletePhone DELETE /phones/{idOrNumber} Removes a phone
PhonesApi disablePhoneForSms POST /phones/{idOrNumber}/disable-for-sms Marks a phone as disabled to receive SMS notifications and operate in the SMS channel
PhonesApi enablePhoneForSms POST /phones/{idOrNumber}/enable-for-sms Marks a phone as enabled to receive SMS notifications and operate in the SMS channel
PhonesApi getPasswordInputForDisablePhoneForSms GET /phones/{idOrNumber}/password-for-disable-sms Returns a confirmation `PasswordInput` for disabling SMS of a phone, if any
PhonesApi getPasswordInputForRemovePhone GET /phones/{idOrNumber}/password-for-remove Returns a confirmation `PasswordInput` for removing a phone, if any
PhonesApi getPhoneDataForEdit GET /phones/{idOrNumber}/data-for-edit Returns data to edit an existing phone
PhonesApi getPhoneDataForNew GET /{user}/phones/data-for-new Returns data to create a new phone
PhonesApi getUserPhonesListData GET /{user}/phones/list-data Returns data for listing a user's phones
PhonesApi listPhonesByUser GET /{user}/phones Lists all (visible) user phones
PhonesApi sendPhoneVerificationCode POST /phones/{idOrNumber}/send-verification-code Sends the verification code for a user to verify the mobile phone
PhonesApi updatePhone PUT /phones/{idOrNumber} Updates an existing phone
PhonesApi verifyPhone POST /phones/{idOrNumber}/verify Marks a mobile phone as verified if the code matches
PhonesApi viewPhone GET /phones/{idOrNumber} Returns details of a specific phone
PrivacySettingsApi getPrivacySettingsData GET /{user}/privacy-settings Get the privacy settings data
PrivacySettingsApi savePrivacySettings POST /{user}/privacy-settings Saves the privacy settings for a given user.
ProductAssignmentApi assignIndividualProduct POST /{user}/products/{product} Assigns a product to an individual user.
ProductAssignmentApi getUserProductsData GET /{user}/products Returns the user individual products and the change history
ProductAssignmentApi unassignIndividualProduct DELETE /{user}/products/{product} Unassigns a product to an individual user.
PushApi subscribeForPushNotifications GET /push/subscribe Subscribes for receiving push notifications of specific types
RecordsApi createRecord POST /{owner}/records/{type} Creates a new record for the given owner and type
RecordsApi deleteRecord DELETE /records/{id} Removes a record
RecordsApi exportGeneralRecords GET /general-records/{type}/export/{format} Exports the general records search results as file
RecordsApi exportOwnerRecords GET /{owner}/records/{type}/export/{format} Exports the records search results as file
RecordsApi exportSharedRecords GET /shared-records/export/{format} Exports the shared fields records search results as file
RecordsApi getPasswordInputForRemoveRecord GET /records/{id}/password-for-remove Returns a confirmation `PasswordInput` for removing a record, if any
RecordsApi getRecordDataForEdit GET /records/{id}/data-for-edit Returns data to edit an existing record
RecordsApi getRecordDataForGeneralSearch GET /general-records/{type}/data-for-search Returns data for searching records of a type over any owner
RecordsApi getRecordDataForNew GET /{owner}/records/{type}/data-for-new Returns data to create a new record
RecordsApi getRecordDataForOwnerSearch GET /{owner}/records/{type}/data-for-search Returns data for searching records of a specific type and owner
RecordsApi getRecordDataForSharedSearch GET /shared-records/data-for-search Returns data for searching records with shared fields
RecordsApi getRecordTypeByOwner GET /{owner}/record-types/{type} Returns a single record type over a user or system
RecordsApi listRecordTypesByOwner GET /{owner}/record-types Lists the record types over a user or system
RecordsApi listRecordTypesForGeneralSearch GET /general-records/record-types Lists the record types for general search
RecordsApi searchGeneralRecords GET /general-records/{type} Searches for records of a specific type over any owner
RecordsApi searchOwnerRecords GET /{owner}/records/{type} Searches for records of a specific type and owner
RecordsApi searchSharedRecords GET /shared-records Searches for records with shared fields
RecordsApi updateRecord PUT /records/{id} Updates an existing record
RecordsApi viewRecord GET /records/{id} Returns details of a specific record
RecurringPaymentsApi blockRecurringPayment POST /recurring-payments/{key}/block Blocks a recurring payment.
RecurringPaymentsApi cancelRecurringPayment POST /recurring-payments/{key}/cancel Cancels a recurring payment.
RecurringPaymentsApi getRecurringPaymentDataForEdit GET /recurring-payments/{key}/data-for-edit Returns data to edit an existing recurring payment
RecurringPaymentsApi modifyRecurringPayment PUT /recurring-payments/{key}/modify Modifies a recurring payment.
RecurringPaymentsApi unblockRecurringPayment POST /recurring-payments/{key}/unblock Unblocks a recurring payment.
ReferencesApi deleteReference DELETE /references/{id} Removes a reference
ReferencesApi getReferenceDataForEdit GET /references/{id}/data-for-edit Returns data to edit an existing reference.
ReferencesApi getReferenceDataForSet GET /{from}/reference/{to}/data-for-set Returns details for setting a reference.
ReferencesApi getUserReferenceStatistics GET /{user}/references/statistics Returns statistics for a given user references.
ReferencesApi getUserReferencesDataForSearch GET /{user}/references/data-for-search Returns data for searching references of a specific user.
ReferencesApi searchUserReferences GET /{user}/references Searches for references of a specific user
ReferencesApi setReference POST /{from}/reference/{to} Creates or changes the reference between the given users.
ReferencesApi updateReference PUT /references/{id} Updates an existing reference.
ReferencesApi viewReference GET /references/{id} Returns details of a specific reference.
ScheduledPaymentsApi blockScheduledPayment POST /scheduled-payments/{key}/block Blocks a scheduled payment.
ScheduledPaymentsApi cancelScheduledPayment POST /scheduled-payments/{key}/cancel Cancels a scheduled payment.
ScheduledPaymentsApi settleScheduledPayment POST /scheduled-payments/{key}/settle-remaining Settles all remaining installments in a scheduled payment.
ScheduledPaymentsApi unblockScheduledPayment POST /scheduled-payments/{key}/unblock Unblocks a scheduled payment.
SessionsApi disconnectSession DELETE /sessions/{sessionToken} Disconnects a session.
SessionsApi disconnectUserSessions DELETE /{user}/sessions Disconnects all sessions of a user.
SessionsApi getSessionDataForSearch GET /sessions/data-for-search Returns data for searching user sessions
SessionsApi loginUser POST /sessions Logins a user, returning data from the new session
SessionsApi searchSessions GET /sessions Search for sessions
ShoppingCartsApi addItemToShoppingCart POST /shopping-carts/items/{ad} Adds the given webshop ad to the corresponding shopping cart.
ShoppingCartsApi adjustAndGetShoppingCartDetails POST /shopping-carts/{id}/adjust Adjusts a shopping cart items, returning its details.
ShoppingCartsApi checkoutShoppingCart POST /shopping-carts/{id}/checkout Checks out a shopping cart.
ShoppingCartsApi getShoppingCartDataForCheckout GET /shopping-carts/{id}/data-for-checkout Returns configuration data for check-out a shopping cart.
ShoppingCartsApi getShoppingCartDetails GET /shopping-carts/{id} Returns details of a shopping cart.
ShoppingCartsApi getShoppingCarts GET /shopping-carts Returns the shopping carts list.
ShoppingCartsApi modifyItemQuantityOnShoppingCart PUT /shopping-carts/items/{ad} Modifies the corresponding cart with the new quantity for the given webshop ad.
ShoppingCartsApi removeItemFromShoppingCart DELETE /shopping-carts/items/{ad} Removes the given webshop ad from the corresponding shopping cart.
ShoppingCartsApi removeShoppingCart DELETE /shopping-carts/{id} Removes a shopping cart.
TOTPApi activateTotpSecret POST /totp-secret/activate Finishes the activation process of the TOTP for the logged user.
TOTPApi deleteUserTotpSecret DELETE /{user}/totp-secret Removes the TOTP secret of a user.
TOTPApi sendTotpSecretActivationCode POST /totp-secret/send-activaction-code Sends a activation code, so the user identity is validated before activating a TOTP.
TOTPApi verifyTotpSecretActivationCode POST /totp-secret/verify-activation-code Verifies the sent activation code, returning the secret URL for the app.
TOTPApi viewUserTotpSecret GET /{user}/totp-secret Returns information about the TOTP secret for the given user.
TicketsApi approveTicket POST /tickets/{ticket}/approve Approves a ticket by the payer.
TicketsApi cancelTicket POST /tickets/{ticket}/cancel Cancels a ticket by the receiver.
TicketsApi dataForNewTicket GET /{user}/tickets/data-for-new Returns data for create a new ticket for the given user.
TicketsApi dataForNewTicketDeprecated GET /tickets/data-for-new Returns data for create a new ticket for the logged user.
TicketsApi getTicketQrCode GET /tickets/{ticket}/qr-code Returns the QR-code image for the given ticket only if its status is `open`
TicketsApi newTicket POST /{user}/tickets Creates a new ticket with status `open` for the given user.
TicketsApi newTicketDeprecated POST /tickets Creates a new ticket with status `open` for the logged user.
TicketsApi previewTicket POST /tickets/{ticket}/preview Previews the payment generated by the ticket.
TicketsApi processTicket POST /tickets/{ticket}/process Processes a ticket by the receiver.
TicketsApi viewTicket GET /tickets/{ticket} Returns details about a ticket by ticket number
TokensApi activatePendingToken POST /tokens/{id}/activate Activates a token.
TokensApi activateToken POST /{user}/tokens/{type} Activates a pending / unassigned token.
TokensApi assignToken POST /tokens/{id}/assign/{user} Assigns a token to a given user.
TokensApi blockToken POST /tokens/{id}/block Blocks a token.
TokensApi cancelToken POST /tokens/{id}/cancel Permanently cancels a token.
TokensApi createToken POST /tokens/{type}/new Creates a new token of the given type.
TokensApi getGeneralTokensDataForSearch GET /general-tokens/{type}/data-for-search Returns data for searching tokens of a specific type.
TokensApi getTokenDataForNew GET /tokens/{type}/data-for-new Returns data to create a new token for the given type.
TokensApi getTokenQrCode GET /tokens/{id}/qr-code Returns the QR-code image for the given token only if its physical type is `qrCode`
TokensApi getUserTokens GET /{user}/tokens/{type} Returns the tokens of a type and user
TokensApi listUserTokenTypes GET /{user}/token-types Returns the permissions over token types of the given user.
TokensApi searchGeneralTokens GET /general-tokens/{type} Searches for tokens of a specific type, regardless of the user.
TokensApi setTokenActivationDeadline POST /tokens/{id}/set-activation-deadline Sets the activation deadline date of a specific token.
TokensApi setTokenExpiryDate POST /tokens/{id}/set-expiry-date Sets the expiry date of a specific token.
TokensApi unblockToken POST /tokens/{id}/unblock Unlocks a token.
TokensApi viewToken GET /tokens/{id} Returns details of a specific token
TransactionsApi exportTransaction GET /transactions/{key}/export/{format} Exports the transaction details to a file.
TransactionsApi exportTransactions GET /{owner}/transactions/export/{format} Exports the owner transactions search results as file
TransactionsApi exportTransactionsOverview GET /transactions/export/{format} Exports the transactions overview search results as file
TransactionsApi getTransactionsDataForSearch GET /{owner}/transactions/data-for-search Returns data for searching transactions of an account owner
TransactionsApi getTransactionsOverviewDataForSearch GET /transactions/data-for-search Returns data for searching transactions regardless of a owner
TransactionsApi searchTransactions GET /{owner}/transactions Searches transactions of an account owner
TransactionsApi searchTransactionsOverview GET /transactions Searches transactions regardless of a owner
TransactionsApi viewTransaction GET /transactions/{key} Returns details about a transaction
TransfersApi chargebackTransfer POST /transfers/{key}/chargeback Perform the chargeback of a transfer
TransfersApi exportTransfer GET /transfers/{key}/export/{format} Exports the transfer details to a file.
TransfersApi exportTransfers GET /transfers/export/{format} Exports the transfers search results as file
TransfersApi getTransferDataForSearch GET /transfers/data-for-search Returns configuration data for searching transfers over multiple accounts.
TransfersApi searchTransfers GET /transfers Searches for transfers over multiple accounts.
TransfersApi searchTransfersSummary GET /transfers/summary Returns totals per currency for the transfers search.
TransfersApi viewTransfer GET /transfers/{key} Returns details about a transfer
UIApi dataForUi GET /ui/data-for-ui Returns useful data required to properly display a user interface
UserStatusApi changeUserStatus POST /{user}/status Sets the new user status
UserStatusApi getUserStatus GET /{user}/status Returns the current user status and the status history
UsersApi createUser POST /users Registers a new user
UsersApi deletePendingUser DELETE /users/{user} Permanently removes a pending user
UsersApi exportUsers GET /users/export/{format} Exports the user search results to a file
UsersApi getDataForEditFullProfile GET /users/{user}/data-for-edit-profile Returns data for editing the full profile of a user / operator
UsersApi getDataForMapDirectory GET /users/map/data-for-search Get configuration data for searching the user directory (map).
UsersApi getGroupsForUserRegistration GET /users/groups-for-registration Returns the groups the authenticated user or guest can register on
UsersApi getUserDataForEdit GET /users/{user}/data-for-edit Get configuration data to edit a user / operator profile
UsersApi getUserDataForNew GET /users/data-for-new Get configuration data for registering new users
UsersApi getUserDataForSearch GET /users/data-for-search Get configuration data for searching users
UsersApi locateUser GET /users/{user}/locate View user basic details
UsersApi saveUserFullProfile POST /users/{user}/profile Saves the full profile at once
UsersApi searchMapDirectory GET /users/map Search the user directory (map)
UsersApi searchUsers GET /users Search for users
UsersApi updateUser PUT /users/{user} Save a user / operator profile fields
UsersApi validateUserRegistrationField GET /users/validate/{group}/{field} Validates the value of a single field for user registration
UsersApi viewUser GET /users/{user} View a user / operator details
ValidationApi manuallyValidateEmailChange POST /{user}/email-change/validate Manually validates a pending e-mail change.
ValidationApi manuallyValidateUserRegistration POST /{user}/registration/validate Manually validates a pending user / operator registration.
ValidationApi resendEmailChangeEmail POST /{user}/email-change/resend Re-sends the e-mail to validate a pending e-mail change.
ValidationApi resendUserRegistrationEmail POST /{user}/registration/resend Re-sends the e-mail to validate a pending user / operator registration.
ValidationApi validateEmailChange POST /validate/email-change/{key} Validate a pending e-mail change.
ValidationApi validateUserRegistration POST /validate/registration/{key} Validate a pending user registration.
VoucherInfoApi activateGiftVoucher POST /voucher-info/{token}/activate-gift Activates a gift voucher with a PIN.
VoucherInfoApi changeVoucherInfoNotificationSettings POST /voucher-info/{token}/notification-settings Changes the voucher notifications configuration.
VoucherInfoApi changeVoucherInfoPin POST /voucher-info/{token}/change-pin Changes the pin of a particular voucher.
VoucherInfoApi getVoucherInfo GET /voucher-info/{token} Returns data for the voucher information page
VoucherInfoApi getVoucherInfoData GET /voucher-info Returns data for the voucher information page
VoucherInfoApi resendVoucherInfoPin POST /voucher-info/{token}/resend-pin Re-sends the voucher pin to its e-mail/mobile phone.
VoucherInfoApi searchVoucherInfoTransactions GET /voucher-info/{token}/transactions Searches for transactions of a particular voucher in the information page
VoucherInfoApi unblockVoucherInfo POST /voucher-info/{token}/unblock Unblock a voucher.
VouchersApi assignVoucher POST /vouchers/{key}/assign Assigns a generated and open voucher to a user.
VouchersApi buyVouchers POST /{user}/vouchers/buy Buys one or more vouchers for the given user
VouchersApi buyVouchersWithStatus POST /{user}/vouchers/buy-with-status Buys one or more vouchers for the given user returning the status.
VouchersApi cancelVoucher POST /vouchers/{key}/cancel Cancels the voucher
VouchersApi changeVoucherExpirationDate POST /vouchers/{key}/change-expiration Changes the voucher expiration.
VouchersApi changeVoucherNotificationSettings POST /vouchers/{key}/change-notification-settings Changes a voucher's notification settings.
VouchersApi changeVoucherPin POST /vouchers/{key}/change-pin Changes the pin of a particular voucher.
VouchersApi exportUserVouchers GET /{user}/vouchers/export/{format} Exports the vouchers search results as file.
VouchersApi exportVoucher GET /vouchers/{key}/export/{format} Exports a voucher details as file.
VouchersApi exportVoucherTransaction GET /voucher-transactions/{id}/export/{format} Exports the given voucher transaction as file.
VouchersApi exportVouchers GET /vouchers/export/{format} Exports the vouchers search results as file.
VouchersApi generateVouchers POST /vouchers/generate Generate one or more vouchers.
VouchersApi getGeneralVouchersDataForSearch GET /vouchers/data-for-search Returns data for searching vouchers as admin
VouchersApi getUserVoucherTransactionsDataForSearch GET /{user}/voucher-transactions/data-for-search Returns configuration data for searching for voucher transactions
VouchersApi getUserVouchersDataForSearch GET /{user}/vouchers/data-for-search Returns data for searching vouchers owned by a user
VouchersApi getVoucherDataForBuy GET /{user}/vouchers/data-for-buy Returns data for buying a voucher of a specified type or the list of types to buy.
VouchersApi getVoucherDataForGenerate GET /vouchers/data-for-generate Returns data for generate vouchers of a specified type or the list of types to generate.
VouchersApi getVoucherDataForRedeem GET /{user}/vouchers/{token}/data-for-redeem Returns data for redeeming a voucher by token
VouchersApi getVoucherDataForSend GET /{user}/vouchers/data-for-send Returns data for sending a voucher by e-mail of a specified type or the list of types to send.
VouchersApi getVoucherDataForTopUp GET /{user}/vouchers/{token}/data-for-top-up Returns data for topping-up a voucher by token
VouchersApi getVoucherInitialDataForRedeem GET /{user}/vouchers/data-for-redeem Returns initial data for redeeming vouchers
VouchersApi getVoucherInitialDataForTopUp GET /{user}/vouchers/data-for-top-up Returns initial data for topping-up vouchers
VouchersApi getVoucherQrCode GET /vouchers/{key}/qr-code Returns the QR-code image for the given voucher
VouchersApi previewBuyVouchers POST /{user}/vouchers/preview-buy Previews the buying of one or more vouchers for the given user.
VouchersApi previewSendVoucher POST /{user}/vouchers/preview-send Previews buingy a voucher and sending it to an e-mail address.
VouchersApi previewVoucherRedeem POST /{user}/vouchers/{token}/preview-redeem Previews a voucher top-up for the given user.
VouchersApi previewVoucherTopUp POST /{user}/vouchers/{token}/preview-top-up Previews a voucher top-up for the given user.
VouchersApi redeemVoucher POST /{user}/vouchers/{token}/redeem Redeems a voucher for the given user
VouchersApi resendPin POST /vouchers/{key}/resend-pin Re-sends a the voucher PIN to the client
VouchersApi resendVoucherEmail POST /vouchers/{key}/resend-email Re-sends a sent voucher to its destination e-mail address.
VouchersApi searchUserVoucherTransactions GET /{user}/voucher-transactions Searches for vouchers transactions a user has performed.
VouchersApi searchUserVouchers GET /{user}/vouchers Searches for vouchers a user owns or has bought.
VouchersApi searchVoucherTransactions GET /vouchers/{key}/transactions Searches for transactions of a particular voucher.
VouchersApi searchVouchers GET /vouchers Searches for vouchers as admin
VouchersApi sendVoucher POST /{user}/vouchers/send Buy a voucher and send it to an e-mail address
VouchersApi topUpVoucher POST /{user}/vouchers/{token}/top-up Tops-up a voucher for the given user.
VouchersApi unblockVoucherPin POST /vouchers/{key}/unblock-pin Unblocks the voucher PIN
VouchersApi viewVoucher GET /vouchers/{key} Returns data for a particular voucher
VouchersApi viewVoucherTransaction GET /voucher-transactions/{id} Returns details about a voucher transaction
WebshopSettingsApi updateWebshopSettings PUT /{user}/webshop-settings Updates a user's webshop settings.
WebshopSettingsApi viewWebshopSettings GET /{user}/webshop-settings Returns the webshop settings for a given user.
WizardsApi backWizardExecution POST /wizard-executions/{key}/back Goes back one or more steps in a wizard execution.
WizardsApi cancelWizardExecution DELETE /wizard-executions/{key} Cancels a wizard execution, removing all associated context.
WizardsApi getCurrentWizardExecution GET /wizard-executions/{key} Returns the wizard execution data for the current step.
WizardsApi redirectWizardExecution POST /wizard-executions/{key}/redirect Prepares an external redirect in a wizard execution.
WizardsApi runWizardCallback POST /wizard-executions/{key}/callback Runs the callback of an external redirect wizard step.
WizardsApi sendWizardVerificationCode POST /wizard-executions/{key}/verification-code Sends a code to verify either e-mail or mobile phone.
WizardsApi startMenuWizard POST /menu/{menu}/wizards/start Starts the execution of a custom wizard from a custom menu entry.
WizardsApi startUserWizard POST /users/{user}/wizards/{key}/start Starts the execution of a custom wizard over a given user.
WizardsApi startWizard POST /wizards/{key}/start Starts the execution of a custom wizard without a scope.
WizardsApi transitionWizardExecution POST /wizard-executions/{key} Transitions a wizard from a step to another, or finishes the wizard

Models

Authorization

Authentication schemes defined for the API:

basic

  • Type: HTTP basic authentication

session

  • Type: API key
  • API key parameter name: Session-Token
  • Location: HTTP header

accessClient

  • Type: API key
  • API key parameter name: Access-Client-Token
  • Location: HTTP header

oidc

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 4.16.3
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen