From 7a9978572311f0e5f7b5ec1b487b7dd32af8d204 Mon Sep 17 00:00:00 2001 From: Adam Date: Thu, 25 Jan 2024 18:26:40 -0800 Subject: [PATCH] initial example docs --- .../sdk/src/https/datasets/milestone/MilestoneDataset.ts | 4 ++++ .../datasets/milestone/MilestoneTransactionSubset.ts | 4 ++++ .../sdk/src/https/datasets/proposal/ProposalDataset.ts | 9 +++++++++ 3 files changed, 17 insertions(+) diff --git a/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts b/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts index 2fb6546f28..36cb347a09 100644 --- a/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts +++ b/packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts @@ -1,4 +1,8 @@ import { Dataset, Milestone } from '@build-5/interfaces'; import { DatasetClass } from '../Dataset'; +/** + * Milestone Dataset + * + */ export class MilestoneDataset extends DatasetClass {} diff --git a/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts b/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts index 4be4f82fba..f68a6a512e 100644 --- a/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts +++ b/packages/sdk/src/https/datasets/milestone/MilestoneTransactionSubset.ts @@ -1,4 +1,8 @@ import { MilestoneTransaction } from '@build-5/interfaces'; import { SubsetClass } from '../Subset'; +/** + * Milestone Transactions subset + * + */ export class MilestoneTransactionSubset extends SubsetClass {} diff --git a/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts b/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts index b55f875660..358f7cd145 100644 --- a/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts +++ b/packages/sdk/src/https/datasets/proposal/ProposalDataset.ts @@ -13,7 +13,16 @@ import { } from '@build-5/interfaces'; import { DatasetClass } from '../Dataset'; +/** + * Proposal Dataset + */ export class ProposalDataset extends DatasetClass { + /** + * Method to create Proposal + * + * @param req Use {@link Build5Request} with data based on {@link ProposalCreateRequest} + * @returns + */ create = (req: Build5Request) => this.sendRequest(WEN_FUNC.createProposal)(req);