diff --git a/docs/reference/letsgo-constants/README.md b/docs/reference/letsgo-constants/README.md index c4cd3f3..8f0f0f4 100644 --- a/docs/reference/letsgo-constants/README.md +++ b/docs/reference/letsgo-constants/README.md @@ -47,7 +47,7 @@ Parameters that control the creation of an App Runner service and related AWS re #### Defined in -[index.ts:510](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L510) +[index.ts:520](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L520) ___ @@ -108,11 +108,13 @@ configuration settings controling. | `WorkerFunctionTimeout` | `string` | The maximum time in seconds the Lambda function of the _worker_ component can run before it is terminated. | | `WorkerMessageRetentionPeriod` | `string` | The maximum time in seconds an unconsumed message can stay in the SQS queue of the _worker_ component before it is discarded. | | `WorkerReceiveMessageWaitTime` | `string` | The time in seconds a request for a message from the SQS queue remains pending if no message is available to read. | +| `WorkerSchedule` | `string` | The EventBridge Scheduler expression that controls the timing of the scheduled invocation of the worker. Valid values are `cron({cron_expression})` and `rate({rate_expression})`, as documented in [CreateScheduleCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-scheduler/Class/CreateScheduleCommand/). | +| `WorkerScheduleTimezone` | `string` | The time zone used by the EventBridge Scheduler expression that controls the timing of the scheduled invocation of the worker. Valid values are [IANA time zone IDs](https://nodatime.org/TimeZones). | | `WorkerVisibilityTimeout` | `string` | The time in seconds a message remains invisible in the SQS queue of the _worker_ component if it did not confirm its processing. | #### Defined in -[index.ts:76](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L76) +[index.ts:76](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L76) ___ @@ -124,7 +126,7 @@ Parameters that control the creation of the _database_ component. #### Defined in -[index.ts:581](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L581) +[index.ts:591](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L591) ___ @@ -136,7 +138,7 @@ The default LetsGo deployment name used by LetsGo CLI commands. #### Defined in -[index.ts:28](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L28) +[index.ts:28](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L28) ___ @@ -148,7 +150,7 @@ The default AWS region used by LetsGo CLI commands. #### Defined in -[index.ts:23](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L23) +[index.ts:23](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L23) ___ @@ -160,7 +162,7 @@ Default validity period of the invitations to join a tenant. #### Defined in -[index.ts:39](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L39) +[index.ts:39](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L39) ___ @@ -173,7 +175,7 @@ used when creating JWTs using the built-in PKI issuer. #### Defined in -[index.ts:34](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L34) +[index.ts:34](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L34) ___ @@ -185,7 +187,7 @@ Default version of of Stripe APIs called and Stripe webhooks accepted. #### Defined in -[index.ts:44](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L44) +[index.ts:44](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L44) ___ @@ -197,7 +199,7 @@ The name of the Stripe metadata tag that contains the LetsGo identity ID added t #### Defined in -[index.ts:54](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L54) +[index.ts:54](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L54) ___ @@ -209,7 +211,7 @@ The name of the Stripe metadata tag that contains the LetsGo plan ID added to St #### Defined in -[index.ts:59](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L59) +[index.ts:59](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L59) ___ @@ -221,7 +223,7 @@ The name of the Stripe metadata tag that contains the LetsGo tenant ID added to #### Defined in -[index.ts:49](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L49) +[index.ts:49](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L49) ___ @@ -243,7 +245,7 @@ Names of AWS tags added to all AWS resources created by LetsGo. #### Defined in -[index.ts:64](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L64) +[index.ts:64](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L64) ___ @@ -257,7 +259,7 @@ Changing this value once the artifacts had been deployed is not supported. #### Defined in -[index.ts:18](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L18) +[index.ts:18](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L18) ___ @@ -269,7 +271,7 @@ Parameters that control the creation of an App Runner service and related AWS re #### Defined in -[index.ts:537](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L537) +[index.ts:547](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L547) ___ @@ -281,4 +283,4 @@ Parameters that control the creation of AWS resources related to the _worker_ co #### Defined in -[index.ts:711](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L711) +[index.ts:741](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L741) diff --git a/docs/reference/letsgo-constants/interfaces/AppRunnerSettings.md b/docs/reference/letsgo-constants/interfaces/AppRunnerSettings.md index 62b1fcd..f3bf5f7 100644 --- a/docs/reference/letsgo-constants/interfaces/AppRunnerSettings.md +++ b/docs/reference/letsgo-constants/interfaces/AppRunnerSettings.md @@ -31,7 +31,7 @@ The name of the component for which an AppRunner service is created (`web` or `a #### Defined in -[index.ts:342](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L342) +[index.ts:352](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L352) ___ @@ -43,7 +43,7 @@ Returns the default configuration settings for the component. #### Defined in -[index.ts:415](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L415) +[index.ts:425](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L425) ___ @@ -71,7 +71,7 @@ AppRunner Auto Scaling Configuration name #### Defined in -[index.ts:400](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L400) +[index.ts:410](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L410) ___ @@ -99,7 +99,7 @@ AppRunner service name #### Defined in -[index.ts:394](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L394) +[index.ts:404](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L404) ___ @@ -127,7 +127,7 @@ ECR repository name #### Defined in -[index.ts:382](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L382) +[index.ts:392](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L392) ___ @@ -158,7 +158,7 @@ IAM inline policy document #### Defined in -[index.ts:365](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L365) +[index.ts:375](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L375) ___ @@ -186,7 +186,7 @@ Local Docker image name (without the tag) #### Defined in -[index.ts:388](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L388) +[index.ts:398](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L398) ___ @@ -215,7 +215,7 @@ Number of days to retain CloudWatch logs. #### Defined in -[index.ts:407](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L407) +[index.ts:417](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L417) ___ @@ -244,7 +244,7 @@ Array of managed IAM policy ARNs #### Defined in -[index.ts:376](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L376) +[index.ts:386](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L386) ___ @@ -273,7 +273,7 @@ IAM policy name #### Defined in -[index.ts:356](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L356) +[index.ts:366](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L366) ___ @@ -302,7 +302,7 @@ IAM role name #### Defined in -[index.ts:349](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L349) +[index.ts:359](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L359) ___ @@ -314,4 +314,4 @@ Returns the name of the environment variable containing the public URL of the Ap #### Defined in -[index.ts:411](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L411) +[index.ts:421](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L421) diff --git a/docs/reference/letsgo-constants/interfaces/AppRunnerSettingsDefaultConfig.md b/docs/reference/letsgo-constants/interfaces/AppRunnerSettingsDefaultConfig.md index e702ae9..03c3310 100644 --- a/docs/reference/letsgo-constants/interfaces/AppRunnerSettingsDefaultConfig.md +++ b/docs/reference/letsgo-constants/interfaces/AppRunnerSettingsDefaultConfig.md @@ -35,7 +35,7 @@ The amount of CPU allocated to a single instance of the component. #### Defined in -[index.ts:306](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L306) +[index.ts:316](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L316) ___ @@ -47,7 +47,7 @@ The number of consecutive successful health checks before the instance of the co #### Defined in -[index.ts:328](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L328) +[index.ts:338](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L338) ___ @@ -59,7 +59,7 @@ Frequency in seconds of the App Runner health check for the component. #### Defined in -[index.ts:319](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L319) +[index.ts:329](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L329) ___ @@ -72,7 +72,7 @@ if the instance of the component is healthy. #### Defined in -[index.ts:315](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L315) +[index.ts:325](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L325) ___ @@ -85,7 +85,7 @@ it is considered failed. #### Defined in -[index.ts:324](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L324) +[index.ts:334](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L334) ___ @@ -97,7 +97,7 @@ The number of consecutive failed health checks before the instance of the compon #### Defined in -[index.ts:332](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L332) +[index.ts:342](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L342) ___ @@ -109,7 +109,7 @@ The maximum number of concurrent HTTP requests processed by a single instance of #### Defined in -[index.ts:302](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L302) +[index.ts:312](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L312) ___ @@ -121,7 +121,7 @@ The maxium number of instances of the component. #### Defined in -[index.ts:298](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L298) +[index.ts:308](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L308) ___ @@ -133,7 +133,7 @@ The amount of memory allocated to a single instance of the component. #### Defined in -[index.ts:310](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L310) +[index.ts:320](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L320) ___ @@ -145,4 +145,4 @@ The minimum number of instances of the component to keep running at all times. #### Defined in -[index.ts:294](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L294) +[index.ts:304](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L304) diff --git a/docs/reference/letsgo-constants/interfaces/DBSettings.md b/docs/reference/letsgo-constants/interfaces/DBSettings.md index adc265f..e6f488e 100644 --- a/docs/reference/letsgo-constants/interfaces/DBSettings.md +++ b/docs/reference/letsgo-constants/interfaces/DBSettings.md @@ -36,4 +36,4 @@ DynamoDB table name #### Defined in -[index.ts:575](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L575) +[index.ts:585](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L585) diff --git a/docs/reference/letsgo-constants/interfaces/WorkerSettings.md b/docs/reference/letsgo-constants/interfaces/WorkerSettings.md index c56e79b..067222f 100644 --- a/docs/reference/letsgo-constants/interfaces/WorkerSettings.md +++ b/docs/reference/letsgo-constants/interfaces/WorkerSettings.md @@ -18,6 +18,7 @@ Parameters that control the creation of AWS resources related to the _worker_ co - [getPolicyName](WorkerSettings.md#getpolicyname) - [getQueueNamePrefix](WorkerSettings.md#getqueuenameprefix) - [getRoleName](WorkerSettings.md#getrolename) +- [getScheduleName](WorkerSettings.md#getschedulename) ## Properties @@ -29,7 +30,7 @@ Returns the default configuration settings for the component. #### Defined in -[index.ts:703](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L703) +[index.ts:730](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L730) ___ @@ -57,7 +58,7 @@ ECR repository name #### Defined in -[index.ts:680](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L680) +[index.ts:701](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L701) ___ @@ -88,7 +89,7 @@ IAM inline policy document #### Defined in -[index.ts:663](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L663) +[index.ts:684](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L684) ___ @@ -116,7 +117,7 @@ Lambda function name #### Defined in -[index.ts:692](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L692) +[index.ts:713](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L713) ___ @@ -144,7 +145,7 @@ Local Docker image name (without the tag) #### Defined in -[index.ts:686](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L686) +[index.ts:707](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L707) ___ @@ -173,7 +174,7 @@ Number of days to retain CloudWatch logs. #### Defined in -[index.ts:699](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L699) +[index.ts:726](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L726) ___ @@ -202,7 +203,7 @@ Array of managed IAM policy ARNs #### Defined in -[index.ts:674](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L674) +[index.ts:695](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L695) ___ @@ -231,7 +232,7 @@ IAM policy name #### Defined in -[index.ts:654](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L654) +[index.ts:675](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L675) ___ @@ -259,7 +260,7 @@ Prefix of the SQS queue name #### Defined in -[index.ts:640](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L640) +[index.ts:661](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L661) ___ @@ -288,4 +289,32 @@ IAM role name #### Defined in -[index.ts:647](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L647) +[index.ts:668](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L668) + +___ + +### getScheduleName + +• **getScheduleName**: (`deployment`: `string`) => `string` + +#### Type declaration + +▸ (`deployment`): `string` + +Returns the name of the EventBridge Schedule that triggers the Lambda function of the _worker_ component. + +##### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deployment` | `string` | LetsGo deployment name | + +##### Returns + +`string` + +Schedule name + +#### Defined in + +[index.ts:719](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L719) diff --git a/docs/reference/letsgo-constants/interfaces/WorkerSettingsDefaultConfig.md b/docs/reference/letsgo-constants/interfaces/WorkerSettingsDefaultConfig.md index 3735bd6..8cf76e6 100644 --- a/docs/reference/letsgo-constants/interfaces/WorkerSettingsDefaultConfig.md +++ b/docs/reference/letsgo-constants/interfaces/WorkerSettingsDefaultConfig.md @@ -22,6 +22,8 @@ The collection of default configuration settings of the _worker_ component. - [functionTimeout](WorkerSettingsDefaultConfig.md#functiontimeout) - [messageRetentionPeriod](WorkerSettingsDefaultConfig.md#messageretentionperiod) - [receiveMessageWaitTime](WorkerSettingsDefaultConfig.md#receivemessagewaittime) +- [schedule](WorkerSettingsDefaultConfig.md#schedule) +- [scheduleTimezone](WorkerSettingsDefaultConfig.md#scheduletimezone) - [visibilityTimeout](WorkerSettingsDefaultConfig.md#visibilitytimeout) ## Properties @@ -34,7 +36,7 @@ The maximum number of messages the _worker_ component can process in a single in #### Defined in -[index.ts:619](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L619) +[index.ts:629](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L629) ___ @@ -46,7 +48,7 @@ The maximum time in seconds the _worker_ component waits for more messages to ar #### Defined in -[index.ts:623](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L623) +[index.ts:633](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L633) ___ @@ -59,7 +61,7 @@ This number multipled by the [batchSize](WorkerSettingsDefaultConfig.md#batchsiz #### Defined in -[index.ts:628](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L628) +[index.ts:638](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L638) ___ @@ -72,7 +74,7 @@ in the `/tmp` directory. #### Defined in -[index.ts:615](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L615) +[index.ts:625](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L625) ___ @@ -84,7 +86,7 @@ The amount of memory allocated to the Lambda function of the _worker_ component. #### Defined in -[index.ts:610](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L610) +[index.ts:620](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L620) ___ @@ -96,7 +98,7 @@ The maximum time in seconds the Lambda function of the _worker_ component can ru #### Defined in -[index.ts:606](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L606) +[index.ts:616](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L616) ___ @@ -109,7 +111,7 @@ before it is discarded. #### Defined in -[index.ts:593](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L593) +[index.ts:603](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L603) ___ @@ -121,7 +123,34 @@ The time in seconds a request for a message from the SQS queue remains pending i #### Defined in -[index.ts:602](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L602) +[index.ts:612](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L612) + +___ + +### schedule + +• **schedule**: `string`[] + +The EventBridge Schedule expression that controls the timing of the scheduled invocation of the +the Lambda function of the _worker_ component. Valid values are `cron({cron_expression})` and `rate({rate_expression})`, +as documented in [CreateScheduleCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-scheduler/Class/CreateScheduleCommand/). + +#### Defined in + +[index.ts:644](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L644) + +___ + +### scheduleTimezone + +• **scheduleTimezone**: `string`[] + +The time zone used by the EventBridge Schedule expression that controls the timing of the scheduled invocation of the +the Lambda function of the _worker_ component. Valid values are [IANA time zone IDs](https://nodatime.org/TimeZones). + +#### Defined in + +[index.ts:649](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L649) ___ @@ -134,4 +163,4 @@ confirm its processing. #### Defined in -[index.ts:598](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L598) +[index.ts:608](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L608) diff --git a/docs/reference/letsgo-db/README.md b/docs/reference/letsgo-db/README.md index 36d5117..24a1b50 100644 --- a/docs/reference/letsgo-db/README.md +++ b/docs/reference/letsgo-db/README.md @@ -44,7 +44,7 @@ Ensures the item is deleted. If the item does not exist, this operation is a no- #### Defined in -[index.ts:180](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L180) +[index.ts:180](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L180) ___ @@ -76,7 +76,7 @@ A promise that resolves to the item or undefined if the item does not exist or h #### Defined in -[index.ts:135](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L135) +[index.ts:135](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L135) ___ @@ -108,7 +108,7 @@ Matching items an an optional continuation token for paginated results. #### Defined in -[index.ts:201](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L201) +[index.ts:201](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L201) ___ @@ -137,4 +137,4 @@ Upserts an item in the database. #### Defined in -[index.ts:161](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L161) +[index.ts:161](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L161) diff --git a/docs/reference/letsgo-db/interfaces/DBItem.md b/docs/reference/letsgo-db/interfaces/DBItem.md index 75db81a..7dc4ab2 100644 --- a/docs/reference/letsgo-db/interfaces/DBItem.md +++ b/docs/reference/letsgo-db/interfaces/DBItem.md @@ -28,7 +28,7 @@ The DynamoDB partition key. #### Defined in -[index.ts:79](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L79) +[index.ts:79](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L79) ___ @@ -40,7 +40,7 @@ The DynamoDB sort key. #### Defined in -[index.ts:83](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L83) +[index.ts:83](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L83) ___ @@ -52,4 +52,4 @@ The time-to-live (TTL) value for the item. #### Defined in -[index.ts:87](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L87) +[index.ts:87](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L87) diff --git a/docs/reference/letsgo-db/interfaces/DeploymentOptions.md b/docs/reference/letsgo-db/interfaces/DeploymentOptions.md index aa2495a..c6a9500 100644 --- a/docs/reference/letsgo-db/interfaces/DeploymentOptions.md +++ b/docs/reference/letsgo-db/interfaces/DeploymentOptions.md @@ -27,7 +27,7 @@ LetsGo deployment name. #### Defined in -[index.ts:45](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L45) +[index.ts:45](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L45) ___ @@ -39,4 +39,4 @@ AWS region. #### Defined in -[index.ts:41](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L41) +[index.ts:41](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L41) diff --git a/docs/reference/letsgo-db/interfaces/GetItemOptions.md b/docs/reference/letsgo-db/interfaces/GetItemOptions.md index 310cbf3..fb8855a 100644 --- a/docs/reference/letsgo-db/interfaces/GetItemOptions.md +++ b/docs/reference/letsgo-db/interfaces/GetItemOptions.md @@ -30,7 +30,7 @@ If true, the read will be strongly consistent read in DynamoDB. #### Defined in -[index.ts:55](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L55) +[index.ts:55](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L55) ___ @@ -46,7 +46,7 @@ LetsGo deployment name. #### Defined in -[index.ts:45](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L45) +[index.ts:45](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L45) ___ @@ -62,4 +62,4 @@ AWS region. #### Defined in -[index.ts:41](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L41) +[index.ts:41](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L41) diff --git a/docs/reference/letsgo-db/interfaces/ListItemsOptions.md b/docs/reference/letsgo-db/interfaces/ListItemsOptions.md index 8b23d23..209b08d 100644 --- a/docs/reference/letsgo-db/interfaces/ListItemsOptions.md +++ b/docs/reference/letsgo-db/interfaces/ListItemsOptions.md @@ -34,7 +34,7 @@ If true, the read will be strongly consistent read in DynamoDB. #### Defined in -[index.ts:55](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L55) +[index.ts:55](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L55) ___ @@ -50,7 +50,7 @@ LetsGo deployment name. #### Defined in -[index.ts:45](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L45) +[index.ts:45](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L45) ___ @@ -62,7 +62,7 @@ The maximum number of items to return. #### Defined in -[index.ts:65](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L65) +[index.ts:65](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L65) ___ @@ -74,7 +74,7 @@ Continuation token for paginated results. #### Defined in -[index.ts:69](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L69) +[index.ts:69](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L69) ___ @@ -90,4 +90,4 @@ AWS region. #### Defined in -[index.ts:41](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L41) +[index.ts:41](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L41) diff --git a/docs/reference/letsgo-db/interfaces/ListItemsResult.md b/docs/reference/letsgo-db/interfaces/ListItemsResult.md index 118cac2..e9d3f9c 100644 --- a/docs/reference/letsgo-db/interfaces/ListItemsResult.md +++ b/docs/reference/letsgo-db/interfaces/ListItemsResult.md @@ -27,7 +27,7 @@ The list of items matching the query. #### Defined in -[index.ts:101](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L101) +[index.ts:101](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L101) ___ @@ -41,4 +41,4 @@ retrieve the next page of results. #### Defined in -[index.ts:107](https://github.com/47chapters/letsgo/blob/11c7e19/packages/db/src/index.ts#L107) +[index.ts:107](https://github.com/47chapters/letsgo/blob/5310a6f/packages/db/src/index.ts#L107) diff --git a/docs/reference/letsgo-queue/README.md b/docs/reference/letsgo-queue/README.md index aca8373..243beb0 100644 --- a/docs/reference/letsgo-queue/README.md +++ b/docs/reference/letsgo-queue/README.md @@ -42,7 +42,7 @@ Enqeue result, including SQS message Id. #### Defined in -[index.ts:203](https://github.com/47chapters/letsgo/blob/11c7e19/packages/queue/src/index.ts#L203) +[index.ts:203](https://github.com/47chapters/letsgo/blob/5310a6f/packages/queue/src/index.ts#L203) ___ @@ -67,4 +67,4 @@ Array of matching SQS queue URLs #### Defined in -[index.ts:40](https://github.com/47chapters/letsgo/blob/11c7e19/packages/queue/src/index.ts#L40) +[index.ts:40](https://github.com/47chapters/letsgo/blob/5310a6f/packages/queue/src/index.ts#L40) diff --git a/docs/reference/letsgo-queue/interfaces/EnqueueOptions.md b/docs/reference/letsgo-queue/interfaces/EnqueueOptions.md index 08f0afe..ce15e04 100644 --- a/docs/reference/letsgo-queue/interfaces/EnqueueOptions.md +++ b/docs/reference/letsgo-queue/interfaces/EnqueueOptions.md @@ -20,4 +20,4 @@ The number of seconds to delay the message readiness for delivery to the worker. #### Defined in -[index.ts:113](https://github.com/47chapters/letsgo/blob/11c7e19/packages/queue/src/index.ts#L113) +[index.ts:113](https://github.com/47chapters/letsgo/blob/5310a6f/packages/queue/src/index.ts#L113) diff --git a/docs/reference/letsgo-queue/interfaces/EnqueueResult.md b/docs/reference/letsgo-queue/interfaces/EnqueueResult.md index 7a37236..372ab09 100644 --- a/docs/reference/letsgo-queue/interfaces/EnqueueResult.md +++ b/docs/reference/letsgo-queue/interfaces/EnqueueResult.md @@ -20,4 +20,4 @@ The SQS message ID. #### Defined in -[index.ts:123](https://github.com/47chapters/letsgo/blob/11c7e19/packages/queue/src/index.ts#L123) +[index.ts:123](https://github.com/47chapters/letsgo/blob/5310a6f/packages/queue/src/index.ts#L123) diff --git a/docs/reference/letsgo-stripe/README.md b/docs/reference/letsgo-stripe/README.md index 7f7443c..26d3c62 100644 --- a/docs/reference/letsgo-stripe/README.md +++ b/docs/reference/letsgo-stripe/README.md @@ -61,7 +61,7 @@ Updated Stripe subscription. #### Defined in -[index.ts:486](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L486) +[index.ts:487](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L487) ___ @@ -86,7 +86,7 @@ Parameters describing the result of a completed Stripe payment setup. #### Defined in -[index.ts:394](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L394) +[index.ts:395](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L395) ___ @@ -110,7 +110,7 @@ New Stripe customer. #### Defined in -[index.ts:147](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L147) +[index.ts:147](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L147) ___ @@ -136,7 +136,7 @@ Parameters describing the newly created Stripe payment setup including the payme #### Defined in -[index.ts:327](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L327) +[index.ts:328](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L328) ___ @@ -161,7 +161,7 @@ Parameters describing the newly created Stripe subscription including the paymen #### Defined in -[index.ts:266](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L266) +[index.ts:266](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L266) ___ @@ -186,7 +186,7 @@ The Stripe price with the specified lookup key. #### Defined in -[index.ts:185](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L185) +[index.ts:185](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L185) ___ @@ -204,7 +204,7 @@ determine the public, secret, and webhook keys for Stripe. #### Defined in -[index.ts:40](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L40) +[index.ts:40](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L40) ___ @@ -228,7 +228,7 @@ Select parameters of a Stripe subscription with the specified ID or `undefined` #### Defined in -[index.ts:521](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L521) +[index.ts:522](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L522) ___ @@ -252,7 +252,7 @@ The Stripe price with the specified lookup key or undefined if not found. #### Defined in -[index.ts:168](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L168) +[index.ts:168](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L168) ___ @@ -276,7 +276,7 @@ Updated Stripe subscription. #### Defined in -[index.ts:445](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L445) +[index.ts:446](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L446) ___ @@ -300,4 +300,4 @@ Validated Stripe event. #### Defined in -[index.ts:106](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L106) +[index.ts:106](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L106) diff --git a/docs/reference/letsgo-stripe/interfaces/CancelSubscriptionOptions.md b/docs/reference/letsgo-stripe/interfaces/CancelSubscriptionOptions.md index c44e658..f243477 100644 --- a/docs/reference/letsgo-stripe/interfaces/CancelSubscriptionOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/CancelSubscriptionOptions.md @@ -21,7 +21,7 @@ Identity of the LetsGo user who initiated the transaction to cancel the Stripe s #### Defined in -[index.ts:477](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L477) +[index.ts:478](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L478) ___ @@ -33,4 +33,4 @@ The Stripe subscription ID to cancel. #### Defined in -[index.ts:473](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L473) +[index.ts:474](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L474) diff --git a/docs/reference/letsgo-stripe/interfaces/CardInfo.md b/docs/reference/letsgo-stripe/interfaces/CardInfo.md index a66ac6f..a41b60f 100644 --- a/docs/reference/letsgo-stripe/interfaces/CardInfo.md +++ b/docs/reference/letsgo-stripe/interfaces/CardInfo.md @@ -21,7 +21,7 @@ The brand of the credit card. #### Defined in -[index.ts:370](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L370) +[index.ts:371](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L371) ___ @@ -33,4 +33,4 @@ Last four digits of the credit card number. #### Defined in -[index.ts:366](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L366) +[index.ts:367](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L367) diff --git a/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupOptions.md b/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupOptions.md index 70ef5db..f536233 100644 --- a/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupOptions.md @@ -22,7 +22,7 @@ The Stripe customer ID for whom the payment setup is being completed for. #### Defined in -[index.ts:352](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L352) +[index.ts:353](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L353) ___ @@ -34,7 +34,7 @@ The Stripe setup intent ID that is being completed. #### Defined in -[index.ts:348](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L348) +[index.ts:349](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L349) ___ @@ -46,4 +46,4 @@ The Stripe subscription ID to associate with the new payment method. #### Defined in -[index.ts:356](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L356) +[index.ts:357](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L357) diff --git a/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupResponse.md b/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupResponse.md index 3dc14fd..58b9793 100644 --- a/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupResponse.md +++ b/docs/reference/letsgo-stripe/interfaces/CompletePaymentSetupResponse.md @@ -22,7 +22,7 @@ New credit card information if the payment setup was successful. #### Defined in -[index.ts:385](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L385) +[index.ts:386](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L386) ___ @@ -34,4 +34,4 @@ Status of the completed Stripe payment setup. #### Defined in -[index.ts:381](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L381) +[index.ts:382](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L382) diff --git a/docs/reference/letsgo-stripe/interfaces/CreateCustomerOptions.md b/docs/reference/letsgo-stripe/interfaces/CreateCustomerOptions.md index e2f8a12..f61a22e 100644 --- a/docs/reference/letsgo-stripe/interfaces/CreateCustomerOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/CreateCustomerOptions.md @@ -24,7 +24,7 @@ of the LetsGo user who initiated the transaction, if available. #### Defined in -[index.ts:139](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L139) +[index.ts:139](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L139) ___ @@ -36,7 +36,7 @@ Identity of the LetsGo user who initiated the transaction to associate with the #### Defined in -[index.ts:130](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L130) +[index.ts:130](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L130) ___ @@ -48,7 +48,7 @@ Friendly name of the customer in Stripe. #### Defined in -[index.ts:134](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L134) +[index.ts:134](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L134) ___ @@ -60,4 +60,4 @@ LetsGo tenant ID to associate with the Stripe customer. #### Defined in -[index.ts:126](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L126) +[index.ts:126](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L126) diff --git a/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupOptions.md b/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupOptions.md index 18c45a0..18f7d47 100644 --- a/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupOptions.md @@ -20,4 +20,4 @@ Existing Stripe customer ID for whom to create the payment setup. #### Defined in -[index.ts:301](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L301) +[index.ts:302](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L302) diff --git a/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupResponse.md b/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupResponse.md index 75d67b4..14bfe2a 100644 --- a/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupResponse.md +++ b/docs/reference/letsgo-stripe/interfaces/CreateNewPaymentSetupResponse.md @@ -22,7 +22,7 @@ Client secret for the Stripe payment intent. #### Defined in -[index.ts:312](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L312) +[index.ts:313](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L313) ___ @@ -35,4 +35,4 @@ on the Stripe configuration. #### Defined in -[index.ts:317](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L317) +[index.ts:318](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L318) diff --git a/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionOptions.md b/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionOptions.md index 8fa5eaa..aa85464 100644 --- a/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionOptions.md @@ -23,7 +23,7 @@ Stripe customer ID. #### Defined in -[index.ts:200](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L200) +[index.ts:200](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L200) ___ @@ -35,7 +35,7 @@ Identity of the LetsGo user who initiated the transaction to associate with the #### Defined in -[index.ts:208](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L208) +[index.ts:208](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L208) ___ @@ -47,7 +47,7 @@ LetsGo plan ID to use as a lookup key to locate a Stripe price to associate with #### Defined in -[index.ts:212](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L212) +[index.ts:212](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L212) ___ @@ -59,4 +59,4 @@ LetsGo tenant ID to associate with the Stripe subscription. #### Defined in -[index.ts:204](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L204) +[index.ts:204](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L204) diff --git a/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionResponse.md b/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionResponse.md index 6f0265d..cedb350 100644 --- a/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionResponse.md +++ b/docs/reference/letsgo-stripe/interfaces/CreateNewSubscriptionResponse.md @@ -30,7 +30,7 @@ Client secret for the Stripe payment intent. #### Defined in -[index.ts:252](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L252) +[index.ts:252](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L252) ___ @@ -46,7 +46,7 @@ Date and time when the current subscription period ends. #### Defined in -[index.ts:230](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L230) +[index.ts:230](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L230) ___ @@ -59,7 +59,7 @@ on the Stripe configuration. #### Defined in -[index.ts:257](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L257) +[index.ts:257](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L257) ___ @@ -75,7 +75,7 @@ Stripe subscription status. #### Defined in -[index.ts:226](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L226) +[index.ts:226](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L226) ___ @@ -91,4 +91,4 @@ Stripe subscription Id. #### Defined in -[index.ts:222](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L222) +[index.ts:222](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L222) diff --git a/docs/reference/letsgo-stripe/interfaces/GetSubscriptionResponse.md b/docs/reference/letsgo-stripe/interfaces/GetSubscriptionResponse.md index 78381d7..7730891 100644 --- a/docs/reference/letsgo-stripe/interfaces/GetSubscriptionResponse.md +++ b/docs/reference/letsgo-stripe/interfaces/GetSubscriptionResponse.md @@ -30,7 +30,7 @@ Credit card information on file. #### Defined in -[index.ts:513](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L513) +[index.ts:514](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L514) ___ @@ -46,7 +46,7 @@ Date and time when the current subscription period ends. #### Defined in -[index.ts:230](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L230) +[index.ts:230](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L230) ___ @@ -58,7 +58,7 @@ LetsGo plan ID associated with the Stripe subscription. #### Defined in -[index.ts:509](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L509) +[index.ts:510](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L510) ___ @@ -74,7 +74,7 @@ Stripe subscription status. #### Defined in -[index.ts:226](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L226) +[index.ts:226](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L226) ___ @@ -90,4 +90,4 @@ Stripe subscription Id. #### Defined in -[index.ts:222](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L222) +[index.ts:222](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L222) diff --git a/docs/reference/letsgo-stripe/interfaces/StripeConfiguration.md b/docs/reference/letsgo-stripe/interfaces/StripeConfiguration.md index 365c21e..100eb31 100644 --- a/docs/reference/letsgo-stripe/interfaces/StripeConfiguration.md +++ b/docs/reference/letsgo-stripe/interfaces/StripeConfiguration.md @@ -21,7 +21,7 @@ Configuration for _live_ or _test_ mode of the Stripe API client. #### Defined in -[index.ts:23](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L23) +[index.ts:23](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L23) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[index.ts:22](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L22) +[index.ts:22](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L22) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[index.ts:21](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L21) +[index.ts:21](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L21) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[index.ts:24](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L24) +[index.ts:24](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L24) diff --git a/docs/reference/letsgo-stripe/interfaces/SubscriptionResponse.md b/docs/reference/letsgo-stripe/interfaces/SubscriptionResponse.md index 17416ea..f10b753 100644 --- a/docs/reference/letsgo-stripe/interfaces/SubscriptionResponse.md +++ b/docs/reference/letsgo-stripe/interfaces/SubscriptionResponse.md @@ -30,7 +30,7 @@ Date and time when the current subscription period ends. #### Defined in -[index.ts:230](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L230) +[index.ts:230](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L230) ___ @@ -42,7 +42,7 @@ Stripe subscription status. #### Defined in -[index.ts:226](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L226) +[index.ts:226](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L226) ___ @@ -54,4 +54,4 @@ Stripe subscription Id. #### Defined in -[index.ts:222](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L222) +[index.ts:222](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L222) diff --git a/docs/reference/letsgo-stripe/interfaces/UpdateSubscriptionOptions.md b/docs/reference/letsgo-stripe/interfaces/UpdateSubscriptionOptions.md index f7afc1a..9a12b00 100644 --- a/docs/reference/letsgo-stripe/interfaces/UpdateSubscriptionOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/UpdateSubscriptionOptions.md @@ -22,7 +22,7 @@ Identity of the LetsGo user who initiated the transaction to update the Stripe s #### Defined in -[index.ts:433](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L433) +[index.ts:434](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L434) ___ @@ -34,7 +34,7 @@ LetsGo plan ID to use as a lookup key to locate the new Stripe price to associat #### Defined in -[index.ts:437](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L437) +[index.ts:438](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L438) ___ @@ -46,4 +46,4 @@ The Stripe subscription ID to update. #### Defined in -[index.ts:429](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L429) +[index.ts:430](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L430) diff --git a/docs/reference/letsgo-stripe/interfaces/ValidateWebhookEventOptions.md b/docs/reference/letsgo-stripe/interfaces/ValidateWebhookEventOptions.md index 4087a21..7c2797f 100644 --- a/docs/reference/letsgo-stripe/interfaces/ValidateWebhookEventOptions.md +++ b/docs/reference/letsgo-stripe/interfaces/ValidateWebhookEventOptions.md @@ -21,7 +21,7 @@ The raw body of the incoming webhook request. #### Defined in -[index.ts:94](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L94) +[index.ts:94](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L94) ___ @@ -33,4 +33,4 @@ The value of the `Stripe-signature` HTTP request header. #### Defined in -[index.ts:98](https://github.com/47chapters/letsgo/blob/11c7e19/packages/stripe/src/index.ts#L98) +[index.ts:98](https://github.com/47chapters/letsgo/blob/5310a6f/packages/stripe/src/index.ts#L98) diff --git a/docs/reference/letsgo-tenant/README.md b/docs/reference/letsgo-tenant/README.md index 33dff5f..0dd24d2 100644 --- a/docs/reference/letsgo-tenant/README.md +++ b/docs/reference/letsgo-tenant/README.md @@ -63,7 +63,7 @@ The _database_ category for items representing a specific tenant's users. #### Defined in -[tenant/src/index.ts:53](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L53) +[tenant/src/index.ts:53](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L53) ___ @@ -75,7 +75,7 @@ The _database_ category for items representing invitations for a specific tenant #### Defined in -[tenant/src/index.ts:58](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L58) +[tenant/src/index.ts:58](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L58) ___ @@ -87,7 +87,7 @@ The _database_ category for items representing LetsGo tenants. #### Defined in -[tenant/src/index.ts:43](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L43) +[tenant/src/index.ts:43](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L43) ___ @@ -99,7 +99,7 @@ The _database_ category for items representing a specific user's access to tenan #### Defined in -[tenant/src/index.ts:48](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L48) +[tenant/src/index.ts:48](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L48) ## Functions @@ -121,7 +121,7 @@ Adds a new user to a tenant. #### Defined in -[tenant/src/index.ts:734](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L734) +[tenant/src/index.ts:734](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L734) ___ @@ -145,7 +145,7 @@ New invitation #### Defined in -[tenant/src/index.ts:333](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L333) +[tenant/src/index.ts:333](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L333) ___ @@ -170,7 +170,7 @@ The newly created tenant. #### Defined in -[tenant/src/index.ts:460](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L460) +[tenant/src/index.ts:460](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L460) ___ @@ -192,7 +192,7 @@ Revoke an inviation to join a tenant. #### Defined in -[tenant/src/index.ts:398](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L398) +[tenant/src/index.ts:398](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L398) ___ @@ -216,7 +216,7 @@ The deleted tenant, or undefined if the tenant was alrady deleted or does not ex #### Defined in -[tenant/src/index.ts:591](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L591) +[tenant/src/index.ts:591](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L591) ___ @@ -240,7 +240,7 @@ Array of users who are members of the tenant. #### Defined in -[tenant/src/index.ts:664](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L664) +[tenant/src/index.ts:664](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L664) ___ @@ -264,7 +264,7 @@ The invitation if it exists and has not expired, undefined otherwise. #### Defined in -[tenant/src/index.ts:369](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L369) +[tenant/src/index.ts:369](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L369) ___ @@ -288,7 +288,7 @@ Array of active invitations. #### Defined in -[tenant/src/index.ts:423](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L423) +[tenant/src/index.ts:423](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L423) ___ @@ -312,7 +312,7 @@ The tenant if it exists and is not deleted, undefined otherwise. #### Defined in -[tenant/src/index.ts:516](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L516) +[tenant/src/index.ts:516](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L516) ___ @@ -336,7 +336,7 @@ Array of tenants the user has access to. #### Defined in -[tenant/src/index.ts:626](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L626) +[tenant/src/index.ts:626](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L626) ___ @@ -360,7 +360,7 @@ True if the user is member of the tenant, false otherwise. #### Defined in -[tenant/src/index.ts:705](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L705) +[tenant/src/index.ts:705](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L705) ___ @@ -384,7 +384,7 @@ The updated tenant. #### Defined in -[tenant/src/index.ts:556](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L556) +[tenant/src/index.ts:556](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L556) ___ @@ -409,7 +409,7 @@ The updated tenant if the subscription status changed, undefined if there were n #### Defined in -[tenant/src/index.ts:287](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L287) +[tenant/src/index.ts:287](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L287) ___ @@ -431,7 +431,7 @@ Removes a user from a tenant. #### Defined in -[tenant/src/index.ts:763](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L763) +[tenant/src/index.ts:763](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L763) ___ @@ -455,4 +455,4 @@ Update the tenant with a new plan ID and record the change. #### Defined in -[tenant/src/index.ts:254](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L254) +[tenant/src/index.ts:254](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L254) diff --git a/docs/reference/letsgo-tenant/interfaces/AddIdentityToTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/AddIdentityToTenantOptions.md index a9f481c..222f29d 100644 --- a/docs/reference/letsgo-tenant/interfaces/AddIdentityToTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/AddIdentityToTenantOptions.md @@ -45,7 +45,7 @@ LetsGo identity. #### Defined in -[tenant/src/index.ts:727](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L727) +[tenant/src/index.ts:727](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L727) ___ @@ -73,4 +73,4 @@ LetsGo tenant Id. #### Defined in -[tenant/src/index.ts:723](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L723) +[tenant/src/index.ts:723](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L723) diff --git a/docs/reference/letsgo-tenant/interfaces/CreateInvitationOptions.md b/docs/reference/letsgo-tenant/interfaces/CreateInvitationOptions.md index 8139cbc..604c330 100644 --- a/docs/reference/letsgo-tenant/interfaces/CreateInvitationOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/CreateInvitationOptions.md @@ -30,7 +30,7 @@ The identity of the user who is creating the invitation. #### Defined in -[tenant/src/index.ts:270](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L270) +[tenant/src/index.ts:270](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L270) ___ @@ -74,7 +74,7 @@ The tenant ID the invitation relates to. #### Defined in -[tenant/src/index.ts:274](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L274) +[tenant/src/index.ts:274](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L274) ___ @@ -86,4 +86,4 @@ The time-to-live of the invitation in seconds. #### Defined in -[tenant/src/index.ts:278](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L278) +[tenant/src/index.ts:278](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L278) diff --git a/docs/reference/letsgo-tenant/interfaces/CreateTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/CreateTenantOptions.md index a946e9d..d08fe05 100644 --- a/docs/reference/letsgo-tenant/interfaces/CreateTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/CreateTenantOptions.md @@ -29,7 +29,7 @@ The identity of the user who is creating the tenant. #### Defined in -[tenant/src/index.ts:447](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L447) +[tenant/src/index.ts:447](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L447) ___ @@ -57,7 +57,7 @@ The tenant's display name. If not specified, a random display name is generated. #### Defined in -[tenant/src/index.ts:451](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L451) +[tenant/src/index.ts:451](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L451) ___ diff --git a/docs/reference/letsgo-tenant/interfaces/DeleteInvitationOptions.md b/docs/reference/letsgo-tenant/interfaces/DeleteInvitationOptions.md index 0609de4..e079107 100644 --- a/docs/reference/letsgo-tenant/interfaces/DeleteInvitationOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/DeleteInvitationOptions.md @@ -45,7 +45,7 @@ The invitation ID. #### Defined in -[tenant/src/index.ts:391](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L391) +[tenant/src/index.ts:391](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L391) ___ @@ -73,4 +73,4 @@ The tenant ID the invitation relates to. #### Defined in -[tenant/src/index.ts:387](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L387) +[tenant/src/index.ts:387](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L387) diff --git a/docs/reference/letsgo-tenant/interfaces/DeleteTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/DeleteTenantOptions.md index e3aa106..bdbbe05 100644 --- a/docs/reference/letsgo-tenant/interfaces/DeleteTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/DeleteTenantOptions.md @@ -29,7 +29,7 @@ The identity of the user who is deleting the tenant. #### Defined in -[tenant/src/index.ts:583](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L583) +[tenant/src/index.ts:583](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L583) ___ @@ -73,4 +73,4 @@ The ID of the tenant to delete. #### Defined in -[tenant/src/index.ts:579](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L579) +[tenant/src/index.ts:579](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L579) diff --git a/docs/reference/letsgo-tenant/interfaces/GetIdentitiesOfTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/GetIdentitiesOfTenantOptions.md index 0820a0c..2f866bb 100644 --- a/docs/reference/letsgo-tenant/interfaces/GetIdentitiesOfTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/GetIdentitiesOfTenantOptions.md @@ -60,4 +60,4 @@ The Id of the tenant whose users are to be returned. #### Defined in -[tenant/src/index.ts:656](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L656) +[tenant/src/index.ts:656](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L656) diff --git a/docs/reference/letsgo-tenant/interfaces/GetInvitationOptions.md b/docs/reference/letsgo-tenant/interfaces/GetInvitationOptions.md index f230630..0792186 100644 --- a/docs/reference/letsgo-tenant/interfaces/GetInvitationOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/GetInvitationOptions.md @@ -45,7 +45,7 @@ The invitation ID. #### Defined in -[tenant/src/index.ts:361](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L361) +[tenant/src/index.ts:361](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L361) ___ @@ -73,4 +73,4 @@ The tenant ID the invitation relates to. #### Defined in -[tenant/src/index.ts:357](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L357) +[tenant/src/index.ts:357](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L357) diff --git a/docs/reference/letsgo-tenant/interfaces/GetInvitationsOptions.md b/docs/reference/letsgo-tenant/interfaces/GetInvitationsOptions.md index dd1ca1d..70d55f5 100644 --- a/docs/reference/letsgo-tenant/interfaces/GetInvitationsOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/GetInvitationsOptions.md @@ -60,4 +60,4 @@ The tenant ID the invitations relate to. #### Defined in -[tenant/src/index.ts:415](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L415) +[tenant/src/index.ts:415](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L415) diff --git a/docs/reference/letsgo-tenant/interfaces/GetTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/GetTenantOptions.md index 1b6bc62..0fb68ef 100644 --- a/docs/reference/letsgo-tenant/interfaces/GetTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/GetTenantOptions.md @@ -45,7 +45,7 @@ If true, the tenant is returned even if it is deleted (i.e. it's `deletedAt` pro #### Defined in -[tenant/src/index.ts:508](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L508) +[tenant/src/index.ts:508](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L508) ___ @@ -73,4 +73,4 @@ The ID of the tenant to get. #### Defined in -[tenant/src/index.ts:504](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L504) +[tenant/src/index.ts:504](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L504) diff --git a/docs/reference/letsgo-tenant/interfaces/GetTenantsOfIdentityOptions.md b/docs/reference/letsgo-tenant/interfaces/GetTenantsOfIdentityOptions.md index fa3ffcb..0262b72 100644 --- a/docs/reference/letsgo-tenant/interfaces/GetTenantsOfIdentityOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/GetTenantsOfIdentityOptions.md @@ -45,7 +45,7 @@ The identity of the user whose tenants are to be returned. #### Defined in -[tenant/src/index.ts:614](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L614) +[tenant/src/index.ts:614](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L614) ___ @@ -57,7 +57,7 @@ If true, the result includes tenants that have been deleted. #### Defined in -[tenant/src/index.ts:618](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L618) +[tenant/src/index.ts:618](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L618) ___ diff --git a/docs/reference/letsgo-tenant/interfaces/Invitation.md b/docs/reference/letsgo-tenant/interfaces/Invitation.md index 3503a28..9db064f 100644 --- a/docs/reference/letsgo-tenant/interfaces/Invitation.md +++ b/docs/reference/letsgo-tenant/interfaces/Invitation.md @@ -48,7 +48,7 @@ The timestamp of the invitation's creation. #### Defined in -[tenant/src/index.ts:184](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L184) +[tenant/src/index.ts:184](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L184) ___ @@ -60,7 +60,7 @@ The identity of the user who created the invitation. #### Defined in -[tenant/src/index.ts:180](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L180) +[tenant/src/index.ts:180](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L180) ___ @@ -72,7 +72,7 @@ The timestamp of the invitation's expiration. #### Defined in -[tenant/src/index.ts:188](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L188) +[tenant/src/index.ts:188](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L188) ___ @@ -84,7 +84,7 @@ The invitation ID. This is unique within a tenant. #### Defined in -[tenant/src/index.ts:176](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L176) +[tenant/src/index.ts:176](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L176) ___ @@ -116,4 +116,4 @@ DBItem.ttl #### Defined in -[tenant/src/index.ts:192](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L192) +[tenant/src/index.ts:192](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L192) diff --git a/docs/reference/letsgo-tenant/interfaces/IsIdentityInTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/IsIdentityInTenantOptions.md index 3d18552..c147ef1 100644 --- a/docs/reference/letsgo-tenant/interfaces/IsIdentityInTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/IsIdentityInTenantOptions.md @@ -45,7 +45,7 @@ LetsGo identity Id. #### Defined in -[tenant/src/index.ts:697](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L697) +[tenant/src/index.ts:697](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L697) ___ @@ -73,4 +73,4 @@ LetsGo tenant Id. #### Defined in -[tenant/src/index.ts:693](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L693) +[tenant/src/index.ts:693](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L693) diff --git a/docs/reference/letsgo-tenant/interfaces/PutTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/PutTenantOptions.md index 1cb7653..19bb61b 100644 --- a/docs/reference/letsgo-tenant/interfaces/PutTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/PutTenantOptions.md @@ -47,7 +47,7 @@ The tenant's display name. If not specified, the existing display name is used. #### Defined in -[tenant/src/index.ts:540](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L540) +[tenant/src/index.ts:540](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L540) ___ @@ -59,7 +59,7 @@ The tenant's updated subscription plan. If not specified, the existing plan is u #### Defined in -[tenant/src/index.ts:548](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L548) +[tenant/src/index.ts:548](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L548) ___ @@ -87,7 +87,7 @@ The ID of the tenant to update. #### Defined in -[tenant/src/index.ts:536](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L536) +[tenant/src/index.ts:536](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L536) ___ @@ -99,4 +99,4 @@ The identity of the user who is updating the tenant. #### Defined in -[tenant/src/index.ts:544](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L544) +[tenant/src/index.ts:544](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L544) diff --git a/docs/reference/letsgo-tenant/interfaces/RemoveIdentityFromTenantOptions.md b/docs/reference/letsgo-tenant/interfaces/RemoveIdentityFromTenantOptions.md index e09d808..635c2ce 100644 --- a/docs/reference/letsgo-tenant/interfaces/RemoveIdentityFromTenantOptions.md +++ b/docs/reference/letsgo-tenant/interfaces/RemoveIdentityFromTenantOptions.md @@ -45,7 +45,7 @@ LetsGo identity. #### Defined in -[tenant/src/index.ts:756](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L756) +[tenant/src/index.ts:756](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L756) ___ @@ -73,4 +73,4 @@ LetsGo tenant Id. #### Defined in -[tenant/src/index.ts:752](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L752) +[tenant/src/index.ts:752](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L752) diff --git a/docs/reference/letsgo-tenant/interfaces/SubscriptionPlan.md b/docs/reference/letsgo-tenant/interfaces/SubscriptionPlan.md index 42ce978..003447c 100644 --- a/docs/reference/letsgo-tenant/interfaces/SubscriptionPlan.md +++ b/docs/reference/letsgo-tenant/interfaces/SubscriptionPlan.md @@ -23,7 +23,7 @@ History of changes of the tenant's subscription plan. #### Defined in -[tenant/src/index.ts:123](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L123) +[tenant/src/index.ts:123](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L123) ___ @@ -35,7 +35,7 @@ The plan ID. #### Defined in -[tenant/src/index.ts:92](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L92) +[tenant/src/index.ts:92](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L92) ___ @@ -48,7 +48,7 @@ if the tenant's Stripe subscription is canceled and later reactivated. #### Defined in -[tenant/src/index.ts:97](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L97) +[tenant/src/index.ts:97](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L97) ___ @@ -70,4 +70,4 @@ or a custom plan handled outside of Stripe's realm). #### Defined in -[tenant/src/index.ts:102](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L102) +[tenant/src/index.ts:102](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L102) diff --git a/docs/reference/letsgo-tenant/interfaces/SubscriptionPlanChange.md b/docs/reference/letsgo-tenant/interfaces/SubscriptionPlanChange.md index 5230b7a..75efbae 100644 --- a/docs/reference/letsgo-tenant/interfaces/SubscriptionPlanChange.md +++ b/docs/reference/letsgo-tenant/interfaces/SubscriptionPlanChange.md @@ -22,7 +22,7 @@ The new plan ID the tenant switched to. #### Defined in -[tenant/src/index.ts:82](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L82) +[tenant/src/index.ts:82](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L82) ___ @@ -34,7 +34,7 @@ The timestamp of the change. #### Defined in -[tenant/src/index.ts:74](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L74) +[tenant/src/index.ts:74](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L74) ___ @@ -46,4 +46,4 @@ The identity of the user who made the change. #### Defined in -[tenant/src/index.ts:78](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L78) +[tenant/src/index.ts:78](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L78) diff --git a/docs/reference/letsgo-tenant/interfaces/Tenant.md b/docs/reference/letsgo-tenant/interfaces/Tenant.md index 4bd9ded..e0723ba 100644 --- a/docs/reference/letsgo-tenant/interfaces/Tenant.md +++ b/docs/reference/letsgo-tenant/interfaces/Tenant.md @@ -53,7 +53,7 @@ The timestamp of the tenant's creation. #### Defined in -[tenant/src/index.ts:141](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L141) +[tenant/src/index.ts:141](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L141) ___ @@ -65,7 +65,7 @@ The identity of the user who created the tenant. #### Defined in -[tenant/src/index.ts:145](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L145) +[tenant/src/index.ts:145](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L145) ___ @@ -78,7 +78,7 @@ the tenant is considered non-exitent in the UX of the end user. #### Defined in -[tenant/src/index.ts:158](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L158) +[tenant/src/index.ts:158](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L158) ___ @@ -90,7 +90,7 @@ The identity of the user who deleted the tenant. #### Defined in -[tenant/src/index.ts:162](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L162) +[tenant/src/index.ts:162](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L162) ___ @@ -102,7 +102,7 @@ The tenant's display name. This does not need to be unique in the system. #### Defined in -[tenant/src/index.ts:137](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L137) +[tenant/src/index.ts:137](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L137) ___ @@ -130,7 +130,7 @@ The tenant's subscription plan. A tenant is _always_ associated with a subscript #### Defined in -[tenant/src/index.ts:166](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L166) +[tenant/src/index.ts:166](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L166) ___ @@ -142,7 +142,7 @@ The tenant ID. This is unique in the system. #### Defined in -[tenant/src/index.ts:133](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L133) +[tenant/src/index.ts:133](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L133) ___ @@ -170,7 +170,7 @@ The timestamp of the last update to the tenant. #### Defined in -[tenant/src/index.ts:149](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L149) +[tenant/src/index.ts:149](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L149) ___ @@ -182,4 +182,4 @@ The identity of the user who last updated the tenant. #### Defined in -[tenant/src/index.ts:153](https://github.com/47chapters/letsgo/blob/11c7e19/packages/tenant/src/index.ts#L153) +[tenant/src/index.ts:153](https://github.com/47chapters/letsgo/blob/5310a6f/packages/tenant/src/index.ts#L153) diff --git a/docs/reference/letsgo-trust/README.md b/docs/reference/letsgo-trust/README.md index 42612f1..02d5618 100644 --- a/docs/reference/letsgo-trust/README.md +++ b/docs/reference/letsgo-trust/README.md @@ -60,7 +60,7 @@ An issuer is either a third-party JWKS-based issuer or a built-in PKI-based issu #### Defined in -[trust/src/issuer.ts:61](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L61) +[trust/src/issuer.ts:61](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L61) ## Variables @@ -72,7 +72,7 @@ Default expiry for JWT access tokens created using built-in PKI issuers. #### Defined in -[trust/src/jwt.ts:9](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L9) +[trust/src/jwt.ts:9](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L9) ## Functions @@ -96,7 +96,7 @@ Adds a new third party JWKS issuer to the system. #### Defined in -[trust/src/issuer.ts:171](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L171) +[trust/src/issuer.ts:171](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L171) ___ @@ -122,7 +122,7 @@ The new build-in PKI issuer. #### Defined in -[trust/src/issuer.ts:275](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L275) +[trust/src/issuer.ts:275](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L275) ___ @@ -146,7 +146,7 @@ The JWT access token. #### Defined in -[trust/src/jwt.ts:40](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L40) +[trust/src/jwt.ts:40](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L40) ___ @@ -168,7 +168,7 @@ Deletes an identity from the database. Identities are stored in the `letsgo-iden #### Defined in -[trust/src/identity.ts:104](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L104) +[trust/src/identity.ts:104](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L104) ___ @@ -191,7 +191,7 @@ Removes an issuer from the system. Access tokens issued by the issuer will no lo #### Defined in -[trust/src/issuer.ts:248](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L248) +[trust/src/issuer.ts:248](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L248) ___ @@ -215,7 +215,7 @@ Deserialized identity. #### Defined in -[trust/src/index.ts:45](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/index.ts#L45) +[trust/src/index.ts:45](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/index.ts#L45) ___ @@ -239,7 +239,7 @@ Active PKI issuer or undefined if no active PKI issuer exists. #### Defined in -[trust/src/issuer.ts:192](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L192) +[trust/src/issuer.ts:192](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L192) ___ @@ -263,7 +263,7 @@ The identity result or undefined if the identity does not exist. #### Defined in -[trust/src/identity.ts:88](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L88) +[trust/src/identity.ts:88](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L88) ___ @@ -288,7 +288,7 @@ Issuer or undefined if the issuer does not exist. #### Defined in -[trust/src/issuer.ts:261](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L261) +[trust/src/issuer.ts:261](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L261) ___ @@ -312,7 +312,7 @@ The `iss` claim value. #### Defined in -[trust/src/issuer.ts:105](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L105) +[trust/src/issuer.ts:105](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L105) ___ @@ -343,7 +343,7 @@ The RSA public key of the issuer in PEM format or undefined if the key cannot be #### Defined in -[trust/src/keyResolver.ts:140](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/keyResolver.ts#L140) +[trust/src/keyResolver.ts:140](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/keyResolver.ts#L140) ___ @@ -367,7 +367,7 @@ True if the `iss` represents a built-in PKI issuer, false otherwise. #### Defined in -[trust/src/issuer.ts:113](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L113) +[trust/src/issuer.ts:113](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L113) ___ @@ -391,7 +391,7 @@ True if the object is a JWKS issuer, false otherwise. #### Defined in -[trust/src/issuer.ts:82](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L82) +[trust/src/issuer.ts:82](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L82) ___ @@ -415,7 +415,7 @@ True if the object is a PKI issuer, false otherwise. #### Defined in -[trust/src/issuer.ts:91](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L91) +[trust/src/issuer.ts:91](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L91) ___ @@ -440,7 +440,7 @@ The list of issuers and the optional continuation token for paginated results. #### Defined in -[trust/src/issuer.ts:159](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L159) +[trust/src/issuer.ts:159](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L159) ___ @@ -462,7 +462,7 @@ Upserts an identity to the database. Identities are stored in the `letsgo-identi #### Defined in -[trust/src/identity.ts:49](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L49) +[trust/src/identity.ts:49](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L49) ___ @@ -486,7 +486,7 @@ identity Id #### Defined in -[trust/src/index.ts:34](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/index.ts#L34) +[trust/src/index.ts:34](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/index.ts#L34) ___ @@ -511,7 +511,7 @@ The new, active PKI issuer. #### Defined in -[trust/src/issuer.ts:215](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L215) +[trust/src/issuer.ts:215](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L215) ___ @@ -540,4 +540,4 @@ Parsed, validated JWT or undefined if the token is invalid. #### Defined in -[trust/src/jwt.ts:78](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L78) +[trust/src/jwt.ts:78](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L78) diff --git a/docs/reference/letsgo-trust/interfaces/CreateJwtOptions.md b/docs/reference/letsgo-trust/interfaces/CreateJwtOptions.md index 640aed4..e23c179 100644 --- a/docs/reference/letsgo-trust/interfaces/CreateJwtOptions.md +++ b/docs/reference/letsgo-trust/interfaces/CreateJwtOptions.md @@ -24,7 +24,7 @@ be used if specified, or `letsgo:service` otherwise. #### Defined in -[trust/src/jwt.ts:27](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L27) +[trust/src/jwt.ts:27](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L27) ___ @@ -37,7 +37,7 @@ or an expression like `8h`, `2d`, etc. If `0` is specified, a non-expiring JWT t #### Defined in -[trust/src/jwt.ts:32](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L32) +[trust/src/jwt.ts:32](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L32) ___ @@ -49,7 +49,7 @@ The built-in PKI issuer to use to sign the JWT. If not specified, the active iss #### Defined in -[trust/src/jwt.ts:18](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L18) +[trust/src/jwt.ts:18](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L18) ___ @@ -61,4 +61,4 @@ The `sub` claim of the JWT. If not specified, the same value as the `iss` claim #### Defined in -[trust/src/jwt.ts:22](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/jwt.ts#L22) +[trust/src/jwt.ts:22](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/jwt.ts#L22) diff --git a/docs/reference/letsgo-trust/interfaces/GetIdentityResult.md b/docs/reference/letsgo-trust/interfaces/GetIdentityResult.md index e3e4b8a..e7807f1 100644 --- a/docs/reference/letsgo-trust/interfaces/GetIdentityResult.md +++ b/docs/reference/letsgo-trust/interfaces/GetIdentityResult.md @@ -47,7 +47,7 @@ The serialized identityId of the user. #### Defined in -[trust/src/identity.ts:72](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L72) +[trust/src/identity.ts:72](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L72) ___ @@ -91,7 +91,7 @@ The timestamp of the last update to the identity. #### Defined in -[trust/src/identity.ts:80](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L80) +[trust/src/identity.ts:80](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L80) ___ @@ -103,4 +103,4 @@ Claims describing the user. #### Defined in -[trust/src/identity.ts:76](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L76) +[trust/src/identity.ts:76](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L76) diff --git a/docs/reference/letsgo-trust/interfaces/Identity.md b/docs/reference/letsgo-trust/interfaces/Identity.md index 7f7c48c..9a5a7b0 100644 --- a/docs/reference/letsgo-trust/interfaces/Identity.md +++ b/docs/reference/letsgo-trust/interfaces/Identity.md @@ -21,7 +21,7 @@ The issuer identifier of the identity. #### Defined in -[trust/src/index.ts:22](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/index.ts#L22) +[trust/src/index.ts:22](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/index.ts#L22) ___ @@ -33,4 +33,4 @@ The subject identifier of the identity, unique within the issuer. #### Defined in -[trust/src/index.ts:26](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/index.ts#L26) +[trust/src/index.ts:26](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/index.ts#L26) diff --git a/docs/reference/letsgo-trust/interfaces/IdentityOptions.md b/docs/reference/letsgo-trust/interfaces/IdentityOptions.md index 149bfd3..01c669e 100644 --- a/docs/reference/letsgo-trust/interfaces/IdentityOptions.md +++ b/docs/reference/letsgo-trust/interfaces/IdentityOptions.md @@ -47,7 +47,7 @@ The deserialized identity of the user. #### Defined in -[trust/src/identity.ts:32](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L32) +[trust/src/identity.ts:32](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L32) ___ @@ -59,7 +59,7 @@ The serialized identityId of the user. #### Defined in -[trust/src/identity.ts:28](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L28) +[trust/src/identity.ts:28](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L28) ___ diff --git a/docs/reference/letsgo-trust/interfaces/JwksIssuer.md b/docs/reference/letsgo-trust/interfaces/JwksIssuer.md index b77a040..7b10669 100644 --- a/docs/reference/letsgo-trust/interfaces/JwksIssuer.md +++ b/docs/reference/letsgo-trust/interfaces/JwksIssuer.md @@ -46,7 +46,7 @@ The time when the issuer was created. #### Defined in -[trust/src/issuer.ts:28](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L28) +[trust/src/issuer.ts:28](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L28) ___ @@ -58,7 +58,7 @@ The [JWKS](https://tools.ietf.org/html/rfc7517) URL of the issuer. #### Defined in -[trust/src/issuer.ts:24](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L24) +[trust/src/issuer.ts:24](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L24) ___ diff --git a/docs/reference/letsgo-trust/interfaces/ListIssuersResult.md b/docs/reference/letsgo-trust/interfaces/ListIssuersResult.md index 24882fc..2b43f67 100644 --- a/docs/reference/letsgo-trust/interfaces/ListIssuersResult.md +++ b/docs/reference/letsgo-trust/interfaces/ListIssuersResult.md @@ -21,7 +21,7 @@ List of issuers. #### Defined in -[trust/src/issuer.ts:70](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L70) +[trust/src/issuer.ts:70](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L70) ___ @@ -33,4 +33,4 @@ Continuation token for paginated results. #### Defined in -[trust/src/issuer.ts:74](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L74) +[trust/src/issuer.ts:74](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L74) diff --git a/docs/reference/letsgo-trust/interfaces/PkiCredentials.md b/docs/reference/letsgo-trust/interfaces/PkiCredentials.md index 9f0624e..abb7756 100644 --- a/docs/reference/letsgo-trust/interfaces/PkiCredentials.md +++ b/docs/reference/letsgo-trust/interfaces/PkiCredentials.md @@ -29,7 +29,7 @@ The time when the PKI credentials was created. #### Defined in -[trust/src/issuer.ts:50](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L50) +[trust/src/issuer.ts:50](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L50) ___ @@ -41,7 +41,7 @@ OAuth key identifier. #### Defined in -[trust/src/issuer.ts:46](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L46) +[trust/src/issuer.ts:46](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L46) ___ @@ -53,7 +53,7 @@ Private RSA key in PEM format. #### Defined in -[trust/src/issuer.ts:42](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L42) +[trust/src/issuer.ts:42](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L42) ___ @@ -65,4 +65,4 @@ Public RSA key in PEM format. #### Defined in -[trust/src/issuer.ts:38](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L38) +[trust/src/issuer.ts:38](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L38) diff --git a/docs/reference/letsgo-trust/interfaces/PkiIssuer.md b/docs/reference/letsgo-trust/interfaces/PkiIssuer.md index fb08a5e..aa7aba5 100644 --- a/docs/reference/letsgo-trust/interfaces/PkiIssuer.md +++ b/docs/reference/letsgo-trust/interfaces/PkiIssuer.md @@ -54,7 +54,7 @@ The time when the PKI credentials was created. #### Defined in -[trust/src/issuer.ts:50](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L50) +[trust/src/issuer.ts:50](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L50) ___ @@ -86,7 +86,7 @@ OAuth key identifier. #### Defined in -[trust/src/issuer.ts:46](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L46) +[trust/src/issuer.ts:46](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L46) ___ @@ -102,7 +102,7 @@ Private RSA key in PEM format. #### Defined in -[trust/src/issuer.ts:42](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L42) +[trust/src/issuer.ts:42](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L42) ___ @@ -118,7 +118,7 @@ Public RSA key in PEM format. #### Defined in -[trust/src/issuer.ts:38](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/issuer.ts#L38) +[trust/src/issuer.ts:38](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/issuer.ts#L38) ___ diff --git a/docs/reference/letsgo-trust/interfaces/PutIdentityOptions.md b/docs/reference/letsgo-trust/interfaces/PutIdentityOptions.md index b56a857..f0910df 100644 --- a/docs/reference/letsgo-trust/interfaces/PutIdentityOptions.md +++ b/docs/reference/letsgo-trust/interfaces/PutIdentityOptions.md @@ -50,7 +50,7 @@ The deserialized identity of the user. #### Defined in -[trust/src/identity.ts:32](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L32) +[trust/src/identity.ts:32](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L32) ___ @@ -66,7 +66,7 @@ The serialized identityId of the user. #### Defined in -[trust/src/identity.ts:28](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L28) +[trust/src/identity.ts:28](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L28) ___ @@ -94,4 +94,4 @@ Claims describing the user. #### Defined in -[trust/src/identity.ts:42](https://github.com/47chapters/letsgo/blob/11c7e19/packages/trust/src/identity.ts#L42) +[trust/src/identity.ts:42](https://github.com/47chapters/letsgo/blob/5310a6f/packages/trust/src/identity.ts#L42) diff --git a/docs/reference/letsgo-types/enums/MessageType.md b/docs/reference/letsgo-types/enums/MessageType.md index 6ac393c..ed7ae52 100644 --- a/docs/reference/letsgo-types/enums/MessageType.md +++ b/docs/reference/letsgo-types/enums/MessageType.md @@ -24,7 +24,7 @@ Submission of the contact form. #### Defined in -[index.ts:170](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L170) +[index.ts:174](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L174) ___ @@ -36,7 +36,7 @@ Stripe webhook event. #### Defined in -[index.ts:174](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L174) +[index.ts:178](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L178) ___ @@ -48,7 +48,7 @@ LetsGo tenant deleted. #### Defined in -[index.ts:182](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L182) +[index.ts:186](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L186) ___ @@ -60,4 +60,4 @@ New LetsGo tenant created. #### Defined in -[index.ts:178](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L178) +[index.ts:182](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L182) diff --git a/docs/reference/letsgo-types/interfaces/ContactMessage.md b/docs/reference/letsgo-types/interfaces/ContactMessage.md index 04fd9e5..0d9d27a 100644 --- a/docs/reference/letsgo-types/interfaces/ContactMessage.md +++ b/docs/reference/letsgo-types/interfaces/ContactMessage.md @@ -31,7 +31,7 @@ Message payload. #### Defined in -[index.ts:246](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L246) +[index.ts:250](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L250) ___ @@ -47,4 +47,4 @@ Message type. #### Defined in -[index.ts:242](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L242) +[index.ts:246](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L246) diff --git a/docs/reference/letsgo-types/interfaces/ContactMessagePayload.md b/docs/reference/letsgo-types/interfaces/ContactMessagePayload.md index b54e0ed..3f501d4 100644 --- a/docs/reference/letsgo-types/interfaces/ContactMessagePayload.md +++ b/docs/reference/letsgo-types/interfaces/ContactMessagePayload.md @@ -26,7 +26,7 @@ Email address of the sender. #### Defined in -[index.ts:206](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L206) +[index.ts:210](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L210) ___ @@ -38,7 +38,7 @@ Identity Id of the logged in user when the form was submitted. #### Defined in -[index.ts:232](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L232) +[index.ts:236](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L236) ___ @@ -50,7 +50,7 @@ Message provided by the sender. #### Defined in -[index.ts:214](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L214) +[index.ts:218](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L218) ___ @@ -62,7 +62,7 @@ Name of the sender. #### Defined in -[index.ts:210](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L210) +[index.ts:214](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L214) ___ @@ -78,7 +78,7 @@ Query parameters of the page where the contact form was submitted. #### Defined in -[index.ts:222](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L222) +[index.ts:226](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L226) ___ @@ -90,7 +90,7 @@ Current tenant Id if one was present in the context where the contact form was s #### Defined in -[index.ts:228](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L228) +[index.ts:232](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L232) ___ @@ -102,4 +102,4 @@ Timestamp of the submission. #### Defined in -[index.ts:218](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L218) +[index.ts:222](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L222) diff --git a/docs/reference/letsgo-types/interfaces/GetInvitationsResponse.md b/docs/reference/letsgo-types/interfaces/GetInvitationsResponse.md index 13c8ab7..e4822f2 100644 --- a/docs/reference/letsgo-types/interfaces/GetInvitationsResponse.md +++ b/docs/reference/letsgo-types/interfaces/GetInvitationsResponse.md @@ -20,4 +20,4 @@ Active invitations to the tenant. #### Defined in -[index.ts:89](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L89) +[index.ts:89](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L89) diff --git a/docs/reference/letsgo-types/interfaces/GetMeResponse.md b/docs/reference/letsgo-types/interfaces/GetMeResponse.md index 8824a53..4f40807 100644 --- a/docs/reference/letsgo-types/interfaces/GetMeResponse.md +++ b/docs/reference/letsgo-types/interfaces/GetMeResponse.md @@ -9,12 +9,25 @@ as the list of tenants that user has access to. ### Properties +- [accessToken](GetMeResponse.md#accesstoken) - [identity](GetMeResponse.md#identity) - [identityId](GetMeResponse.md#identityid) - [tenants](GetMeResponse.md#tenants) ## Properties +### accessToken + +• `Optional` **accessToken**: `string` + +The JWT access token of the user. This is only returned if the `returnAccessToken` query parameter is set. + +#### Defined in + +[index.ts:108](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L108) + +___ + ### identity • **identity**: `Identity` @@ -23,7 +36,7 @@ Deserialized identity of the user. #### Defined in -[index.ts:104](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L104) +[index.ts:104](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L104) ___ @@ -35,7 +48,7 @@ Serialized identityId of the user. #### Defined in -[index.ts:100](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L100) +[index.ts:100](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L100) ___ @@ -43,8 +56,6 @@ ___ • **tenants**: `Tenant`[] -List of tenants that the user has access to. - #### Defined in -[index.ts:108](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L108) +[index.ts:112](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L112) diff --git a/docs/reference/letsgo-types/interfaces/GetTenantUsersResponse.md b/docs/reference/letsgo-types/interfaces/GetTenantUsersResponse.md index e37e760..76d0bdd 100644 --- a/docs/reference/letsgo-types/interfaces/GetTenantUsersResponse.md +++ b/docs/reference/letsgo-types/interfaces/GetTenantUsersResponse.md @@ -20,4 +20,4 @@ Array of identities represeting users with access to the tenant. #### Defined in -[index.ts:17](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L17) +[index.ts:17](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L17) diff --git a/docs/reference/letsgo-types/interfaces/Message.md b/docs/reference/letsgo-types/interfaces/Message.md index 4ee3ed4..b7a7fdb 100644 --- a/docs/reference/letsgo-types/interfaces/Message.md +++ b/docs/reference/letsgo-types/interfaces/Message.md @@ -33,7 +33,7 @@ Message payload. #### Defined in -[index.ts:196](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L196) +[index.ts:200](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L200) ___ @@ -45,4 +45,4 @@ Message type. #### Defined in -[index.ts:192](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L192) +[index.ts:196](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L196) diff --git a/docs/reference/letsgo-types/interfaces/PostPaymentMethodResponse.md b/docs/reference/letsgo-types/interfaces/PostPaymentMethodResponse.md index 0c6d8d5..f4944d4 100644 --- a/docs/reference/letsgo-types/interfaces/PostPaymentMethodResponse.md +++ b/docs/reference/letsgo-types/interfaces/PostPaymentMethodResponse.md @@ -21,7 +21,7 @@ Stripe client secret to continue processing a new setup intent. #### Defined in -[index.ts:155](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L155) +[index.ts:159](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L159) ___ @@ -33,4 +33,4 @@ Stripe public key. #### Defined in -[index.ts:159](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L159) +[index.ts:163](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L163) diff --git a/docs/reference/letsgo-types/interfaces/PostPlanRequest.md b/docs/reference/letsgo-types/interfaces/PostPlanRequest.md index 40f3be6..51c5ba8 100644 --- a/docs/reference/letsgo-types/interfaces/PostPlanRequest.md +++ b/docs/reference/letsgo-types/interfaces/PostPlanRequest.md @@ -22,7 +22,7 @@ If a new Stripe customer needs to be created, this is their email address. #### Defined in -[index.ts:122](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L122) +[index.ts:126](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L126) ___ @@ -34,7 +34,7 @@ If a new Stripe customer needs to be created, this is their name. #### Defined in -[index.ts:126](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L126) +[index.ts:130](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L130) ___ @@ -46,4 +46,4 @@ The ID of the plan to switch the tenant to. #### Defined in -[index.ts:118](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L118) +[index.ts:122](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L122) diff --git a/docs/reference/letsgo-types/interfaces/PostPlanResponse.md b/docs/reference/letsgo-types/interfaces/PostPlanResponse.md index f200556..2bd3fb3 100644 --- a/docs/reference/letsgo-types/interfaces/PostPlanResponse.md +++ b/docs/reference/letsgo-types/interfaces/PostPlanResponse.md @@ -23,7 +23,7 @@ Stripe client secret to continue processing a new payment intent. #### Defined in -[index.ts:141](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L141) +[index.ts:145](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L145) ___ @@ -35,7 +35,7 @@ Stripe public key. #### Defined in -[index.ts:145](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L145) +[index.ts:149](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L149) ___ @@ -47,4 +47,4 @@ Stripe subscrption Id. #### Defined in -[index.ts:137](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L137) +[index.ts:141](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L141) diff --git a/docs/reference/letsgo-types/interfaces/StripeMessage.md b/docs/reference/letsgo-types/interfaces/StripeMessage.md index 8001922..c679c51 100644 --- a/docs/reference/letsgo-types/interfaces/StripeMessage.md +++ b/docs/reference/letsgo-types/interfaces/StripeMessage.md @@ -43,7 +43,7 @@ Other event properties. #### Defined in -[index.ts:314](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L314) +[index.ts:318](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L318) ___ @@ -59,4 +59,4 @@ Message type. #### Defined in -[index.ts:310](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L310) +[index.ts:314](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L314) diff --git a/docs/reference/letsgo-types/interfaces/TenantDeletedMessage.md b/docs/reference/letsgo-types/interfaces/TenantDeletedMessage.md index 86883f4..b675777 100644 --- a/docs/reference/letsgo-types/interfaces/TenantDeletedMessage.md +++ b/docs/reference/letsgo-types/interfaces/TenantDeletedMessage.md @@ -31,7 +31,7 @@ Message payload. #### Defined in -[index.ts:299](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L299) +[index.ts:303](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L303) ___ @@ -47,4 +47,4 @@ Message type. #### Defined in -[index.ts:295](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L295) +[index.ts:299](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L299) diff --git a/docs/reference/letsgo-types/interfaces/TenantDeletedMessagePayload.md b/docs/reference/letsgo-types/interfaces/TenantDeletedMessagePayload.md index e47a6ff..17db6ad 100644 --- a/docs/reference/letsgo-types/interfaces/TenantDeletedMessagePayload.md +++ b/docs/reference/letsgo-types/interfaces/TenantDeletedMessagePayload.md @@ -21,7 +21,7 @@ The ID of the plan the tenant was on when it was deleted. #### Defined in -[index.ts:285](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L285) +[index.ts:289](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L289) ___ @@ -33,4 +33,4 @@ The deleted tenant. #### Defined in -[index.ts:281](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L281) +[index.ts:285](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L285) diff --git a/docs/reference/letsgo-types/interfaces/TenantNewMessage.md b/docs/reference/letsgo-types/interfaces/TenantNewMessage.md index dd9e36e..1fdda0c 100644 --- a/docs/reference/letsgo-types/interfaces/TenantNewMessage.md +++ b/docs/reference/letsgo-types/interfaces/TenantNewMessage.md @@ -31,7 +31,7 @@ Message payload. #### Defined in -[index.ts:271](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L271) +[index.ts:275](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L275) ___ @@ -47,4 +47,4 @@ Message type. #### Defined in -[index.ts:267](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L267) +[index.ts:271](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L271) diff --git a/docs/reference/letsgo-types/interfaces/TenantNewMessagePayload.md b/docs/reference/letsgo-types/interfaces/TenantNewMessagePayload.md index 3f4e234..17fdc21 100644 --- a/docs/reference/letsgo-types/interfaces/TenantNewMessagePayload.md +++ b/docs/reference/letsgo-types/interfaces/TenantNewMessagePayload.md @@ -20,4 +20,4 @@ The newly created tenant. #### Defined in -[index.ts:256](https://github.com/47chapters/letsgo/blob/11c7e19/packages/types/src/index.ts#L256) +[index.ts:260](https://github.com/47chapters/letsgo/blob/5310a6f/packages/types/src/index.ts#L260)