@forgehq/forge-direct-sdk

v1.0.9

Published

4 months ago

OpenAPI client for @forgehq/forge-direct-sdk

0High
0Medium
0Low

horacioforge

joaquin_forge

luisgalan

axios typescript openapi-client openapi-generator @forgehq/forge-direct-sdk

@forgehq/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @forgehq/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost/forge-direct

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- GameInfoApi | routesV1GameInfoGetGameInfo | GET /v1/game-info | Get game info GameInfoApi | routesV1GameInfoPatchGameInfo | PATCH /v1/game-info | Update game info HealthApi | routesHealthHealthCheck | GET /health | InboxApi | routesV1InboxDeliverBroadcastMessage | POST /v1/inbox/broadcast | Broadcast a message to all active users in a campaign InboxApi | routesV1InboxDeliverDeliverMessage | POST /v1/inbox/message | Deliver a message to a user's inbox InboxApi | routesV1InboxGetInboxLogs | GET /v1/inbox/logs | Get list of messages sent to users (paginated and sorted in descending order of time) QuestsApi | routesV1QuestsConfigDeleteQuizQuestion | DELETE /v1/quests/{quest_id}/config/quiz_quest/question/{question_id} | Delete a question from the quiz quest QuestsApi | routesV1QuestsConfigPatchQuizQuestion | PATCH /v1/quests/{quest_id}/config/quiz_quest/question/{question_id} | Update a question in the quiz quest QuestsApi | routesV1QuestsConfigPatchSurpriseQuestConfig | PATCH /v1/quests/{quest_id}/config/surprise_quest | Update surprise quest config (PATCH - partial update) QuestsApi | routesV1QuestsConfigPostQuizQuestion | POST /v1/quests/{quest_id}/config/quiz_quest/question | Add a new question to the quiz quest QuestsApi | routesV1QuestsConfigUpdateQuizQuestConfig | PUT /v1/quests/{quest_id}/config/quiz_quest | Update quiz quest config QuestsApi | routesV1QuestsConfigUpdateSurpriseQuestConfig | PUT /v1/quests/{quest_id}/config/surprise_quest | Update surprise quest config (PUT - replaces all options) QuestsApi | routesV1QuestsCreateQuest | POST /v1/quests | Create a quest QuestsApi | routesV1QuestsGetAllQuestTemplates | GET /v1/quests/quest-templates | Get all the templates QuestsApi | routesV1QuestsGetPartnerQuests | GET /v1/quests | Get all the quests QuestsApi | routesV1QuestsGetTemplateDetails | GET /v1/quests/quest-templates/{template_name} | Get specific template details QuestsApi | routesV1QuestsPatchQuest | PATCH /v1/quests/{quest_id} | Update an existing quest QuestsApi | routesV1QuestsUpdateQuest | PUT /v1/quests/{quest_id} | Update an existing quest RaffleApi | routesV1RafflesCreateRaffle | POST /v1/raffles | Create a new raffle RaffleApi | routesV1RafflesDistributeRaffle | POST /v1/raffles/{raffle_id}/distribute | Distribute a raffle to users RaffleApi | routesV1RafflesEditRaffle | PUT /v1/raffles/{raffle_id} | Update a existing raffle RaffleApi | routesV1RafflesGetAllRafflePurchases | GET /v1/raffles/purchases | Get all the raffle purchase history RaffleApi | routesV1RafflesGetPartnerRaffles | GET /v1/raffles | Get all the raffles RaffleApi | routesV1RafflesGetRaffle | GET /v1/raffles/{raffle_id} | Get all the raffle details RaffleApi | routesV1RafflesGetRaffleParticipants | GET /v1/raffles/{raffle_id}/participants | Get all the raffle participants RaffleApi | routesV1RafflesGetRafflePurchases | GET /v1/raffles/{raffle_id}/purchases | Get all the raffle purchase history RaffleApi | routesV1RafflesGetRaffleWinners | GET /v1/raffles/{raffle_id}/winners | Get all the raffle winners RaffleApi | routesV1RafflesPartialEditRaffle | PATCH /v1/raffles/{raffle_id} | Update a existing raffle RaffleApi | routesV1RafflesResolveRaffle | POST /v1/raffles/{raffle_id}/resolve | Resolve a raffle RedeemCodesApi | routesV1RedeemCodesDeleteRedeemCode | DELETE /v1/redeem-codes/{redeem_code_id} | Delete a redeem code RedeemCodesApi | routesV1RedeemCodesGetRedeemCodes | GET /v1/redeem-codes | Get redeem codes RedeemCodesApi | routesV1RedeemCodesPostRedeemCode | POST /v1/redeem-codes | Create a redeem code ReferralLinksApi | routesV1ReferralsLinksGetReferralLink | GET /v1/referrals/links/{invite_id} | Get a referral link ReferralLinksApi | routesV1ReferralsLinksGetReferralLinks | GET /v1/referrals/links | Get referral links created ReferralLinksApi | routesV1ReferralsLinksPatchReferralLink | PATCH /v1/referrals/links/{invite_id} | Update a referral link ReferralLinksApi | routesV1ReferralsLinksPostReferralLink | POST /v1/referrals/links | Create a referral link ReferralLinksApi | routesV1ReferralsLinksPutReferralLink | PUT /v1/referrals/links/{invite_id} | Update a referral link RewardsApi | routesV1RewardsCustomRewardsCodesDeleteCustomRewardCodes | DELETE /v1/rewards/{reward_id}/codes | Delete custom reward codes RewardsApi | routesV1RewardsCustomRewardsCodesPostCustomRewardCodes | POST /v1/rewards/{reward_id}/codes | Create custom reward codes RewardsApi | routesV1RewardsCustomRewardsDeleteCustomReward | DELETE /v1/rewards/{reward_id} | Delete custom reward RewardsApi | routesV1RewardsCustomRewardsEditCustomReward | PATCH /v1/rewards/{reward_id} | Update custom reward RewardsApi | routesV1RewardsCustomRewardsGetCustomReward | GET /v1/rewards/{reward_id} | Get custom reward RewardsApi | routesV1RewardsCustomRewardsGetCustomRewards | GET /v1/rewards | Get custom rewards RewardsApi | routesV1RewardsCustomRewardsPostCustomReward | POST /v1/rewards | Create custom reward with rewards codes RewardsApi | routesV1RewardsCustomRewardsPostCustomRewardDistribution | POST /v1/rewards/{reward_id}/distribution | Distribute custom reward RewardsApi | routesV1RewardsInfoGetCampaignRewardsInfo | GET /v1/rewards/info | Get campaign rewards info RewardsApi | routesV1RewardsInfoPutCampaignRewardsInfo | PATCH /v1/rewards/info | Update campaign rewards info SegmentsApi | routesV1SegmentsAddUsersToCustomSegment | POST /v1/segments/{segment_id}/users | Add users to a segment SegmentsApi | routesV1SegmentsCreateCustomSegment | POST /v1/segments | Create a custom segment SegmentsApi | routesV1SegmentsDeleteCustomSegment | DELETE /v1/segments/{segment_id} | deletes a custom segment SegmentsApi | routesV1SegmentsGetSegmentUsers | GET /v1/segments/{segment_id}/users | Get all the users in a segment SegmentsApi | routesV1SegmentsListSegments | GET /v1/segments | Get all the the Segments SegmentsApi | routesV1SegmentsRemoveUsersFromCustomSegment | DELETE /v1/segments/{segment_id}/users | Remove users from a segment SegmentsApi | routesV1SegmentsSendMessage | POST /v1/segments/{segment_id}/messages | Send a message to a segment SegmentsApi | routesV1SegmentsUpdateCustomSegmentName | PATCH /v1/segments/{segment_id} | Update the name of a segment ShopApi | routesV1ShopCreateProduct | POST /v1/shop/products | Create a product ShopApi | routesV1ShopDistributeProducts | POST /v1/shop/products/{product_id}/distribute | Distribute products to users (Product should be of codes redemption type) ShopApi | routesV1ShopGetProductPurchaseHistory | GET /v1/shop/products/{product_id}/purchases | Get all the purchases made by users of a specific product ShopApi | routesV1ShopGetPurchaseHistory | GET /v1/shop/products/purchases | Get all the purchases made by users ShopApi | routesV1ShopListProducts | GET /v1/shop/products | Get all the products ShopApi | routesV1ShopPatchProduct | PATCH /v1/shop/products/{product_id} | Update partial info of an existing product (Non xsolla product) ShopApi | routesV1ShopUpdateProduct | PUT /v1/shop/products/{product_id} | Update a existing product (Non xsolla product) TestApi | routesTestTest | GET /v1/tests | Sample test endpoint TestApi | routesTestTest1 | GET /v1/sample/{some_id} | Sample test endpoint TestApi | routesTestTest2 | POST /v1/sample/{some_id}/test | Sample test endpoint UserApi | routesV1UsersAddPoints | POST /v1/users/{user_id}/points | Allocate points to user UserApi | routesV1UsersGetAllUsers | GET /v1/users | Get list of all users UserApi | routesV1UsersGetUserInfo | GET /v1/users/{user_id} | Get user info UserApi | routesV1UsersGetUserProgress | GET /v1/users/{user_id}/progress | Get user progress UserApi | routesV1UsersQuestsAllQuestCompletions | GET /v1/users/quest-completions | Get quest completions UserApi | routesV1UsersQuestsCompleteQuest | POST /v1/users/{user_id}/quests/{quest_id}/completion | Mark a quest as completed UserApi | routesV1UsersQuestsGetUserQuests | GET /v1/users/{user_id}/quests | Get quests assigned to the user UserApi | routesV1UsersReferralsGetUserReferrals | GET /v1/users/{user_id}/referrals | Get user's detailed referral stats UserApi | routesV1UsersVaultGetUserVault | GET /v1/users/{user_id}/vault | Get list of all items in user's vault

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key_auth

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

jwt-registered

Type: Bearer authentication (JWT)

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme