Re-instantiate Typedocs for hidden exported functions in Account

[maschad]

Since #835 was addressed, there are a number of functions within the account package which are relevant to consumers that are currently marked as hidden such as getTransactionsSummaries for instance.

Now that we have a more structured approach to documentation we can discuss how we want to articulate these exported functions. These include:

• Transaction Summary methods
• Some of the operations methods
• Gas methods

There may be some others missing, but I would like to hear others thoughts @FuelLabs/sdk-ts

[petertonysmith94]

Do functional methods even get populated in the Typedocs? I canny see any in the documentation.

Types like should not be hidden (in typedocs):

• CursorPaginationArgs
• TransactionResult

Functions like should be documented rather than just put in TypeDocs IMO:

• getTransactionsSummaries

I think as and when users ask for functionality that we have within the SDK, but isn't currently documented, we should make a better effort in rectifying this. That way the documentation can grow organically.

[maschad]

Do functional methods even get populated in the Typedocs? I canny see any in the documentation.

Maybe I'm misinterpreting what you are saying, but they are, getTransactionSummary is an example

Functions like should be documented rather than just put in TypeDocs IMO:
I think as and when users ask for functionality that we have within the SDK, but isn't currently documented, we should make a better effort in rectifying this. That way the documentation can grow organically.

I agree, I think we should also document these two particular methods in a guide as well, that was my intention. I suppose we can go about creating individual issues to document each folder. The purpose of the discussion was to nail down a clear scope of work for which hidden methods ought to be documented.

[petertonysmith94]

Maybe I'm misinterpreting what you are saying, but they are, getTransactionSummary is an example

You interpreted right, just didn't see them in the Table of Contents.

The purpose of the discussion was to nail down a clear scope of work for which hidden methods ought to be documented.

If that is the purpose, would it make sense to list out all the methods/types that we propose to make un-hidden? (in the description)

[maschad]

Correct, I began the list in the description, so all of the Transaction Summary methods and all the Gas methods I'm not sure if this is comprehensive though.

Some of the operations methods

I should have been explicit here, I am referring to:

• getReceiptsByType
• getTransactionTypeName
• getWithdrawFromFuelOperations
• extractTransferOperationFromReceipt

Are there any others you think would be appropriate?

[Torres-ssf]

The list should include getTransactionsSummaries

[maschad]

Closing this discussion for now as I've created this issue based on the feedback.