From d68a8622dba0af2c9fd917e4155c8f61032db439 Mon Sep 17 00:00:00 2001 From: aorumbayev Date: Sun, 3 Sep 2023 16:44:07 +0000 Subject: [PATCH] =?UTF-8?q?Refreshing=20documentation=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/SubtopiaClient.html | 52 ++++++++++++++--------------- classes/SubtopiaRegistryClient.html | 34 +++++++++---------- enums/ChainType.html | 6 ++-- enums/DiscountType.html | 6 ++-- enums/Duration.html | 12 +++---- enums/DurationType.html | 12 +++---- enums/LockerType.html | 6 ++-- enums/PriceNormalizationType.html | 6 ++-- enums/SubscriptionType.html | 6 ++-- functions/normalizePrice.html | 2 +- functions/optInAsset.html | 2 +- functions/optOutAsset.html | 2 +- interfaces/ApplicationSpec.html | 14 ++++---- interfaces/AssetMetadata.html | 12 +++---- interfaces/BaseDiscountRecord.html | 8 ++--- interfaces/DiscountMetadata.html | 10 +++--- interfaces/DiscountRecord.html | 14 ++++---- interfaces/SubscriptionRecord.html | 12 +++---- 18 files changed, 108 insertions(+), 108 deletions(-) diff --git a/classes/SubtopiaClient.html b/classes/SubtopiaClient.html index 9bde897..a29f108 100644 --- a/classes/SubtopiaClient.html +++ b/classes/SubtopiaClient.html @@ -20,7 +20,7 @@

Hierarchy

+
  • Defined in clients/SubtopiaClient.ts:55
    • @@ -97,64 +97,64 @@
    subscriptionNameversion: string

    Returns SubtopiaClient

    +
  • Defined in clients/SubtopiaClient.ts:68

    • Properties

    algodClient

    algodClient: default
    +
  • Defined in clients/SubtopiaClient.ts:58

    • appAddress

    appAddress: string
    +
  • Defined in clients/SubtopiaClient.ts:65

    • appID

    appID: number
    +
  • Defined in clients/SubtopiaClient.ts:64

    • appSpec

    appSpec: ApplicationSpec
    +
  • Defined in clients/SubtopiaClient.ts:66

    • coin

    coin: AssetMetadata
    +
  • Defined in clients/SubtopiaClient.ts:61

    • creator

    creator: TransactionSignerAccount
    +
  • Defined in clients/SubtopiaClient.ts:59

    • oracleID

    oracleID: number
    +
  • Defined in clients/SubtopiaClient.ts:62

    • price

    price: number
    +
  • Defined in clients/SubtopiaClient.ts:60

    • productName

    productName: string
    +
  • Defined in clients/SubtopiaClient.ts:56

    • subscriptionName

    subscriptionName: string
    +
  • Defined in clients/SubtopiaClient.ts:57

    • version

    version: string
    +
  • Defined in clients/SubtopiaClient.ts:63

    • Methods

    @@ -174,7 +174,7 @@
    subscribersubscriptionID: number

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:607

    • createDiscount

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:272

    • createSubscription

    Returns Promise<{
        subscriptionID: number;
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:392

    • deleteDiscount

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:352

    • deleteSubscription

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:649

    • getDiscount

    Returns Promise<DiscountRecord>

    +
  • Defined in clients/SubtopiaClient.ts:222

    • getLockerCreationFee

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaClient.ts:214

    • getSubscription

    Returns Promise<SubscriptionRecord>

    +
  • Defined in clients/SubtopiaClient.ts:727

    • getSubscriptionPlatformFee

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaClient.ts:186

    • getSubscriptionPrice

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaClient.ts:177

    • isSubscriber

    Returns Promise<boolean>

    +
  • Defined in clients/SubtopiaClient.ts:691

    • transferSubscription

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaClient.ts:551

    • Static init

    Returns Promise<SubtopiaClient>

    +
  • Defined in clients/SubtopiaClient.ts:106
    • diff --git a/classes/SubtopiaRegistryClient.html b/classes/SubtopiaRegistryClient.html index 07d06b0..122d4e0 100644 --- a/classes/SubtopiaRegistryClient.html +++ b/classes/SubtopiaRegistryClient.html @@ -20,7 +20,7 @@

    Hierarchy

    • SubtopiaRegistryClient
    +
  • Defined in clients/SubtopiaRegistryClient.ts:56
    • @@ -80,44 +80,44 @@
    oracleIDversion: string

    Returns SubtopiaRegistryClient

    +
  • Defined in clients/SubtopiaRegistryClient.ts:65

    • Properties

    algodClient

    algodClient: default
    +
  • Defined in clients/SubtopiaRegistryClient.ts:57

    • appAddress

    appAddress: string
    +
  • Defined in clients/SubtopiaRegistryClient.ts:61

    • appID

    appID: number
    +
  • Defined in clients/SubtopiaRegistryClient.ts:60

    • appSpec

    appSpec: ApplicationSpec
    +
  • Defined in clients/SubtopiaRegistryClient.ts:62

    • creator

    creator: TransactionSignerAccount
    +
  • Defined in clients/SubtopiaRegistryClient.ts:58

    • oracleID

    oracleID: number
    +
  • Defined in clients/SubtopiaRegistryClient.ts:63

    • version

    version: string
    +
  • Defined in clients/SubtopiaRegistryClient.ts:59

    • Methods

    @@ -151,7 +151,7 @@
    subscriptionNameOptional unitName?: string

    Returns Promise<{
        infrastructureID: number;
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:401

    • createLocker

      @@ -169,7 +169,7 @@
      creatorlockerType: LockerType

    Returns Promise<{
        lockerID: number;
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:188

    • getLockerCreationFee

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:180

    • getProductCreationFee

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:143

    • getProductCreationPlatformFee

    Returns Promise<number>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:152

    • transferInfrastructure

    Returns Promise<{
        txID: string;
    }>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:287

    • Static getLocker

    Returns Promise<undefined | number>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:264

    • Static init

    Returns Promise<SubtopiaRegistryClient>

    +
  • Defined in clients/SubtopiaRegistryClient.ts:91
    • diff --git a/enums/ChainType.html b/enums/ChainType.html index a431213..56e5d08 100644 --- a/enums/ChainType.html +++ b/enums/ChainType.html @@ -16,7 +16,7 @@
  • ChainType

    • Enumeration ChainType

    +
  • Defined in enums/index.ts:37
    • @@ -33,12 +33,12 @@

    Enumeration Members

    MAINNET

    MAINNET: "mainnet"
    +
  • Defined in enums/index.ts:39

    • TESTNET

    TESTNET: "testnet"
    +
  • Defined in enums/index.ts:38
    • diff --git a/enums/DiscountType.html b/enums/DiscountType.html index 77b4147..dc269d8 100644 --- a/enums/DiscountType.html +++ b/enums/DiscountType.html @@ -16,7 +16,7 @@
  • DiscountType

    • Enumeration DiscountType

    +
  • Defined in enums/index.ts:32
    • @@ -33,12 +33,12 @@

    Enumeration Members

    FIXED

    FIXED: 1
    +
  • Defined in enums/index.ts:34

    • PERCENTAGE

    PERCENTAGE: 0
    +
  • Defined in enums/index.ts:33
    • diff --git a/enums/Duration.html b/enums/Duration.html index 9567ca2..24a094d 100644 --- a/enums/Duration.html +++ b/enums/Duration.html @@ -16,7 +16,7 @@
  • Duration

    • Enumeration Duration

    +
  • Defined in enums/index.ts:19
    • @@ -36,27 +36,27 @@

    Enumeration Members

    ANNUAL

    ANNUAL: 31536000
    +
  • Defined in enums/index.ts:24

    • MONTH

    MONTH: 2592000
    +
  • Defined in enums/index.ts:21

    • QUARTER

    QUARTER: 7776000
    +
  • Defined in enums/index.ts:22

    • SEMI_ANNUAL

    SEMI_ANNUAL: 15552000
    +
  • Defined in enums/index.ts:23

    • UNLIMITED

    UNLIMITED: 0
    +
  • Defined in enums/index.ts:20
    • diff --git a/enums/DurationType.html b/enums/DurationType.html index 277de50..8c2bce9 100644 --- a/enums/DurationType.html +++ b/enums/DurationType.html @@ -16,7 +16,7 @@
  • DurationType

    • Enumeration DurationType

    +
  • Defined in enums/index.ts:11
    • @@ -36,27 +36,27 @@

    Enumeration Members

    ANNUAL

    ANNUAL: 4
    +
  • Defined in enums/index.ts:16

    • MONTHLY

    MONTHLY: 1
    +
  • Defined in enums/index.ts:13

    • QUARTERLY

    QUARTERLY: 2
    +
  • Defined in enums/index.ts:14

    • SEMI_ANNUAL

    SEMI_ANNUAL: 3
    +
  • Defined in enums/index.ts:15

    • UNLIMITED

    UNLIMITED: 0
    +
  • Defined in enums/index.ts:12
    • diff --git a/enums/LockerType.html b/enums/LockerType.html index 3262037..6f2031b 100644 --- a/enums/LockerType.html +++ b/enums/LockerType.html @@ -16,7 +16,7 @@
  • LockerType

    • Enumeration LockerType

    +
  • Defined in enums/index.ts:42
    • @@ -33,12 +33,12 @@

    Enumeration Members

    CREATOR

    CREATOR: 0
    +
  • Defined in enums/index.ts:43

    • USER

    USER: 1
    +
  • Defined in enums/index.ts:44
    • diff --git a/enums/PriceNormalizationType.html b/enums/PriceNormalizationType.html index 80c59bd..df2059c 100644 --- a/enums/PriceNormalizationType.html +++ b/enums/PriceNormalizationType.html @@ -16,7 +16,7 @@
  • PriceNormalizationType

    • Enumeration PriceNormalizationType

    +
  • Defined in enums/index.ts:27
    • @@ -33,12 +33,12 @@

    Enumeration Members

    PRETTY

    PRETTY: 1
    +
  • Defined in enums/index.ts:29

    • RAW

    RAW: 0
    +
  • Defined in enums/index.ts:28
    • diff --git a/enums/SubscriptionType.html b/enums/SubscriptionType.html index 3b9b592..eed087b 100644 --- a/enums/SubscriptionType.html +++ b/enums/SubscriptionType.html @@ -16,7 +16,7 @@
  • SubscriptionType

    • Enumeration SubscriptionType

    +
  • Defined in enums/index.ts:6
    • @@ -33,12 +33,12 @@

    Enumeration Members

    TIME_BASED

    TIME_BASED: 1
    +
  • Defined in enums/index.ts:8

    • UNLIMITED

    UNLIMITED: 0
    +
  • Defined in enums/index.ts:7
    • diff --git a/functions/normalizePrice.html b/functions/normalizePrice.html index d89d807..5868c38 100644 --- a/functions/normalizePrice.html +++ b/functions/normalizePrice.html @@ -30,7 +30,7 @@
    decimals: direction: PriceNormalizationType = PriceNormalizationType.RAW

    Returns number

    +
  • Defined in utils/index.ts:86
    • diff --git a/functions/optInAsset.html b/functions/optInAsset.html index e87e1ad..90bd41f 100644 --- a/functions/optInAsset.html +++ b/functions/optInAsset.html @@ -33,7 +33,7 @@
    assetIDclient: default

    Returns Promise<{
        confirmedRound: number;
        methodResults: SdkABIResult[];
        txIDs: string[];
    }>

    +
  • Defined in utils/index.ts:25
    • diff --git a/functions/optOutAsset.html b/functions/optOutAsset.html index 0e209ed..0c3781d 100644 --- a/functions/optOutAsset.html +++ b/functions/optOutAsset.html @@ -33,7 +33,7 @@
    assetIDclient: default

    Returns Promise<{
        confirmedRound: number;
        methodResults: SdkABIResult[];
        txIDs: string[];
    }>

    +
  • Defined in utils/index.ts:55
    • diff --git a/interfaces/ApplicationSpec.html b/interfaces/ApplicationSpec.html index 5d9b250..dec563f 100644 --- a/interfaces/ApplicationSpec.html +++ b/interfaces/ApplicationSpec.html @@ -20,7 +20,7 @@

    Hierarchy

    • ApplicationSpec
    +
  • Defined in interfaces/index.ts:10
    • @@ -41,32 +41,32 @@

    Properties

    approval

    approval: Uint8Array
    +
  • Defined in interfaces/index.ts:11

    • clear

    clear: Uint8Array
    +
  • Defined in interfaces/index.ts:12

    • globalNumByteSlice

    globalNumByteSlice: number
    +
  • Defined in interfaces/index.ts:14

    • globalNumUint

    globalNumUint: number
    +
  • Defined in interfaces/index.ts:13

    • localNumByteSlice

    localNumByteSlice: number
    +
  • Defined in interfaces/index.ts:16

    • localNumUint

    localNumUint: number
    +
  • Defined in interfaces/index.ts:15
    • diff --git a/interfaces/AssetMetadata.html b/interfaces/AssetMetadata.html index 6f44d78..9dd88a5 100644 --- a/interfaces/AssetMetadata.html +++ b/interfaces/AssetMetadata.html @@ -20,7 +20,7 @@

    Hierarchy

    • AssetMetadata
    +
  • Defined in interfaces/index.ts:40
    • @@ -40,27 +40,27 @@

    Properties

    creator

    creator: string
    +
  • Defined in interfaces/index.ts:42

    • decimals

    decimals: number
    +
  • Defined in interfaces/index.ts:44

    • index

    index: number
    +
  • Defined in interfaces/index.ts:41

    • name

    name: string
    +
  • Defined in interfaces/index.ts:43

    • unitName

    unitName: string
    +
  • Defined in interfaces/index.ts:45
    • diff --git a/interfaces/BaseDiscountRecord.html b/interfaces/BaseDiscountRecord.html index 62859ce..4a8ddc8 100644 --- a/interfaces/BaseDiscountRecord.html +++ b/interfaces/BaseDiscountRecord.html @@ -23,7 +23,7 @@

    Hierarchy

  • DiscountRecord
  • DiscountMetadata
    • +
  • Defined in interfaces/index.ts:27
    • @@ -41,17 +41,17 @@

    Properties

    discountType

    discountType: DiscountType
    +
  • Defined in interfaces/index.ts:29

    • discountValue

    discountValue: number
    +
  • Defined in interfaces/index.ts:30

    • duration

    duration: DurationType
    +
  • Defined in interfaces/index.ts:28
    • diff --git a/interfaces/DiscountMetadata.html b/interfaces/DiscountMetadata.html index 35e4eba..1e042f9 100644 --- a/interfaces/DiscountMetadata.html +++ b/interfaces/DiscountMetadata.html @@ -22,7 +22,7 @@

    Hierarchy

    • DiscountMetadata
    +
  • Defined in interfaces/index.ts:48
    • @@ -42,24 +42,24 @@

    discountTypediscountType: DiscountType

    +
  • Defined in interfaces/index.ts:29

    • discountValue

    discountValue: number
    +
  • Defined in interfaces/index.ts:30

    • duration

    duration: DurationType
    +
  • Defined in interfaces/index.ts:28

    • Optional expiresIn

    expiresIn?: number
    +
  • Defined in interfaces/index.ts:49
    • diff --git a/interfaces/DiscountRecord.html b/interfaces/DiscountRecord.html index 1cf03d3..05a1524 100644 --- a/interfaces/DiscountRecord.html +++ b/interfaces/DiscountRecord.html @@ -22,7 +22,7 @@

    Hierarchy

    • DiscountRecord
    +
  • Defined in interfaces/index.ts:33
    • @@ -43,35 +43,35 @@

    Properties

    createdAt

    createdAt: Date
    +
  • Defined in interfaces/index.ts:34

    • discountType

    discountType: DiscountType
    +
  • Defined in interfaces/index.ts:29

    • discountValue

    discountValue: number
    +
  • Defined in interfaces/index.ts:30

    • duration

    duration: DurationType
    +
  • Defined in interfaces/index.ts:28

    • expiresAt

    expiresAt: undefined | Date
    +
  • Defined in interfaces/index.ts:35

    • totalClaims

    totalClaims: number
    +
  • Defined in interfaces/index.ts:36
    • diff --git a/interfaces/SubscriptionRecord.html b/interfaces/SubscriptionRecord.html index 9b05314..1ffe3a0 100644 --- a/interfaces/SubscriptionRecord.html +++ b/interfaces/SubscriptionRecord.html @@ -20,7 +20,7 @@

    Hierarchy

    • SubscriptionRecord
    +
  • Defined in interfaces/index.ts:19
    • @@ -40,27 +40,27 @@

    Properties

    createdAt

    createdAt: Date
    +
  • Defined in interfaces/index.ts:20

    • duration

    duration: DurationType
    +
  • Defined in interfaces/index.ts:22

    • expiresAt

    expiresAt: undefined | Date
    +
  • Defined in interfaces/index.ts:21

    • subID

    subID: number
    +
  • Defined in interfaces/index.ts:23

    • subType

    subType: SubscriptionType
    +
  • Defined in interfaces/index.ts:24