Skip to content

Commit

Permalink
Updated to v4.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Dec 30, 2024
1 parent a15d75f commit b492e2b
Show file tree
Hide file tree
Showing 120 changed files with 832 additions and 1,108 deletions.
8 changes: 4 additions & 4 deletions examples/customization/docs/Interface.Task.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

# Interface: Task

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

| Property | Type |
| ------ | ------ |
| `description` | `string` |
| `id` | `number` |
| `title` | `string` |
| <a id="description"></a> `description` | `string` |
| <a id="id"></a> `id` | `number` |
| <a id="title"></a> `title` | `string` |
8 changes: 4 additions & 4 deletions examples/customization/docs/Interface.Task2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

# Interface: Task2

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

| Property | Type |
| ------ | ------ |
| `description` | `string` |
| `id` | `number` |
| `title` | `string` |
| <a id="description"></a> `description` | `string` |
| <a id="id"></a> `id` | `number` |
| <a id="title"></a> `title` | `string` |
2 changes: 1 addition & 1 deletion examples/customization/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# customization

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

Expand Down
8 changes: 3 additions & 5 deletions examples/default-options/docs/billing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,18 @@ and services to process transactions, manage billing history, and generate recei

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.

## Index

### Enumerations
## Enumerations

- [PaymentMethod](enumerations/PaymentMethod.md)
- [TransactionStatus](enumerations/TransactionStatus.md)

### Classes
## Classes

- [BillingHistoryService](classes/BillingHistoryService.md)
- [BillingReceiptService](classes/BillingReceiptService.md)
- [BillingService](classes/BillingService.md)

### Interfaces
## Interfaces

- [BillingReceipt](interfaces/BillingReceipt.md)
- [BillingTransaction](interfaces/BillingTransaction.md)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Class: BillingHistoryService

Defined in: [billing.ts:135](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L135)

Service for managing billing history.
Provides functionality to store and retrieve the history of transactions.

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

> **addTransactionToHistory**(`transaction`): `void`
Defined in: [billing.ts:144](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L144)

Adds a transaction to the billing history.
This method is typically called after a transaction is completed to maintain a record.

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

`void`

#### Defined in

[billing.ts:144](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L144)

***

### getBillingHistory()

> **getBillingHistory**(): [`BillingTransaction`](../interfaces/BillingTransaction.md)[]
Defined in: [billing.ts:153](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L153)

Retrieves the complete billing history, providing access to all transactions that have been recorded.
This is useful for historical analysis and auditing purposes.

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

An array of all billing transactions in the history.

#### Defined in

[billing.ts:153](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L153)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Class: BillingReceiptService

Defined in: [billing.ts:163](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L163)

Service for generating billing receipts.
Provides functionality to generate and retrieve receipts for transactions.

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

> **generateReceipt**(`transaction`): [`BillingReceipt`](../interfaces/BillingReceipt.md)
Defined in: [billing.ts:173](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L173)

Generates a billing receipt for a transaction and stores it.
Each receipt includes a unique ID and timestamp, essential for record-keeping and customer service.

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

The generated billing receipt.

#### Defined in

[billing.ts:173](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L173)

***

### getAllReceipts()

> **getAllReceipts**(): [`BillingReceipt`](../interfaces/BillingReceipt.md)[]
Defined in: [billing.ts:188](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L188)

Retrieves all the billing receipts that have been generated.
Useful for providing customers with copies of their receipts or for internal financial tracking.

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

An array of all billing receipts.

#### Defined in

[billing.ts:188](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L188)
14 changes: 6 additions & 8 deletions examples/default-options/docs/billing/classes/BillingService.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Class: BillingService

Defined in: [billing.ts:105](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L105)

Service for managing billing transactions.
Provides functionality to process and retrieve billing transactions.

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

> **getAllTransactions**(): [`BillingTransaction`](../interfaces/BillingTransaction.md)[]
Defined in: [billing.ts:125](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L125)

Retrieves all the billing transactions that have been processed.
Useful for audits and general transaction management.

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

An array of all billing transactions.

#### Defined in

[billing.ts:125](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L125)

***

### processTransaction()

> **processTransaction**(`transaction`): [`BillingTransaction`](../interfaces/BillingTransaction.md)
Defined in: [billing.ts:115](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L115)

Processes a billing transaction by adding it to the list of transactions.
This simulates the transaction execution and storage in a production environment.

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

The processed billing transaction, now stored in the service.

#### Defined in

[billing.ts:115](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L115)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Enumeration: PaymentMethod

Defined in: [billing.ts:15](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L15)

Enum representing different types of payment methods.
These are used to specify the payment mechanism chosen by a customer.

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

> **BankTransfer**: `"Bank Transfer"`
Payment via direct bank transfer. Used typically for larger transactions or where credit cards and PayPal are not viable.

#### Defined in
Defined in: [billing.ts:23](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L23)

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

***

### CreditCard

> **CreditCard**: `"Credit Card"`
Payment through credit card.

#### Defined in
Defined in: [billing.ts:17](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L17)

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

***

### PayPal

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

#### Defined in

[billing.ts:20](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L20)
Payment through PayPal. Ideal for users who prefer not to directly use their credit card details.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Enumeration: TransactionStatus

Defined in: [billing.ts:30](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L30)

Enum representing different transaction statuses.
These statuses indicate the current state of a billing transaction in the process pipeline.

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

> **Completed**: `"Completed"`
Transaction has been successfully processed.

#### Defined in
Defined in: [billing.ts:35](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L35)

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

***

### Failed

> **Failed**: `"Failed"`
Transaction failed due to an error or rejection.

#### Defined in
Defined in: [billing.ts:38](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L38)

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

***

### Pending

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

#### Defined in

[billing.ts:32](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L32)
Transaction has been initiated but not yet processed.
20 changes: 8 additions & 12 deletions examples/default-options/docs/billing/interfaces/BillingReceipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

# Interface: BillingReceipt

Defined in: [billing.ts:80](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L80)

Interface representing a billing receipt.
Provides a record of the transaction for both the customer and the business.

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

> **receiptId**: `string`
Defined in: [billing.ts:85](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L85)

Unique identifier for the receipt. This ID is crucial for referencing and tracking the receipt
in financial records and customer queries.

#### Defined in

[billing.ts:85](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L85)

***

### timestamp

> **timestamp**: `number`
Defined in: [billing.ts:97](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L97)

The timestamp (in UNIX epoch time) when the receipt was generated. Provides a precise record of when
the transaction was finalized and acknowledged.

#### Defined in

[billing.ts:97](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L97)

***

### transaction

> **transaction**: [`BillingTransaction`](BillingTransaction.md)
Defined in: [billing.ts:91](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L91)

The transaction details associated with this receipt. Links the receipt to the actual transaction
that took place.

#### Defined in

[billing.ts:91](https://github.com/typedoc2md/dummy-typescript-api/blob/main/src/billing.ts#L91)
Loading

0 comments on commit b492e2b

Please sign in to comment.