metafab-javascript v1.5.1

metafab-javascript

MetafabJavascript - JavaScript client for metafab-javascript Complete MetaFab API references and guides can be found at: https://trymetafab.com This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.5.1
• Package version: 1.5.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://trymetafab.com

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 metafab-javascript --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 metafab-javascript 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 MetafabJavascript = require('metafab-javascript');


var api = new MetafabJavascript.ContractsApi()
var xAuthorization = game_sk_02z4Mv3c85Ig0gNowY9Dq0N2kjb1xwzr27ArLE0669RrRI6dLf822iPO26K1p1FP; // {String} The `secretKey` of the authenticating game.
var createContractRequest = new MetafabJavascript.CreateContractRequest(); // {CreateContractRequest} 
api.createContract(xAuthorization, createContractRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.trymetafab.com

Documentation for Models

• MetafabJavascript.ApproveEcosystemGameRequest
• MetafabJavascript.AuthGame200Response
• MetafabJavascript.AuthGame200ResponseAllOf
• MetafabJavascript.AuthPlayer200Response
• MetafabJavascript.AuthPlayer200ResponseAllOf
• MetafabJavascript.AuthProfile200Response
• MetafabJavascript.BatchMintCollectionItemsRequest
• MetafabJavascript.BatchTransferCollectionItemsRequest
• MetafabJavascript.BatchTransferCurrencyRequest
• MetafabJavascript.BurnCollectionItemRequest
• MetafabJavascript.BurnCurrencyRequest
• MetafabJavascript.CollectionItem
• MetafabJavascript.CollectionItemAttributesInner
• MetafabJavascript.CollectionItemAttributesInnerValue
• MetafabJavascript.CollectionModel
• MetafabJavascript.ContractModel
• MetafabJavascript.CreateCollection200Response
• MetafabJavascript.CreateCollection200ResponseAllOf
• MetafabJavascript.CreateCollection200ResponseAllOfContract
• MetafabJavascript.CreateCollection200ResponseAllOfContractAllOf
• MetafabJavascript.CreateCollectionItemRequest
• MetafabJavascript.CreateCollectionItemRequestAttributesInner
• MetafabJavascript.CreateCollectionRequest
• MetafabJavascript.CreateContractRequest
• MetafabJavascript.CreateCurrency200Response
• MetafabJavascript.CreateCurrencyRequest
• MetafabJavascript.CreateEcosystemRequest
• MetafabJavascript.CreateGameRequest
• MetafabJavascript.CreateLootboxManager200Response
• MetafabJavascript.CreateLootboxManagerRequest
• MetafabJavascript.CreatePlayerRequest
• MetafabJavascript.CreateProfilePlayerRequest
• MetafabJavascript.CreateProfileRequest
• MetafabJavascript.CreateShop200Response
• MetafabJavascript.CreateShopRequest
• MetafabJavascript.CreateWalletSignatureRequest
• MetafabJavascript.CurrencyModel
• MetafabJavascript.EcosystemGameModel
• MetafabJavascript.EcosystemModel
• MetafabJavascript.GameModel
• MetafabJavascript.GetCollections200ResponseInner
• MetafabJavascript.GetCollections200ResponseInnerAllOf
• MetafabJavascript.GetCurrencies200ResponseInner
• MetafabJavascript.GetCurrencyFees200Response
• MetafabJavascript.GetLootboxManagers200ResponseInner
• MetafabJavascript.GetPlayerData200Response
• MetafabJavascript.GetProfileGames200ResponseInner
• MetafabJavascript.GetShops200ResponseInner
• MetafabJavascript.GrantCollectionRoleRequest
• MetafabJavascript.GrantCurrencyRoleRequest
• MetafabJavascript.LootboxManagerLootbox
• MetafabJavascript.LootboxManagerModel
• MetafabJavascript.MintCollectionItemRequest
• MetafabJavascript.MintCurrencyRequest
• MetafabJavascript.PlayerModel
• MetafabJavascript.ProfileModel
• MetafabJavascript.ProfilePermissionsValue
• MetafabJavascript.PublicEcosystem
• MetafabJavascript.PublicGame
• MetafabJavascript.PublicPlayer
• MetafabJavascript.PublicPlayerCustodialWallet
• MetafabJavascript.PublicProfile
• MetafabJavascript.RemovePlayerConnectedWalletRequest
• MetafabJavascript.RevokeCollectionRoleRequest
• MetafabJavascript.SetCollectionApprovalRequest
• MetafabJavascript.SetCollectionItemTimelockRequest
• MetafabJavascript.SetCurrencyFeesRequest
• MetafabJavascript.SetLootboxManagerLootboxRequest
• MetafabJavascript.SetPlayerConnectedWallet200Response
• MetafabJavascript.SetPlayerConnectedWalletRequest
• MetafabJavascript.SetPlayerDataRequest
• MetafabJavascript.SetShopOfferRequest
• MetafabJavascript.ShopModel
• MetafabJavascript.ShopOffer
• MetafabJavascript.TransactionModel
• MetafabJavascript.TransferCollectionItemRequest
• MetafabJavascript.TransferContractOwnershipRequest
• MetafabJavascript.TransferCurrencyRequest
• MetafabJavascript.UpdateEcosystemRequest
• MetafabJavascript.UpdateGame200Response
• MetafabJavascript.UpdateGame200ResponseAllOf
• MetafabJavascript.UpdateGameRequest
• MetafabJavascript.UpdatePlayer200Response
• MetafabJavascript.UpdatePlayerRequest
• MetafabJavascript.UpdateProfilePlayer200Response
• MetafabJavascript.UpdateProfilePlayer200ResponseAllOf
• MetafabJavascript.UpdateProfilePlayerRequest
• MetafabJavascript.UpdateProfileRequest
• MetafabJavascript.UpgradeContractTrustedForwarderRequest
• MetafabJavascript.WalletModel
• MetafabJavascript.WithdrawFromShopRequest
• MetafabJavascript.WriteContractRequest
• MetafabJavascript.WriteContractRequestArgsInner

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication