Skip to content
BranchesTags

Repository files navigation

cyclos_471_api

Cyclos471Api - JavaScript client for cyclos_471_api The REST API for Cyclos 4.7.1 This SDK is automatically generated by the Swagger Codegen project:

  • API version: 4.7.1
  • Package version: 4.7.1
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cyclos_471_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install off-bank/cyclos-4.7-js-api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var Cyclos471Api = require('cyclos_471_api');

var defaultClient = Cyclos471Api.ApiClient.instance;

// Configure API key authorization: session
var session = defaultClient.authentications['session'];
session.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//session.apiKeyPrefix['Session-Token'] = "Token"

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME'
basic.password = 'YOUR PASSWORD'

// Configure API key authorization: accessClient
var accessClient = defaultClient.authentications['accessClient'];
accessClient.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//accessClient.apiKeyPrefix['Access-Client-Token'] = "Token"

var api = new Cyclos471Api.AccountsApi()

var owner = "owner_example"; // {String} Either an user identification, supporting either the value 'self' (sans quotes) for the currently authenticated user or an identification method for an user, or the value 'system' (sans quotes) for system data. 

var accountType = "accountType_example"; // {String} The internal name or id of the account type

var opts = { 
  'fields': ["fields_example"] // {[String]} Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`).  
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountHistoryDataByOwnerAndType(owner, accountType, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://communities.cyclos.org/wootsapp/api

Class Method HTTP request Description
Cyclos471Api.AccountsApi getAccountHistoryDataByOwnerAndType GET /{owner}/accounts/{accountType}/data-for-history Returns data for searching an account history by owner and type
Cyclos471Api.AccountsApi getAccountStatusByOwnerAndType GET /{owner}/accounts/{accountType} Returns the status of an account by owner and type
Cyclos471Api.AccountsApi getUserBalancesData GET /accounts/data-for-user-balances Returns data for searching users together with their balances
Cyclos471Api.AccountsApi getUserBalancesSummary GET /accounts/{accountType}/user-balances/summary Returns summarized information for the user balances search
Cyclos471Api.AccountsApi listAccountsByOwner GET /{owner}/accounts Lists accounts of the given owner with their statuses
Cyclos471Api.AccountsApi searchAccountHistory GET /{owner}/accounts/{accountType}/history Search an account history
Cyclos471Api.AccountsApi searchUsersWithBalances GET /accounts/{accountType}/user-balances Searches for users together with balance information
Cyclos471Api.AddressesApi createAddress POST /{user}/addresses Creates a new address for the given user
Cyclos471Api.AddressesApi deleteAddress DELETE /addresses/{id} Removes an address
Cyclos471Api.AddressesApi getAddressDataForEdit GET /addresses/{id}/data-for-edit Returns data to edit a new address
Cyclos471Api.AddressesApi getAddressDataForNew GET /{user}/addresses/data-for-new Returns data to create a new address
Cyclos471Api.AddressesApi getUserAddressesListData GET /{user}/addresses/list-data Returns data for addresses listing of the given user
Cyclos471Api.AddressesApi getUserPrimaryAddress GET /{user}/addresses/primary Returns the primary address of a given user
Cyclos471Api.AddressesApi listAddressesByUser GET /{user}/addresses Lists all (visible) user addresses
Cyclos471Api.AddressesApi listCountries GET /addresses/countries Lists all known countries with the ISO code and display name
Cyclos471Api.AddressesApi updateAddress PUT /addresses/{id} Updates an existing address
Cyclos471Api.AddressesApi viewAddress GET /addresses/{id} Returns details of a specific address
Cyclos471Api.AgreementsApi acceptPendingAgreement POST /agreements/accept Accept one or more agreements
Cyclos471Api.AgreementsApi listPendingAgreements GET /agreements/pending Returns the agreements the authenticated user needs to accept in order to use the system
Cyclos471Api.AuthApi changeForgottenPassword POST /auth/forgotten-password Changes the a forgotten password after have completed the request
Cyclos471Api.AuthApi disconnectCurrentClient DELETE /auth/access-client Disconnect the current access client
Cyclos471Api.AuthApi forgottenPasswordRequest POST /auth/forgotten-password/request Requests a forgotten password, notifying the user with instructions to reset it
Cyclos471Api.AuthApi getCurrentAuth GET /auth Returns data about the currently authenticated user
Cyclos471Api.AuthApi getDataForChangeForgottenPassword GET /auth/forgotten-password/data-for-change Returns configuration data used to change a forgotten password after the initial request
Cyclos471Api.AuthApi getDataForLogin GET /auth/data-for-login Returns data containing the configuration for logging-in
Cyclos471Api.AuthApi login POST /auth/session Logs-in the currently authenticated user
Cyclos471Api.AuthApi logout DELETE /auth/session Log-out the current session
Cyclos471Api.AuthApi newOtp POST /auth/otp Generates a new One-Time-Password (OTP) for the authenticated user
Cyclos471Api.CaptchaApi getCaptchaContent GET /captcha/{id} Returns a captcha image content
Cyclos471Api.CaptchaApi newCaptcha POST /captcha Returns a new captcha challenge
Cyclos471Api.ClientsApi activateClient POST /clients/activate Activates an access client
Cyclos471Api.ClientsApi listClientTypesForUser GET /{user}/client-types Returns the list of access clients types for an user
Cyclos471Api.ClientsApi unassignClient POST /clients/{key}/unassign Unassign (disconnects) an access client
Cyclos471Api.ClientsApi viewClient GET /clients/{key} Returns details of an access client
Cyclos471Api.ContactsApi addContact POST /{user}/contacts/{contact} Adds an user in the contact list of the given user
Cyclos471Api.ContactsApi removeContact DELETE /{user}/contacts/{contact} Removes an user from the contact list of the given user
Cyclos471Api.ContactsApi searchContacts GET /{user}/contacts Search for an user contacts
Cyclos471Api.ImagesApi deleteImage DELETE /images/{id} Removes an image by id
Cyclos471Api.ImagesApi getAdImagesListData GET /marketplace/{id}/images/list-data Returns the images of an advertisement, plus additional permissions and data
Cyclos471Api.ImagesApi getImageContent GET /images/{kind}/{file} Returns an image content
Cyclos471Api.ImagesApi getUserImagesListData GET /{user}/images/list-data Returns either `profile` or `custom` images for a given user, plus additional permissions and data
Cyclos471Api.ImagesApi listAdImages GET /marketplace/{id}/images Lists the images of an advertisement
Cyclos471Api.ImagesApi listTempImages GET /images/temp Lists temporary images related to the currently authenticated user or guest
Cyclos471Api.ImagesApi listUserImages GET /{user}/images Lists either `profile` or `custom` images for a given user
Cyclos471Api.ImagesApi reorderAdImages PUT /marketplace/{id}/images/order Changes the order of the images of an advertisement
Cyclos471Api.ImagesApi reorderProfileImages PUT /{user}/images/order Changes the order of an user's profile images
Cyclos471Api.ImagesApi uploadAdImage POST /marketplace/{id}/images Adds a new image for the given advertisement.
Cyclos471Api.ImagesApi uploadTempImage POST /images/temp Adds a new temporary image for the currently authenticated user or guest.
Cyclos471Api.ImagesApi uploadUserImage POST /{user}/images Adds a new image for the given user. The image kind is either `profile` or `custom`.
Cyclos471Api.ImagesApi viewImage GET /images/{id} Returns an image details by id
Cyclos471Api.MarketplaceApi createAd POST /{user}/marketplace Creates a new advertisement for the given user
Cyclos471Api.MarketplaceApi deleteAd DELETE /marketplace/{id} Removes an advertisement
Cyclos471Api.MarketplaceApi getAdDataForEdit GET /marketplace/{id}/data-for-edit Returns data for editing an advertisement
Cyclos471Api.MarketplaceApi getAdDataForNew GET /{user}/marketplace/data-for-new Returns data for creating a new advertisement for an user and kind
Cyclos471Api.MarketplaceApi getAdDataForSearch GET /marketplace/data-for-search Returns configuration data to search advertisements
Cyclos471Api.MarketplaceApi getUserAdDataForSearch GET /{user}/marketplace/data-for-search Returns configuration data for searching advertisements of an user
Cyclos471Api.MarketplaceApi searchAds GET /marketplace Search for advertisements
Cyclos471Api.MarketplaceApi searchUserAds GET /{user}/marketplace Search for advertisements of a specific user
Cyclos471Api.MarketplaceApi updateAd PUT /marketplace/{id} Updates an existing ad
Cyclos471Api.MarketplaceApi viewAd GET /marketplace/{id} Returns details of an advertisement
Cyclos471Api.MobileApi dataForMobileGuest GET /mobile/data-for-guest Returns data the mobile application uses while in guest mode
Cyclos471Api.MobileApi dataForMobileUser GET /mobile/data-for-user Returns data the mobile application uses in either user or POS mode
Cyclos471Api.MobileApi mobilePageContent GET /mobile/page/{id} Returns the content of a mobile page
Cyclos471Api.NFCApi cancelNfc POST /nfc/cancel Cancels a NFC tag
Cyclos471Api.NFCApi getNfcDataForInitialize GET /nfc/data-for-initialize Returns data for NFC tag initialization. Optionally the user can personalize the tag too.
Cyclos471Api.NFCApi getNfcDataForPersonalize GET /nfc/data-for-personalize Returns data for perfornalizing an initialized NFC tag for an user
Cyclos471Api.NFCApi getNfcToken GET /nfc/{tokenType}/{value} Retrieve the NFC token detailed data
Cyclos471Api.NFCApi getOtpForPersonalizeNfc POST /nfc/personalize/otp Generates a new One-Time-Password (OTP) for a personalizing a NFC tag
Cyclos471Api.NFCApi initializeNfc POST /nfc/initialize Initializes a NFC tag
Cyclos471Api.NFCApi nfcExternalAuth POST /nfc/external-auth NFC external authentication
Cyclos471Api.NFCApi personalizeNfc POST /nfc/personalize Personalizes a NFC tag
Cyclos471Api.OperationsApi getOperationDataForRun GET /{owner}/operations/{operation}/data-for-run Returns configuration data for running a custom operation
Cyclos471Api.OperationsApi listOperationsByOwner GET /{owner}/operations Lists the custom operations over the system or user
Cyclos471Api.OperationsApi runOperation POST /{owner}/operations/{operation}/run Runs a custom operation either for system or user
Cyclos471Api.OperationsApi runOperationWithUpload POST /{owner}/operations/{operation}/run-upload Runs a custom operation either for system or user while uploading a file
Cyclos471Api.OperatorsApi getGeneralOperatorsDataForSearch GET /operators/data-for-search Get configuration data for searching operators of any managed user
Cyclos471Api.OperatorsApi getUserOperatorsDataForSearch GET /{user}/operators/data-for-search Get configuration data for searching operators of the given user
Cyclos471Api.OperatorsApi searchGeneralOperators GET /operators Search the visible operators (of any managed user)
Cyclos471Api.OperatorsApi searchUserOperators GET /{user}/operators Search the operators of a given user
Cyclos471Api.POSApi calculateReceivePaymentInstallments GET /pos/installments Calculates the default installments for a scheduled payment
Cyclos471Api.POSApi dataForReceivePayment GET /pos/data-for-pos Returns configuration data for receiving a payment (POS)
Cyclos471Api.POSApi previewReceivePayment POST /pos/preview Previews a POS payment before receiving it
Cyclos471Api.POSApi receivePayment POST /pos Receives a payment (POS)
Cyclos471Api.POSApi receivePaymentOtp POST /pos/otp Generates a new One-Time-Password (OTP) for a pos payment
Cyclos471Api.PasswordsApi changePassword POST /{user}/passwords/{type}/change Changes a manual password
Cyclos471Api.PasswordsApi disablePassword POST /{user}/passwords/{type}/disable Disables a password, making it unusable until manually re-enabled
Cyclos471Api.PasswordsApi enablePassword POST /{user}/passwords/{type}/enable Re-enables a disabled a password
Cyclos471Api.PasswordsApi generatePassword POST /passwords/{type}/generate Generates the value of a generated password for the first time
Cyclos471Api.PasswordsApi getUserPasswordsListData GET /{user}/passwords/list-data Returns the status for each passwords the given user have
Cyclos471Api.PasswordsApi listUserPasswords GET /{user}/passwords Returns the status for each passwords the given user have
Cyclos471Api.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
Cyclos471Api.PasswordsApi resetPassword POST /{user}/passwords/{type}/reset Resets a generated password, allowing it to be generated again
Cyclos471Api.PasswordsApi unblockPassword POST /{user}/passwords/{type}/unblock Unblocks a password that has been blocked by exceeding the wrong tries
Cyclos471Api.PaymentsApi calculatePerformPaymentInstallments GET /{owner}/payments/installments Calculates the default installments for a scheduled payment
Cyclos471Api.PaymentsApi dataForPerformPayment GET /{owner}/payments/data-for-perform Returns configuration data for performing a payment
Cyclos471Api.PaymentsApi performPayment POST /{owner}/payments Performs a payment from the given owner
Cyclos471Api.PaymentsApi previewPayment POST /{owner}/payments/preview Previews a payment before performing it
Cyclos471Api.PhonesApi createPhone POST /{user}/phones Creates a new phone for the given user
Cyclos471Api.PhonesApi deletePhone DELETE /phones/{id} Removes a phone
Cyclos471Api.PhonesApi disablePhoneForSms POST /phones/{id}/disable-for-sms Marks a phone as disabled to receive SMS notifications and operate in the SMS channel
Cyclos471Api.PhonesApi enablePhoneForSms POST /phones/{id}/enable-for-sms Marks a phone as enabled to receive SMS notifications and operate in the SMS channel
Cyclos471Api.PhonesApi getPhoneDataForEdit GET /phones/{id}/data-for-edit Returns data to edit a new phone
Cyclos471Api.PhonesApi getPhoneDataForNew GET /{user}/phones/data-for-new Returns data to create a new phone
Cyclos471Api.PhonesApi getUserPhonesListData GET /{user}/phones/list-data Returns data for listing an user's phones
Cyclos471Api.PhonesApi listPhonesByUser GET /{user}/phones Lists all (visible) user phones
Cyclos471Api.PhonesApi sendPhoneVerificationCode POST /phones/{id}/send-verification-code Sends the verification code for an user to verify the mobile phone
Cyclos471Api.PhonesApi updatePhone PUT /phones/{id} Updates an existing phone
Cyclos471Api.PhonesApi verifyPhone POST /phones/{id}/verify Marks a phone as verified if the code matches
Cyclos471Api.PhonesApi viewPhone GET /phones/{id} Returns details of a specific phone
Cyclos471Api.RecordsApi createRecord POST /{owner}/records/{type} Creates a new record for the given owner and type
Cyclos471Api.RecordsApi deleteRecord DELETE /records/{id} Removes a record
Cyclos471Api.RecordsApi getRecordDataForEdit GET /records/{id}/data-for-edit Returns data to edit an existing record
Cyclos471Api.RecordsApi getRecordDataForGeneralSearch GET /general-records/{type}/data-for-search Returns data for searching records of a type over any owner
Cyclos471Api.RecordsApi getRecordDataForNew GET /{owner}/records/{type}/data-for-new Returns data to create a new record
Cyclos471Api.RecordsApi getRecordDataForOwnerSearch GET /{owner}/records/{type}/data-for-search Returns data for searching records of a specific type and owner
Cyclos471Api.RecordsApi getRecordDataForSharedSearch GET /shared-records/data-for-search Returns data for searching records with shared fields
Cyclos471Api.RecordsApi getRecordTypeByOwner GET /{owner}/record-types/{type} Returns a single record type over an user or system
Cyclos471Api.RecordsApi listRecordTypesByOwner GET /{owner}/record-types Lists the record types over an user or system
Cyclos471Api.RecordsApi listRecordTypesForGeneralSearch GET /general-records/record-types Lists the record types for general search
Cyclos471Api.RecordsApi searchGeneralRecords GET /general-records/{type} Searches for records of a specific type over any owner
Cyclos471Api.RecordsApi searchOwnerRecords GET /{owner}/records/{type} Searches for records of a specific type and owner
Cyclos471Api.RecordsApi searchSharedRecords GET /shared-records Searches for records with shared fields
Cyclos471Api.RecordsApi updateRecord PUT /records/{id} Updates an existing record
Cyclos471Api.RecordsApi viewRecord GET /records/{id} Returns details of a specific record
Cyclos471Api.TransactionsApi getTransactionsDataForSearch GET /{owner}/transactions/data-for-search Returns data for searching transactions of an account owner
Cyclos471Api.TransactionsApi searchTransactions GET /{owner}/transactions Searches transactions of an account owner
Cyclos471Api.TransactionsApi viewTransaction GET /transactions/{key} Returns details about a transaction
Cyclos471Api.TransfersApi chargebackTransfer POST /transfers/{key}/chargeback Perform the chargeback of a transfer
Cyclos471Api.TransfersApi getTransferDataForSearch GET /transfers/data-for-search Returns data for searching transfers over multiple accounts
Cyclos471Api.TransfersApi searchTransfers GET /transfers Searches for transfers over multiple accounts
Cyclos471Api.TransfersApi viewTransfer GET /transfers/{key} Returns details about a transfer
Cyclos471Api.UsersApi createUser POST /users Registers a new user
Cyclos471Api.UsersApi getDataForMapDirectory GET /users/map/data-for-search Get configuration data for searching the user directory (map)
Cyclos471Api.UsersApi getGroupsForUserRegistration GET /users/groups-for-registration Returns the groups the authenticated user or guest can register on
Cyclos471Api.UsersApi getUserDataForEdit GET /users/{user}/data-for-edit Get configuration data to edit an user profile
Cyclos471Api.UsersApi getUserDataForNew GET /users/data-for-new Get configuration data for registering new users
Cyclos471Api.UsersApi getUserDataForSearch GET /users/data-for-search Get configuration data for searching users
Cyclos471Api.UsersApi searchMapDirectory GET /users/map Search the user directory (map)
Cyclos471Api.UsersApi searchUsers GET /users Search for users
Cyclos471Api.UsersApi updateUser PUT /users/{user} Save an user details
Cyclos471Api.UsersApi viewUser GET /users/{user} View an user details
Cyclos471Api.VouchersApi buyVouchers POST /{user}/vouchers/buy Buys one or more vouchers for the given user
Cyclos471Api.VouchersApi getUserVouchersDataForSearch GET /{user}/vouchers/data-for-search Returns data for searching vouchers an user has bought or redeemed
Cyclos471Api.VouchersApi getVoucherDataForBuy GET /{user}/vouchers/data-for-buy Returns data for buying a voucher of a specified type
Cyclos471Api.VouchersApi getVoucherDataForRedeem GET /{user}/vouchers/{token}/data-for-redeem Returns data for redeeming a voucher by token
Cyclos471Api.VouchersApi getVoucherInitialDataForRedeem GET /{user}/vouchers/data-for-redeem Returns initial data for redeeming vouchers
Cyclos471Api.VouchersApi getVoucherQrCode GET /vouchers/{key}/qr-code Returns the QR-code image for the given voucher
Cyclos471Api.VouchersApi redeemVoucher POST /{user}/vouchers/{token}/redeem Redeems a voucher for the given user
Cyclos471Api.VouchersApi searchUserVouchers GET /{user}/vouchers Searches for vouchers an user has bought or redeemed
Cyclos471Api.VouchersApi viewVoucher GET /vouchers/{key} Returns data for a particular voucher

Documentation for Models

Documentation for Authorization

accessClient

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

basic

  • Type: HTTP basic authentication

session

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

About

Cyclos 4.7 js API SDK

Resources

Readme
Activity

Stars

3 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases

Packages

Contributors

Languages