Skip to content

Add 1st Iteration of SDK API Reference #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
20 tasks done
Tracked by #23
MantisClone opened this issue Sep 18, 2023 · 2 comments
Closed
20 tasks done
Tracked by #23

Add 1st Iteration of SDK API Reference #31

MantisClone opened this issue Sep 18, 2023 · 2 comments
Assignees
@MantisClone

Comments

@MantisClone
Copy link
Member

MantisClone commented Sep 18, 2023 •
edited
Loading

Towards #23

Definition of Done

Only document the 20% most important features and configurations.

  • Define documentation structure
  • Add API Reference: RequestClient constructor
    • Exponential backoff and timeout settings
  • Add API Reference: payment-processor payRequest
  • Add API Reference: RequestClient byRequestId
  • Add API Reference: RequestClient byIdentity
  • Add API Reference: RequestClient byTopic
  • Add API Reference: Request cancel
  • Add API Reference: Request accept
  • Request increaseExpectedAmount()
  • Request reduceExpectedAmount()
  • Request computeRequestId()
  • Request waitForConfirmation()
  • Request getData()
  • Request refresh()
  • Request Client getPaymentReference()
  • Return value: IRequestDataWithEvents
  • Web3SignatureProvider
  • EtheruemPrivateKeySignatureProvider
  • EthereumPrivateKeyDecryptionProvider
@MantisClone MantisClone mentioned this issue Sep 18, 2023
Open
9 tasks
@MantisClone MantisClone moved this to 📋 Backlog in Request Network Tech Backlog Sep 18, 2023
@MantisClone MantisClone changed the title Add API Reference: RequestClient createRequest Add 20% API Reference: RequestClient createRequest Sep 18, 2023
@MantisClone MantisClone moved this from 📋 Backlog to 🔖 Sprint Backlog in Request Network Tech Backlog Sep 18, 2023
@MantisClone MantisClone self-assigned this Sep 18, 2023
@MantisClone MantisClone moved this from 🔖 Sprint Backlog to 🏗 In Progress in Request Network Tech Backlog Sep 28, 2023
@MantisClone
Copy link
Member Author

Done: https://docs.request.network/learn-request-network/sdk-api-reference/request-client.js/requestnetwork/createrequest

@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in Request Network Tech Backlog Oct 6, 2023
@MantisClone MantisClone changed the title Add 20% API Reference: RequestClient createRequest Add 1st Iteration of SDK API Reference Oct 25, 2023
@MantisClone
Copy link
Member Author

Done: c27ccf7
Deployed: https://docs.request.network/learn-request-network/sdk-api-reference

@MantisClone MantisClone mentioned this issue Dec 20, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MantisClone MantisClone

Labels
None yet
Projects
Request Network Tech Backlog
Status: ✅ Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MantisClone