Skip to content

Commit b492e2b

Browse files
committed
Updated to v4.4.0
1 parent a15d75f commit b492e2b

File tree

120 files changed

+832
-1108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+832
-1108
lines changed

examples/customization/docs/Interface.Task.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
# Interface: Task
99

10-
> "content.begin" hook - last updated 2024-11-27T16:19:25.772Z
10+
> "content.begin" hook - last updated 2024-12-30T22:03:20.771Z
1111
1212
## Properties
1313

1414
| Property | Type |
1515
| ------ | ------ |
16-
| `description` | `string` |
17-
| `id` | `number` |
18-
| `title` | `string` |
16+
| <a id="description"></a> `description` | `string` |
17+
| <a id="id"></a> `id` | `number` |
18+
| <a id="title"></a> `title` | `string` |

examples/customization/docs/Interface.Task2.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
# Interface: Task2
99

10-
> "content.begin" hook - last updated 2024-11-27T16:19:25.772Z
10+
> "content.begin" hook - last updated 2024-12-30T22:03:20.772Z
1111
1212
## Properties
1313

1414
| Property | Type |
1515
| ------ | ------ |
16-
| `description` | `string` |
17-
| `id` | `number` |
18-
| `title` | `string` |
16+
| <a id="description"></a> `description` | `string` |
17+
| <a id="id"></a> `id` | `number` |
18+
| <a id="title"></a> `title` | `string` |

examples/customization/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# customization
77

8-
> "content.begin" hook - last updated 2024-11-27T16:19:25.771Z
8+
> "content.begin" hook - last updated 2024-12-30T22:03:20.770Z
99
1010
## Interfaces
1111

examples/default-options/docs/billing/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,18 @@ and services to process transactions, manage billing history, and generate recei
1111

1212
This module ensures comprehensive handling of billing data and operations, facilitating integrations with various payment providers and internal systems. It serves as a foundation for the financial transaction processing system, providing traceability and accountability through structured data and services.
1313

14-
## Index
15-
16-
### Enumerations
14+
## Enumerations
1715

1816
- [PaymentMethod](enumerations/PaymentMethod.md)
1917
- [TransactionStatus](enumerations/TransactionStatus.md)
2018

21-
### Classes
19+
## Classes
2220

2321
- [BillingHistoryService](classes/BillingHistoryService.md)
2422
- [BillingReceiptService](classes/BillingReceiptService.md)
2523
- [BillingService](classes/BillingService.md)
2624

27-
### Interfaces
25+
## Interfaces
2826

2927
- [BillingReceipt](interfaces/BillingReceipt.md)
3028
- [BillingTransaction](interfaces/BillingTransaction.md)

examples/default-options/docs/billing/classes/BillingHistoryService.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: BillingHistoryService
88

9+
Defined in: [billing.ts:135](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L135)
10+
911
Service for managing billing history.
1012
Provides functionality to store and retrieve the history of transactions.
1113

@@ -25,6 +27,8 @@ Provides functionality to store and retrieve the history of transactions.
2527

2628
> **addTransactionToHistory**(`transaction`): `void`
2729
30+
Defined in: [billing.ts:144](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L144)
31+
2832
Adds a transaction to the billing history.
2933
This method is typically called after a transaction is completed to maintain a record.
3034

@@ -40,16 +44,14 @@ The billing transaction to be added to the history.
4044

4145
`void`
4246

43-
#### Defined in
44-
45-
[billing.ts:144](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L144)
46-
4747
***
4848

4949
### getBillingHistory()
5050

5151
> **getBillingHistory**(): [`BillingTransaction`](../interfaces/BillingTransaction.md)[]
5252
53+
Defined in: [billing.ts:153](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L153)
54+
5355
Retrieves the complete billing history, providing access to all transactions that have been recorded.
5456
This is useful for historical analysis and auditing purposes.
5557

@@ -58,7 +60,3 @@ This is useful for historical analysis and auditing purposes.
5860
[`BillingTransaction`](../interfaces/BillingTransaction.md)[]
5961

6062
An array of all billing transactions in the history.
61-
62-
#### Defined in
63-
64-
[billing.ts:153](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L153)

examples/default-options/docs/billing/classes/BillingReceiptService.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: BillingReceiptService
88

9+
Defined in: [billing.ts:163](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L163)
10+
911
Service for generating billing receipts.
1012
Provides functionality to generate and retrieve receipts for transactions.
1113

@@ -25,6 +27,8 @@ Provides functionality to generate and retrieve receipts for transactions.
2527

2628
> **generateReceipt**(`transaction`): [`BillingReceipt`](../interfaces/BillingReceipt.md)
2729
30+
Defined in: [billing.ts:173](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L173)
31+
2832
Generates a billing receipt for a transaction and stores it.
2933
Each receipt includes a unique ID and timestamp, essential for record-keeping and customer service.
3034

@@ -42,16 +46,14 @@ The billing transaction for which to generate a receipt.
4246

4347
The generated billing receipt.
4448

45-
#### Defined in
46-
47-
[billing.ts:173](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L173)
48-
4949
***
5050

5151
### getAllReceipts()
5252

5353
> **getAllReceipts**(): [`BillingReceipt`](../interfaces/BillingReceipt.md)[]
5454
55+
Defined in: [billing.ts:188](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L188)
56+
5557
Retrieves all the billing receipts that have been generated.
5658
Useful for providing customers with copies of their receipts or for internal financial tracking.
5759

@@ -60,7 +62,3 @@ Useful for providing customers with copies of their receipts or for internal fin
6062
[`BillingReceipt`](../interfaces/BillingReceipt.md)[]
6163

6264
An array of all billing receipts.
63-
64-
#### Defined in
65-
66-
[billing.ts:188](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L188)

examples/default-options/docs/billing/classes/BillingService.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Class: BillingService
88

9+
Defined in: [billing.ts:105](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L105)
10+
911
Service for managing billing transactions.
1012
Provides functionality to process and retrieve billing transactions.
1113

@@ -25,6 +27,8 @@ Provides functionality to process and retrieve billing transactions.
2527

2628
> **getAllTransactions**(): [`BillingTransaction`](../interfaces/BillingTransaction.md)[]
2729
30+
Defined in: [billing.ts:125](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L125)
31+
2832
Retrieves all the billing transactions that have been processed.
2933
Useful for audits and general transaction management.
3034

@@ -34,16 +38,14 @@ Useful for audits and general transaction management.
3438

3539
An array of all billing transactions.
3640

37-
#### Defined in
38-
39-
[billing.ts:125](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L125)
40-
4141
***
4242

4343
### processTransaction()
4444

4545
> **processTransaction**(`transaction`): [`BillingTransaction`](../interfaces/BillingTransaction.md)
4646
47+
Defined in: [billing.ts:115](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L115)
48+
4749
Processes a billing transaction by adding it to the list of transactions.
4850
This simulates the transaction execution and storage in a production environment.
4951

@@ -60,7 +62,3 @@ The billing transaction to be processed.
6062
[`BillingTransaction`](../interfaces/BillingTransaction.md)
6163

6264
The processed billing transaction, now stored in the service.
63-
64-
#### Defined in
65-
66-
[billing.ts:115](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L115)

examples/default-options/docs/billing/enumerations/PaymentMethod.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Enumeration: PaymentMethod
88

9+
Defined in: [billing.ts:15](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L15)
10+
911
Enum representing different types of payment methods.
1012
These are used to specify the payment mechanism chosen by a customer.
1113

@@ -15,32 +17,26 @@ These are used to specify the payment mechanism chosen by a customer.
1517

1618
> **BankTransfer**: `"Bank Transfer"`
1719
18-
Payment via direct bank transfer. Used typically for larger transactions or where credit cards and PayPal are not viable.
19-
20-
#### Defined in
20+
Defined in: [billing.ts:23](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L23)
2121

22-
[billing.ts:23](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L23)
22+
Payment via direct bank transfer. Used typically for larger transactions or where credit cards and PayPal are not viable.
2323

2424
***
2525

2626
### CreditCard
2727

2828
> **CreditCard**: `"Credit Card"`
2929
30-
Payment through credit card.
31-
32-
#### Defined in
30+
Defined in: [billing.ts:17](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L17)
3331

34-
[billing.ts:17](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L17)
32+
Payment through credit card.
3533

3634
***
3735

3836
### PayPal
3937

4038
> **PayPal**: `"PayPal"`
4139
42-
Payment through PayPal. Ideal for users who prefer not to directly use their credit card details.
40+
Defined in: [billing.ts:20](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L20)
4341

44-
#### Defined in
45-
46-
[billing.ts:20](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L20)
42+
Payment through PayPal. Ideal for users who prefer not to directly use their credit card details.

examples/default-options/docs/billing/enumerations/TransactionStatus.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Enumeration: TransactionStatus
88

9+
Defined in: [billing.ts:30](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L30)
10+
911
Enum representing different transaction statuses.
1012
These statuses indicate the current state of a billing transaction in the process pipeline.
1113

@@ -15,32 +17,26 @@ These statuses indicate the current state of a billing transaction in the proces
1517

1618
> **Completed**: `"Completed"`
1719
18-
Transaction has been successfully processed.
19-
20-
#### Defined in
20+
Defined in: [billing.ts:35](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L35)
2121

22-
[billing.ts:35](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L35)
22+
Transaction has been successfully processed.
2323

2424
***
2525

2626
### Failed
2727

2828
> **Failed**: `"Failed"`
2929
30-
Transaction failed due to an error or rejection.
31-
32-
#### Defined in
30+
Defined in: [billing.ts:38](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L38)
3331

34-
[billing.ts:38](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L38)
32+
Transaction failed due to an error or rejection.
3533

3634
***
3735

3836
### Pending
3937

4038
> **Pending**: `"Pending"`
4139
42-
Transaction has been initiated but not yet processed.
40+
Defined in: [billing.ts:32](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L32)
4341

44-
#### Defined in
45-
46-
[billing.ts:32](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L32)
42+
Transaction has been initiated but not yet processed.

examples/default-options/docs/billing/interfaces/BillingReceipt.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
# Interface: BillingReceipt
88

9+
Defined in: [billing.ts:80](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L80)
10+
911
Interface representing a billing receipt.
1012
Provides a record of the transaction for both the customer and the business.
1113

@@ -15,35 +17,29 @@ Provides a record of the transaction for both the customer and the business.
1517

1618
> **receiptId**: `string`
1719
20+
Defined in: [billing.ts:85](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L85)
21+
1822
Unique identifier for the receipt. This ID is crucial for referencing and tracking the receipt
1923
in financial records and customer queries.
2024

21-
#### Defined in
22-
23-
[billing.ts:85](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L85)
24-
2525
***
2626

2727
### timestamp
2828

2929
> **timestamp**: `number`
3030
31+
Defined in: [billing.ts:97](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L97)
32+
3133
The timestamp (in UNIX epoch time) when the receipt was generated. Provides a precise record of when
3234
the transaction was finalized and acknowledged.
3335

34-
#### Defined in
35-
36-
[billing.ts:97](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L97)
37-
3836
***
3937

4038
### transaction
4139

4240
> **transaction**: [`BillingTransaction`](BillingTransaction.md)
4341
42+
Defined in: [billing.ts:91](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L91)
43+
4444
The transaction details associated with this receipt. Links the receipt to the actual transaction
4545
that took place.
46-
47-
#### Defined in
48-
49-
[billing.ts:91](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L91)

0 commit comments

Comments
 (0)