1.0.0 • Published 1 year ago

versify-client v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

versify-client

VersifyClient - JavaScript client for versify-client Versify API This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.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 versify-client --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your versify-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 GIT_USER_ID/GIT_REPO_ID --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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var VersifyClient = require('versify-client');

var defaultClient = VersifyClient.ApiClient.instance;
// Configure Bearer access token for authorization: HTTPBearer
var HTTPBearer = defaultClient.authentications['HTTPBearer'];
HTTPBearer.accessToken = "YOUR ACCESS TOKEN"

var api = new VersifyClient.AccountsApi()
var account1 = {"domain":"acme.com","name":"Acme Corp"}; // {Account1} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccountV2AccountsPost(account1, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
VersifyClient.AccountsApicreateAccountV2AccountsPostPOST /v2/accountsCreate an account
VersifyClient.AccountsApideleteAccountV2AccountsAccountIdDeleteDELETE /v2/accounts/{account_id}Delete an account
VersifyClient.AccountsApigetAccountMetricsV2AccountsAccountIdMetricsGetGET /v2/accounts/{account_id}/metricsGet account metrics
VersifyClient.AccountsApigetAccountV2AccountsAccountIdGetGET /v2/accounts/{account_id}Get an account
VersifyClient.AccountsApilistAccountsV2AccountsGetGET /v2/accountsList accounts
VersifyClient.AccountsApiupdateAccountV2AccountsAccountIdPutPUT /v2/accounts/{account_id}Update an account
VersifyClient.AssetsApicreateAssetV2AssetsPostPOST /v2/assetsCreate asset
VersifyClient.AssetsApicreateAssetV2AssetsPost_0POST /v2/assetsCreate asset
VersifyClient.AssetsApideleteAssetV2AssetsAssetIdDeleteDELETE /v2/assets/{asset_id}Delete asset
VersifyClient.AssetsApideleteAssetV2AssetsAssetIdDelete_0DELETE /v2/assets/{asset_id}Delete asset
VersifyClient.AssetsApigetAssetV2AssetsAssetIdGetGET /v2/assets/{asset_id}Get asset
VersifyClient.AssetsApigetAssetV2AssetsAssetIdGet_0GET /v2/assets/{asset_id}Get asset
VersifyClient.AssetsApilistAssetsV2AssetsGetGET /v2/assetsList assets
VersifyClient.AssetsApilistAssetsV2AssetsGet_0GET /v2/assetsList assets
VersifyClient.AssetsApisearchAssetsV2AssetsSearchPostPOST /v2/assets/searchSearch assets
VersifyClient.AssetsApisearchAssetsV2AssetsSearchPost_0POST /v2/assets/searchSearch assets
VersifyClient.AssetsApiupdateAssetV2AssetsAssetIdPutPUT /v2/assets/{asset_id}Update asset
VersifyClient.AssetsApiupdateAssetV2AssetsAssetIdPut_0PUT /v2/assets/{asset_id}Update asset
VersifyClient.AuthApiaccessTokenV2OauthAccessTokenPostPOST /v2/oauth/access_tokenAccess Token
VersifyClient.AuthApiaccessTokenV2OauthAccessTokenPost_0POST /v2/oauth/access_tokenAccess Token
VersifyClient.AuthApiauthorizeV2OauthAuthorizeGetGET /v2/oauth/authorizeAuthorize
VersifyClient.AuthApiauthorizeV2OauthAuthorizeGet_0GET /v2/oauth/authorizeAuthorize
VersifyClient.ClaimsApicreateClaimV2ClaimsPostPOST /v2/claimsCreate claim
VersifyClient.ClaimsApicreateClaimV2ClaimsPost_0POST /v2/claimsCreate claim
VersifyClient.ClaimsApideleteClaimV2ClaimsClaimIdDeleteDELETE /v2/claims/{claim_id}Delete claim
VersifyClient.ClaimsApideleteClaimV2ClaimsClaimIdDelete_0DELETE /v2/claims/{claim_id}Delete claim
VersifyClient.ClaimsApigetClaimV2ClaimsClaimIdGetGET /v2/claims/{claim_id}Get claim
VersifyClient.ClaimsApigetClaimV2ClaimsClaimIdGet_0GET /v2/claims/{claim_id}Get claim
VersifyClient.ClaimsApilistClaimsV2ClaimsGetGET /v2/claimsList claims
VersifyClient.ClaimsApilistClaimsV2ClaimsGet_0GET /v2/claimsList claims
VersifyClient.ClaimsApisearchClaimsV2ClaimsSearchPostPOST /v2/claims/searchSearch claims
VersifyClient.ClaimsApisearchClaimsV2ClaimsSearchPost_0POST /v2/claims/searchSearch claims
VersifyClient.ClaimsApiupdateClaimV2ClaimsClaimIdPutPUT /v2/claims/{claim_id}Update claim
VersifyClient.ClaimsApiupdateClaimV2ClaimsClaimIdPut_0PUT /v2/claims/{claim_id}Update claim
VersifyClient.CollectionsApicreateCollectionV2CollectionsPostPOST /v2/collectionsCreate collection
VersifyClient.CollectionsApicreateCollectionV2CollectionsPost_0POST /v2/collectionsCreate collection
VersifyClient.CollectionsApideleteCollectionV2CollectionsCollectionIdDeleteDELETE /v2/collections/{collection_id}Delete collection
VersifyClient.CollectionsApideleteCollectionV2CollectionsCollectionIdDelete_0DELETE /v2/collections/{collection_id}Delete collection
VersifyClient.CollectionsApigetCollectionV2CollectionsCollectionIdGetGET /v2/collections/{collection_id}Get collection
VersifyClient.CollectionsApigetCollectionV2CollectionsCollectionIdGet_0GET /v2/collections/{collection_id}Get collection
VersifyClient.CollectionsApilistCollectionsV2CollectionsGetGET /v2/collectionsList collections
VersifyClient.CollectionsApilistCollectionsV2CollectionsGet_0GET /v2/collectionsList collections
VersifyClient.CollectionsApisearchCollectionsV2CollectionsSearchPostPOST /v2/collections/searchSearch collections
VersifyClient.CollectionsApisearchCollectionsV2CollectionsSearchPost_0POST /v2/collections/searchSearch collections
VersifyClient.CollectionsApiupdateCollectionV2CollectionsCollectionIdPutPUT /v2/collections/{collection_id}Update collection
VersifyClient.CollectionsApiupdateCollectionV2CollectionsCollectionIdPut_0PUT /v2/collections/{collection_id}Update collection
VersifyClient.ContactsApicreateContactV2ContactsPostPOST /v2/contactsCreate contact
VersifyClient.ContactsApicreateContactV2ContactsPost_0POST /v2/contactsCreate contact
VersifyClient.ContactsApideleteContactV2ContactsContactIdDeleteDELETE /v2/contacts/{contact_id}Delete contact
VersifyClient.ContactsApideleteContactV2ContactsContactIdDelete_0DELETE /v2/contacts/{contact_id}Delete contact
VersifyClient.ContactsApigetContactV2ContactsContactIdGetGET /v2/contacts/{contact_id}Get contact
VersifyClient.ContactsApigetContactV2ContactsContactIdGet_0GET /v2/contacts/{contact_id}Get contact
VersifyClient.ContactsApilistContactsV2ContactsGetGET /v2/contactsList contacts
VersifyClient.ContactsApilistContactsV2ContactsGet_0GET /v2/contactsList contacts
VersifyClient.ContactsApisearchContactsV2ContactsSearchPostPOST /v2/contacts/searchSearch contacts
VersifyClient.ContactsApisearchContactsV2ContactsSearchPost_0POST /v2/contacts/searchSearch contacts
VersifyClient.ContactsApiupdateContactV2ContactsContactIdPutPUT /v2/contacts/{contact_id}Update contact
VersifyClient.ContactsApiupdateContactV2ContactsContactIdPut_0PUT /v2/contacts/{contact_id}Update contact
VersifyClient.EventsApicreateEventV2EventsPostPOST /v2/eventsCreate event
VersifyClient.EventsApicreateEventV2EventsPost_0POST /v2/eventsCreate event
VersifyClient.EventsApideleteEventV2EventsEventIdDeleteDELETE /v2/events/{event_id}Delete event
VersifyClient.EventsApideleteEventV2EventsEventIdDelete_0DELETE /v2/events/{event_id}Delete event
VersifyClient.EventsApigetEventV2EventsEventIdGetGET /v2/events/{event_id}Get event
VersifyClient.EventsApigetEventV2EventsEventIdGet_0GET /v2/events/{event_id}Get event
VersifyClient.EventsApilistEventsV2EventsGetGET /v2/eventsList events
VersifyClient.EventsApilistEventsV2EventsGet_0GET /v2/eventsList events
VersifyClient.EventsApisearchEventsV2EventsSearchPostPOST /v2/events/searchSearch events
VersifyClient.EventsApisearchEventsV2EventsSearchPost_0POST /v2/events/searchSearch events
VersifyClient.EventsApiupdateEventV2EventsEventIdPutPUT /v2/events/{event_id}Update event
VersifyClient.EventsApiupdateEventV2EventsEventIdPut_0PUT /v2/events/{event_id}Update event
VersifyClient.JourneysApicreateJourneyV2JourneysPostPOST /v2/journeysCreate journey
VersifyClient.JourneysApicreateJourneyV2JourneysPost_0POST /v2/journeysCreate journey
VersifyClient.JourneysApideleteJourneyV2JourneysJourneyIdDeleteDELETE /v2/journeys/{journey_id}Delete journey
VersifyClient.JourneysApideleteJourneyV2JourneysJourneyIdDelete_0DELETE /v2/journeys/{journey_id}Delete journey
VersifyClient.JourneysApigetJourneyV2JourneysJourneyIdGetGET /v2/journeys/{journey_id}Get journey
VersifyClient.JourneysApigetJourneyV2JourneysJourneyIdGet_0GET /v2/journeys/{journey_id}Get journey
VersifyClient.JourneysApilistJourneysV2JourneysGetGET /v2/journeysList journeys
VersifyClient.JourneysApilistJourneysV2JourneysGet_0GET /v2/journeysList journeys
VersifyClient.JourneysApisearchJourneysV2JourneysSearchPostPOST /v2/journeys/searchSearch journeys
VersifyClient.JourneysApisearchJourneysV2JourneysSearchPost_0POST /v2/journeys/searchSearch journeys
VersifyClient.JourneysApiupdateJourneyV2JourneysJourneyIdPutPUT /v2/journeys/{journey_id}Update journey
VersifyClient.JourneysApiupdateJourneyV2JourneysJourneyIdPut_0PUT /v2/journeys/{journey_id}Update journey
VersifyClient.MessagesApicreateMessageV2MessagesPostPOST /v2/messagesCreate message
VersifyClient.MessagesApicreateMessageV2MessagesPost_0POST /v2/messagesCreate message
VersifyClient.MessagesApideleteMessageV2MessagesMessageIdDeleteDELETE /v2/messages/{message_id}Delete message
VersifyClient.MessagesApideleteMessageV2MessagesMessageIdDelete_0DELETE /v2/messages/{message_id}Delete message
VersifyClient.MessagesApigetMessageV2MessagesMessageIdGetGET /v2/messages/{message_id}Get message
VersifyClient.MessagesApigetMessageV2MessagesMessageIdGet_0GET /v2/messages/{message_id}Get message
VersifyClient.MessagesApilistMessagesV2MessagesGetGET /v2/messagesList messages
VersifyClient.MessagesApilistMessagesV2MessagesGet_0GET /v2/messagesList messages
VersifyClient.MessagesApisearchMessagesV2MessagesSearchPostPOST /v2/messages/searchSearch messages
VersifyClient.MessagesApisearchMessagesV2MessagesSearchPost_0POST /v2/messages/searchSearch messages
VersifyClient.MessagesApiupdateMessageV2MessagesMessageIdPutPUT /v2/messages/{message_id}Update message
VersifyClient.MessagesApiupdateMessageV2MessagesMessageIdPut_0PUT /v2/messages/{message_id}Update message
VersifyClient.MintsApicreateMintV2MintsPostPOST /v2/mintsCreate mint
VersifyClient.MintsApicreateMintV2MintsPost_0POST /v2/mintsCreate mint
VersifyClient.MintsApideleteMintV2MintsMintIdDeleteDELETE /v2/mints/{mint_id}Delete mint
VersifyClient.MintsApideleteMintV2MintsMintIdDelete_0DELETE /v2/mints/{mint_id}Delete mint
VersifyClient.MintsApigetMintV2MintsMintIdGetGET /v2/mints/{mint_id}Get mint
VersifyClient.MintsApigetMintV2MintsMintIdGet_0GET /v2/mints/{mint_id}Get mint
VersifyClient.MintsApilistMintsV2MintsGetGET /v2/mintsList mints
VersifyClient.MintsApilistMintsV2MintsGet_0GET /v2/mintsList mints
VersifyClient.MintsApisearchMintsV2MintsSearchPostPOST /v2/mints/searchSearch mints
VersifyClient.MintsApisearchMintsV2MintsSearchPost_0POST /v2/mints/searchSearch mints
VersifyClient.MintsApiupdateMintV2MintsMintIdPutPUT /v2/mints/{mint_id}Update mint
VersifyClient.MintsApiupdateMintV2MintsMintIdPut_0PUT /v2/mints/{mint_id}Update mint
VersifyClient.NotesApicreateNoteV2NotesPostPOST /v2/notesCreate note
VersifyClient.NotesApicreateNoteV2NotesPost_0POST /v2/notesCreate note
VersifyClient.NotesApideleteNoteV2NotesNoteIdDeleteDELETE /v2/notes/{note_id}Delete note
VersifyClient.NotesApideleteNoteV2NotesNoteIdDelete_0DELETE /v2/notes/{note_id}Delete note
VersifyClient.NotesApigetNoteV2NotesNoteIdGetGET /v2/notes/{note_id}Get note
VersifyClient.NotesApigetNoteV2NotesNoteIdGet_0GET /v2/notes/{note_id}Get note
VersifyClient.NotesApilistNotesV2NotesGetGET /v2/notesList notes
VersifyClient.NotesApilistNotesV2NotesGet_0GET /v2/notesList notes
VersifyClient.NotesApisearchNotesV2NotesSearchPostPOST /v2/notes/searchSearch notes
VersifyClient.NotesApisearchNotesV2NotesSearchPost_0POST /v2/notes/searchSearch notes
VersifyClient.NotesApiupdateNoteV2NotesNoteIdPutPUT /v2/notes/{note_id}Update note
VersifyClient.NotesApiupdateNoteV2NotesNoteIdPut_0PUT /v2/notes/{note_id}Update note
VersifyClient.RedemptionsApicreateRedemptionV2RedemptionsPostPOST /v2/redemptionsCreate redemption
VersifyClient.RedemptionsApicreateRedemptionV2RedemptionsPost_0POST /v2/redemptionsCreate redemption
VersifyClient.RedemptionsApideleteRedemptionV2RedemptionsRedemptionIdDeleteDELETE /v2/redemptions/{redemption_id}Delete redemption
VersifyClient.RedemptionsApideleteRedemptionV2RedemptionsRedemptionIdDelete_0DELETE /v2/redemptions/{redemption_id}Delete redemption
VersifyClient.RedemptionsApigetRedemptionV2RedemptionsRedemptionIdGetGET /v2/redemptions/{redemption_id}Get redemption
VersifyClient.RedemptionsApigetRedemptionV2RedemptionsRedemptionIdGet_0GET /v2/redemptions/{redemption_id}Get redemption
VersifyClient.RedemptionsApilistRedemptionsV2RedemptionsGetGET /v2/redemptionsList redemptions
VersifyClient.RedemptionsApilistRedemptionsV2RedemptionsGet_0GET /v2/redemptionsList redemptions
VersifyClient.RedemptionsApisearchRedemptionsV2RedemptionsSearchPostPOST /v2/redemptions/searchSearch redemptions
VersifyClient.RedemptionsApisearchRedemptionsV2RedemptionsSearchPost_0POST /v2/redemptions/searchSearch redemptions
VersifyClient.RedemptionsApiupdateRedemptionV2RedemptionsRedemptionIdPutPUT /v2/redemptions/{redemption_id}Update redemption
VersifyClient.RedemptionsApiupdateRedemptionV2RedemptionsRedemptionIdPut_0PUT /v2/redemptions/{redemption_id}Update redemption
VersifyClient.RewardsApicreateRewardV2RewardsPostPOST /v2/rewardsCreate reward
VersifyClient.RewardsApicreateRewardV2RewardsPost_0POST /v2/rewardsCreate reward
VersifyClient.RewardsApideleteRewardV2RewardsRewardIdDeleteDELETE /v2/rewards/{reward_id}Delete reward
VersifyClient.RewardsApideleteRewardV2RewardsRewardIdDelete_0DELETE /v2/rewards/{reward_id}Delete reward
VersifyClient.RewardsApigetRewardV2RewardsRewardIdGetGET /v2/rewards/{reward_id}Get reward
VersifyClient.RewardsApigetRewardV2RewardsRewardIdGet_0GET /v2/rewards/{reward_id}Get reward
VersifyClient.RewardsApilistRewardsV2RewardsGetGET /v2/rewardsList rewards
VersifyClient.RewardsApilistRewardsV2RewardsGet_0GET /v2/rewardsList rewards
VersifyClient.RewardsApisearchRewardsV2RewardsSearchPostPOST /v2/rewards/searchSearch rewards
VersifyClient.RewardsApisearchRewardsV2RewardsSearchPost_0POST /v2/rewards/searchSearch rewards
VersifyClient.RewardsApiupdateRewardV2RewardsRewardIdPutPUT /v2/rewards/{reward_id}Update reward
VersifyClient.RewardsApiupdateRewardV2RewardsRewardIdPut_0PUT /v2/rewards/{reward_id}Update reward
VersifyClient.TagsApicreateTagV2TagsPostPOST /v2/tagsCreate tag
VersifyClient.TagsApicreateTagV2TagsPost_0POST /v2/tagsCreate tag
VersifyClient.TagsApideleteTagV2TagsTagIdDeleteDELETE /v2/tags/{tag_id}Delete tag
VersifyClient.TagsApideleteTagV2TagsTagIdDelete_0DELETE /v2/tags/{tag_id}Delete tag
VersifyClient.TagsApigetTagV2TagsTagIdGetGET /v2/tags/{tag_id}Get tag
VersifyClient.TagsApigetTagV2TagsTagIdGet_0GET /v2/tags/{tag_id}Get tag
VersifyClient.TagsApilistTagsV2TagsGetGET /v2/tagsList tags
VersifyClient.TagsApilistTagsV2TagsGet_0GET /v2/tagsList tags
VersifyClient.TagsApisearchTagsV2TagsSearchPostPOST /v2/tags/searchSearch tags
VersifyClient.TagsApisearchTagsV2TagsSearchPost_0POST /v2/tags/searchSearch tags
VersifyClient.TagsApiupdateTagV2TagsTagIdPutPUT /v2/tags/{tag_id}Update tag
VersifyClient.TagsApiupdateTagV2TagsTagIdPut_0PUT /v2/tags/{tag_id}Update tag
VersifyClient.UsersApigetCurrentUserV2UsersMeGetGET /v2/users/meGet current user
VersifyClient.UsersApiupdateCurrentUserV2UsersMePutPUT /v2/users/meUpdate current user
VersifyClient.WebhooksApicreateWebhookV2WebhooksPostPOST /v2/webhooksCreate webhook
VersifyClient.WebhooksApicreateWebhookV2WebhooksPost_0POST /v2/webhooksCreate webhook
VersifyClient.WebhooksApideleteWebhookV2WebhooksWebhookIdDeleteDELETE /v2/webhooks/{webhook_id}Delete webhook
VersifyClient.WebhooksApideleteWebhookV2WebhooksWebhookIdDelete_0DELETE /v2/webhooks/{webhook_id}Delete webhook
VersifyClient.WebhooksApigetWebhookV2WebhooksWebhookIdGetGET /v2/webhooks/{webhook_id}Get webhook
VersifyClient.WebhooksApigetWebhookV2WebhooksWebhookIdGet_0GET /v2/webhooks/{webhook_id}Get webhook
VersifyClient.WebhooksApilistWebhooksV2WebhooksGetGET /v2/webhooksList webhooks
VersifyClient.WebhooksApilistWebhooksV2WebhooksGet_0GET /v2/webhooksList webhooks
VersifyClient.WebhooksApisearchWebhooksV2WebhooksSearchPostPOST /v2/webhooks/searchSearch webhooks
VersifyClient.WebhooksApisearchWebhooksV2WebhooksSearchPost_0POST /v2/webhooks/searchSearch webhooks
VersifyClient.WebhooksApiupdateWebhookV2WebhooksWebhookIdPutPUT /v2/webhooks/{webhook_id}Update webhook
VersifyClient.WebhooksApiupdateWebhookV2WebhooksWebhookIdPut_0PUT /v2/webhooks/{webhook_id}Update webhook

Documentation for Models

Documentation for Authorization

HTTPBearer

  • Type: Bearer authentication