From 99da4bf9dea2e13af7e2dca073c3794b620321e9 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Tue, 9 May 2023 16:42:40 +0200 Subject: [PATCH 01/14] sdk docs --- CHANGELOG.md | 23 ---------- README.md | 45 +++++++++++++++++-- .../{customer.gql => customerById.gql} | 0 3 files changed, 42 insertions(+), 26 deletions(-) rename src/graphql/queries/{customer.gql => customerById.gql} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 773a3ca..38f6f89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,25 +1,2 @@ # @team-plain/typescript-sdk -## 0.0.7 - -### Patch Changes - -- 84ea15a: Updated readme - -## 0.0.6 - -### Patch Changes - -- 989ede5: Make package public - -## 0.0.5 - -### Patch Changes - -- 33b264a: Updated readme. - -## 0.0.4 - -### Patch Changes - -- 24abeea: Add support for upserting customers. diff --git a/README.md b/README.md index 0be6ae2..49f4ee3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,44 @@ -# typescript-sdk +# @team-plain/typescript-sdk -This is the Typescript/JS SDK for Plain.com's Core API. It allows you to do basic actions. +This is the typescript/node SDK for Plain.com's Core GraphQL API. It makes it easy to make common API calls in just a few lines of code. -This is a work in progress. Docs are coming soon! +If you run into any issues please open an issue or get in touch with us at help@plain.com. + +## Basic example + +```ts +import { PlainSDKClient } from "@team-plain/typescript-sdk" + +const client = new PlainSDKClient({ + apiKey: 'plainApiKey__tmRD_xF5qiMH0657LkbLCC1maN4hLsBIbyOgjqEP4w' +}) + +const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' }); + +if (result.error) { + console.log(result.error); +} else { + console.log(result.data.fullName); +} +``` + +## Creating an API key +You can find out how to make an API key in our documentation: https://docs.plain.com/core-api/authentication + + +## Methods + +This SDK is a thin wrapper on on-top of our GraphQL API. As such a lot of these documentation will link to our GraphQL documentation. If your requirements are more complex you should consider using our API directly for which you can find docs at https://docs.plain.com/. + +### getCustomerById(variables) +Allows you to fetch a customer by their id. + +Arguments: + - `variables` + - `variables.customerId`: The id of the customer you want to fetch + +Required permissions: +- `customer:read` + +### createIssue +This allows you create an issue for a customer \ No newline at end of file diff --git a/src/graphql/queries/customer.gql b/src/graphql/queries/customerById.gql similarity index 100% rename from src/graphql/queries/customer.gql rename to src/graphql/queries/customerById.gql From f114458166e8bd91848551c023c5e98f15c9a200 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Tue, 9 May 2023 16:45:38 +0200 Subject: [PATCH 02/14] update --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49f4ee3..02a35f8 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,16 @@ You can find out how to make an API key in our documentation: https://docs.plain This SDK is a thin wrapper on on-top of our GraphQL API. As such a lot of these documentation will link to our GraphQL documentation. If your requirements are more complex you should consider using our API directly for which you can find docs at https://docs.plain.com/. -### getCustomerById(variables) +#### getCustomerById Allows you to fetch a customer by their id. Arguments: - `variables` - `variables.customerId`: The id of the customer you want to fetch +Returns: + - [CustomerPartsFragment](./src/graphql/fragments/customerParts.gql) or `null` if not found. + Required permissions: - `customer:read` From 5b492c888631aa908c765ca7c1533fc28bce171c Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Fri, 12 May 2023 12:42:27 +0200 Subject: [PATCH 03/14] WIP --- .DS_Store | Bin 0 -> 6148 bytes .gitattributes | 3 +- .github/workflows/generated-files.yml | 33 + README.md | 31 +- docs/.nojekyll | 1 + docs/assets/highlight.css | 71 + docs/assets/main.js | 58 + docs/assets/search.js | 1 + docs/assets/style.css | 1367 +++++++++++++++ docs/classes/PlainSDKClient.html | 378 ++++ docs/classes/_internal_.ParseStatus.html | 373 ++++ docs/classes/_internal_.ZodArray-1.html | 1158 +++++++++++++ docs/classes/_internal_.ZodBranded-1.html | 1065 ++++++++++++ docs/classes/_internal_.ZodCatch-1.html | 1088 ++++++++++++ docs/classes/_internal_.ZodDefault-1.html | 1088 ++++++++++++ docs/classes/_internal_.ZodEffects-1.html | 1148 ++++++++++++ docs/classes/_internal_.ZodEnum-1.html | 1177 +++++++++++++ docs/classes/_internal_.ZodError.html | 589 +++++++ .../classes/_internal_.ZodIntersection-1.html | 1086 ++++++++++++ docs/classes/_internal_.ZodNullable-1.html | 1088 ++++++++++++ docs/classes/_internal_.ZodNumber-1.html | 1393 +++++++++++++++ docs/classes/_internal_.ZodObject-1.html | 1457 ++++++++++++++++ docs/classes/_internal_.ZodOptional-1.html | 1088 ++++++++++++ docs/classes/_internal_.ZodPipeline-1.html | 1079 ++++++++++++ docs/classes/_internal_.ZodPromise-1.html | 1088 ++++++++++++ docs/classes/_internal_.ZodString-1.html | 1534 +++++++++++++++++ docs/classes/_internal_.ZodTuple-1.html | 1112 ++++++++++++ docs/classes/_internal_.ZodType.html | 1033 +++++++++++ docs/classes/_internal_.ZodUnion-1.html | 1088 ++++++++++++ docs/enums/_internal_.CustomerStatus.html | 303 ++++ docs/enums/_internal_.IssueStatus.html | 287 +++ docs/enums/_internal_.MutationErrorType.html | 303 ++++ .../_internal_.MutationFieldErrorType.html | 303 ++++ docs/functions/_internal_.DIRTY-1.html | 274 +++ docs/functions/_internal_.OK-1.html | 274 +++ docs/index.html | 272 +++ docs/interfaces/_internal_.CallSite.html | 440 +++++ docs/interfaces/_internal_.ParseContext.html | 328 ++++ docs/interfaces/_internal_.ZodArrayDef.html | 335 ++++ docs/interfaces/_internal_.ZodBrandedDef.html | 314 ++++ docs/interfaces/_internal_.ZodCatchDef.html | 339 ++++ .../interfaces/_internal_.ZodCustomIssue.html | 314 ++++ docs/interfaces/_internal_.ZodDefaultDef.html | 329 ++++ docs/interfaces/_internal_.ZodEffectsDef.html | 321 ++++ docs/interfaces/_internal_.ZodEnumDef.html | 314 ++++ .../_internal_.ZodIntersectionDef.html | 323 ++++ .../_internal_.ZodInvalidArgumentsIssue.html | 309 ++++ .../_internal_.ZodInvalidDateIssue.html | 302 ++++ .../_internal_.ZodInvalidEnumValueIssue.html | 316 ++++ ...nal_.ZodInvalidIntersectionTypesIssue.html | 302 ++++ .../_internal_.ZodInvalidLiteralIssue.html | 316 ++++ .../_internal_.ZodInvalidReturnTypeIssue.html | 309 ++++ .../_internal_.ZodInvalidStringIssue.html | 309 ++++ .../_internal_.ZodInvalidTypeIssue.html | 316 ++++ ...al_.ZodInvalidUnionDiscriminatorIssue.html | 309 ++++ .../_internal_.ZodInvalidUnionIssue.html | 309 ++++ .../_internal_.ZodNotFiniteIssue.html | 302 ++++ .../_internal_.ZodNotMultipleOfIssue.html | 309 ++++ .../interfaces/_internal_.ZodNullableDef.html | 314 ++++ docs/interfaces/_internal_.ZodNumberDef.html | 316 ++++ docs/interfaces/_internal_.ZodObjectDef.html | 340 ++++ .../interfaces/_internal_.ZodOptionalDef.html | 314 ++++ .../interfaces/_internal_.ZodPipelineDef.html | 323 ++++ docs/interfaces/_internal_.ZodPromiseDef.html | 314 ++++ docs/interfaces/_internal_.ZodStringDef.html | 316 ++++ .../interfaces/_internal_.ZodTooBigIssue.html | 330 ++++ .../_internal_.ZodTooSmallIssue.html | 330 ++++ docs/interfaces/_internal_.ZodTupleDef.html | 323 ++++ docs/interfaces/_internal_.ZodTypeDef.html | 308 ++++ docs/interfaces/_internal_.ZodUnionDef.html | 314 ++++ .../_internal_.ZodUnrecognizedKeysIssue.html | 309 ++++ docs/modules.html | 280 +++ docs/modules/_internal_.html | 584 +++++++ docs/types/Actor.html | 259 +++ docs/types/Customer.html | 316 ++++ docs/types/CustomerActor.html | 266 +++ docs/types/DateTime.html | 266 +++ docs/types/DeletedCustomerActor.html | 266 +++ docs/types/InternalActor.html | 259 +++ docs/types/Issue.html | 326 ++++ docs/types/IssuePriority.html | 268 +++ docs/types/IssueType.html | 279 +++ docs/types/MachineUserActor.html | 266 +++ docs/types/MutationError.html | 272 +++ docs/types/SystemActor.html | 266 +++ docs/types/UserActor.html | 266 +++ ...al_.ActorParts_CustomerActor_Fragment.html | 267 +++ ...orParts_DeletedCustomerActor_Fragment.html | 267 +++ ....ActorParts_MachineUserActor_Fragment.html | 267 +++ ...rnal_.ActorParts_SystemActor_Fragment.html | 267 +++ ...ternal_.ActorParts_UserActor_Fragment.html | 267 +++ docs/types/_internal_.ArrayCardinality.html | 260 +++ docs/types/_internal_.AssertArray.html | 265 +++ .../_internal_.AsyncParseReturnType.html | 265 +++ docs/types/_internal_.BRAND.html | 271 +++ docs/types/_internal_.BadRequestError.html | 269 +++ docs/types/_internal_.CastToStringTuple.html | 265 +++ docs/types/_internal_.CatchallInput.html | 265 +++ docs/types/_internal_.CatchallOutput.html | 265 +++ docs/types/_internal_.Context.html | 265 +++ docs/types/_internal_.CreateIssueInput.html | 272 +++ .../_internal_.CustomerGroupIdentifier.html | 267 +++ docs/types/_internal_.DIRTY.html | 273 +++ docs/types/_internal_.Data.html | 272 +++ docs/types/_internal_.DeepPartial.html | 265 +++ docs/types/_internal_.Effect.html | 265 +++ docs/types/_internal_.EmailAddressInput.html | 267 +++ docs/types/_internal_.EnumValues.html | 260 +++ docs/types/_internal_.Err.html | 272 +++ docs/types/_internal_.ErrMessage.html | 260 +++ docs/types/_internal_.ErrorMapCtx.html | 267 +++ docs/types/_internal_.Exact.html | 265 +++ docs/types/_internal_.Exclude.html | 269 +++ docs/types/_internal_.Extract.html | 269 +++ docs/types/_internal_.FilterEnum.html | 267 +++ docs/types/_internal_.ForbiddenError.html | 267 +++ docs/types/_internal_.GetUnionLast.html | 265 +++ docs/types/_internal_.INVALID.html | 266 +++ docs/types/_internal_.InputMaybe.html | 265 +++ docs/types/_internal_.InputTypeOfTuple.html | 265 +++ .../_internal_.InputTypeOfTupleWithRest.html | 267 +++ ...rnalActorParts_CustomerActor_Fragment.html | 265 +++ ...orParts_DeletedCustomerActor_Fragment.html | 265 +++ ...lActorParts_MachineUserActor_Fragment.html | 267 +++ ...ternalActorParts_SystemActor_Fragment.html | 267 +++ ...InternalActorParts_UserActor_Fragment.html | 267 +++ .../types/_internal_.InternalServerError.html | 267 +++ docs/types/_internal_.IpVersion.html | 260 +++ docs/types/_internal_.IssueData.html | 260 +++ docs/types/_internal_.Maybe.html | 265 +++ docs/types/_internal_.MutationError.html | 269 +++ docs/types/_internal_.NonNullable.html | 267 +++ docs/types/_internal_.OK.html | 273 +++ docs/types/_internal_.Omit-1.html | 267 +++ docs/types/_internal_.Omit.html | 269 +++ docs/types/_internal_.OmitKeys.html | 267 +++ .../types/_internal_.OptionalStringInput.html | 265 +++ docs/types/_internal_.OutputTypeOfTuple.html | 265 +++ .../_internal_.OutputTypeOfTupleWithRest.html | 267 +++ docs/types/_internal_.ParseInput.html | 269 +++ docs/types/_internal_.ParseParams.html | 269 +++ docs/types/_internal_.ParsePath.html | 260 +++ docs/types/_internal_.ParsePathComponent.html | 260 +++ docs/types/_internal_.ParseReturnType.html | 265 +++ docs/types/_internal_.Partial.html | 267 +++ docs/types/_internal_.PassthroughType.html | 265 +++ docs/types/_internal_.Pick.html | 269 +++ docs/types/_internal_.PlainGraphQLError.html | 261 +++ docs/types/_internal_.PlainSDKError.html | 260 +++ docs/types/_internal_.PreprocessEffect.html | 283 +++ docs/types/_internal_.Primitive.html | 260 +++ docs/types/_internal_.RawCreateParams.html | 260 +++ docs/types/_internal_.Readonly.html | 267 +++ docs/types/_internal_.Record.html | 269 +++ docs/types/_internal_.RefinementCtx.html | 278 +++ docs/types/_internal_.RefinementEffect.html | 285 +++ docs/types/_internal_.Required.html | 267 +++ docs/types/_internal_.Result.html | 267 +++ docs/types/_internal_.SDKResult.html | 265 +++ docs/types/_internal_.SafeParseError.html | 272 +++ .../types/_internal_.SafeParseReturnType.html | 267 +++ docs/types/_internal_.SafeParseSuccess.html | 272 +++ docs/types/_internal_.Scalars.html | 275 +++ docs/types/_internal_.StringInput.html | 265 +++ docs/types/_internal_.StringValidation.html | 260 +++ .../types/_internal_.SyncParseReturnType.html | 265 +++ docs/types/_internal_.TransformEffect.html | 285 +++ docs/types/_internal_.TypeOf.html | 265 +++ .../_internal_.UnionToIntersectionFn.html | 265 +++ docs/types/_internal_.UnionToTuple.html | 267 +++ docs/types/_internal_.UnknownError.html | 269 +++ docs/types/_internal_.UnknownKeysParam.html | 260 +++ ...ternal_.UpsertCustomerIdentifierInput.html | 269 +++ .../types/_internal_.UpsertCustomerInput.html | 269 +++ ...internal_.UpsertCustomerOnCreateInput.html | 273 +++ ...internal_.UpsertCustomerOnUpdateInput.html | 271 +++ docs/types/_internal_.Values.html | 265 +++ docs/types/_internal_.Writeable.html | 265 +++ docs/types/_internal_.ZodErrorMap.html | 278 +++ docs/types/_internal_.ZodFormattedError.html | 267 +++ docs/types/_internal_.ZodIssue.html | 260 +++ docs/types/_internal_.ZodIssueBase.html | 267 +++ .../_internal_.ZodIssueOptionalMessage.html | 260 +++ docs/types/_internal_.ZodNumberCheck.html | 260 +++ docs/types/_internal_.ZodRawShape.html | 265 +++ docs/types/_internal_.ZodStringCheck.html | 260 +++ docs/types/_internal_.ZodTupleItems.html | 260 +++ docs/types/_internal_.ZodTypeAny.html | 260 +++ docs/types/_internal_.ZodUnionOptions.html | 260 +++ docs/types/_internal_.addQuestionMarks.html | 267 +++ docs/types/_internal_.allKeys.html | 265 +++ docs/types/_internal_.arrayOutputType.html | 267 +++ .../types/_internal_.baseObjectInputType.html | 265 +++ .../_internal_.baseObjectOutputType.html | 265 +++ docs/types/_internal_.deoptional.html | 265 +++ docs/types/_internal_.flatten.html | 265 +++ docs/types/_internal_.identity.html | 265 +++ docs/types/_internal_.input.html | 265 +++ docs/types/_internal_.noUndefined.html | 265 +++ docs/types/_internal_.objectInputType.html | 269 +++ docs/types/_internal_.objectOutputType.html | 269 +++ docs/types/_internal_.output.html | 265 +++ ..._internal_.recursiveZodFormattedError.html | 265 +++ docs/types/_internal_.requiredKeys.html | 265 +++ docs/types/_internal_.stripPath.html | 265 +++ .../_internal_.typeToFlattenedError.html | 274 +++ docs/types/_internal_.typecast.html | 267 +++ docs/variables/_internal_.BRAND-1.html | 261 +++ docs/variables/_internal_.INVALID-1.html | 261 +++ .../_internal_.PlainGraphQLError-1.html | 261 +++ package-lock.json | 189 +- package.json | 6 +- src/client.ts | 3 + src/error.ts | 10 +- src/request.ts | 12 +- src/tests/error-handling.test.ts | 4 +- src/tests/mutation.test.ts | 2 +- src/tests/query.test.ts | 2 +- src/tests/raw-request.test.ts | 2 +- 219 files changed, 73583 insertions(+), 33 deletions(-) create mode 100644 .DS_Store create mode 100644 .github/workflows/generated-files.yml create mode 100644 docs/.nojekyll create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/main.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/classes/PlainSDKClient.html create mode 100644 docs/classes/_internal_.ParseStatus.html create mode 100644 docs/classes/_internal_.ZodArray-1.html create mode 100644 docs/classes/_internal_.ZodBranded-1.html create mode 100644 docs/classes/_internal_.ZodCatch-1.html create mode 100644 docs/classes/_internal_.ZodDefault-1.html create mode 100644 docs/classes/_internal_.ZodEffects-1.html create mode 100644 docs/classes/_internal_.ZodEnum-1.html create mode 100644 docs/classes/_internal_.ZodError.html create mode 100644 docs/classes/_internal_.ZodIntersection-1.html create mode 100644 docs/classes/_internal_.ZodNullable-1.html create mode 100644 docs/classes/_internal_.ZodNumber-1.html create mode 100644 docs/classes/_internal_.ZodObject-1.html create mode 100644 docs/classes/_internal_.ZodOptional-1.html create mode 100644 docs/classes/_internal_.ZodPipeline-1.html create mode 100644 docs/classes/_internal_.ZodPromise-1.html create mode 100644 docs/classes/_internal_.ZodString-1.html create mode 100644 docs/classes/_internal_.ZodTuple-1.html create mode 100644 docs/classes/_internal_.ZodType.html create mode 100644 docs/classes/_internal_.ZodUnion-1.html create mode 100644 docs/enums/_internal_.CustomerStatus.html create mode 100644 docs/enums/_internal_.IssueStatus.html create mode 100644 docs/enums/_internal_.MutationErrorType.html create mode 100644 docs/enums/_internal_.MutationFieldErrorType.html create mode 100644 docs/functions/_internal_.DIRTY-1.html create mode 100644 docs/functions/_internal_.OK-1.html create mode 100644 docs/index.html create mode 100644 docs/interfaces/_internal_.CallSite.html create mode 100644 docs/interfaces/_internal_.ParseContext.html create mode 100644 docs/interfaces/_internal_.ZodArrayDef.html create mode 100644 docs/interfaces/_internal_.ZodBrandedDef.html create mode 100644 docs/interfaces/_internal_.ZodCatchDef.html create mode 100644 docs/interfaces/_internal_.ZodCustomIssue.html create mode 100644 docs/interfaces/_internal_.ZodDefaultDef.html create mode 100644 docs/interfaces/_internal_.ZodEffectsDef.html create mode 100644 docs/interfaces/_internal_.ZodEnumDef.html create mode 100644 docs/interfaces/_internal_.ZodIntersectionDef.html create mode 100644 docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidDateIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidLiteralIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidStringIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidTypeIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html create mode 100644 docs/interfaces/_internal_.ZodInvalidUnionIssue.html create mode 100644 docs/interfaces/_internal_.ZodNotFiniteIssue.html create mode 100644 docs/interfaces/_internal_.ZodNotMultipleOfIssue.html create mode 100644 docs/interfaces/_internal_.ZodNullableDef.html create mode 100644 docs/interfaces/_internal_.ZodNumberDef.html create mode 100644 docs/interfaces/_internal_.ZodObjectDef.html create mode 100644 docs/interfaces/_internal_.ZodOptionalDef.html create mode 100644 docs/interfaces/_internal_.ZodPipelineDef.html create mode 100644 docs/interfaces/_internal_.ZodPromiseDef.html create mode 100644 docs/interfaces/_internal_.ZodStringDef.html create mode 100644 docs/interfaces/_internal_.ZodTooBigIssue.html create mode 100644 docs/interfaces/_internal_.ZodTooSmallIssue.html create mode 100644 docs/interfaces/_internal_.ZodTupleDef.html create mode 100644 docs/interfaces/_internal_.ZodTypeDef.html create mode 100644 docs/interfaces/_internal_.ZodUnionDef.html create mode 100644 docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html create mode 100644 docs/modules.html create mode 100644 docs/modules/_internal_.html create mode 100644 docs/types/Actor.html create mode 100644 docs/types/Customer.html create mode 100644 docs/types/CustomerActor.html create mode 100644 docs/types/DateTime.html create mode 100644 docs/types/DeletedCustomerActor.html create mode 100644 docs/types/InternalActor.html create mode 100644 docs/types/Issue.html create mode 100644 docs/types/IssuePriority.html create mode 100644 docs/types/IssueType.html create mode 100644 docs/types/MachineUserActor.html create mode 100644 docs/types/MutationError.html create mode 100644 docs/types/SystemActor.html create mode 100644 docs/types/UserActor.html create mode 100644 docs/types/_internal_.ActorParts_CustomerActor_Fragment.html create mode 100644 docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html create mode 100644 docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html create mode 100644 docs/types/_internal_.ActorParts_SystemActor_Fragment.html create mode 100644 docs/types/_internal_.ActorParts_UserActor_Fragment.html create mode 100644 docs/types/_internal_.ArrayCardinality.html create mode 100644 docs/types/_internal_.AssertArray.html create mode 100644 docs/types/_internal_.AsyncParseReturnType.html create mode 100644 docs/types/_internal_.BRAND.html create mode 100644 docs/types/_internal_.BadRequestError.html create mode 100644 docs/types/_internal_.CastToStringTuple.html create mode 100644 docs/types/_internal_.CatchallInput.html create mode 100644 docs/types/_internal_.CatchallOutput.html create mode 100644 docs/types/_internal_.Context.html create mode 100644 docs/types/_internal_.CreateIssueInput.html create mode 100644 docs/types/_internal_.CustomerGroupIdentifier.html create mode 100644 docs/types/_internal_.DIRTY.html create mode 100644 docs/types/_internal_.Data.html create mode 100644 docs/types/_internal_.DeepPartial.html create mode 100644 docs/types/_internal_.Effect.html create mode 100644 docs/types/_internal_.EmailAddressInput.html create mode 100644 docs/types/_internal_.EnumValues.html create mode 100644 docs/types/_internal_.Err.html create mode 100644 docs/types/_internal_.ErrMessage.html create mode 100644 docs/types/_internal_.ErrorMapCtx.html create mode 100644 docs/types/_internal_.Exact.html create mode 100644 docs/types/_internal_.Exclude.html create mode 100644 docs/types/_internal_.Extract.html create mode 100644 docs/types/_internal_.FilterEnum.html create mode 100644 docs/types/_internal_.ForbiddenError.html create mode 100644 docs/types/_internal_.GetUnionLast.html create mode 100644 docs/types/_internal_.INVALID.html create mode 100644 docs/types/_internal_.InputMaybe.html create mode 100644 docs/types/_internal_.InputTypeOfTuple.html create mode 100644 docs/types/_internal_.InputTypeOfTupleWithRest.html create mode 100644 docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html create mode 100644 docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html create mode 100644 docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html create mode 100644 docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html create mode 100644 docs/types/_internal_.InternalActorParts_UserActor_Fragment.html create mode 100644 docs/types/_internal_.InternalServerError.html create mode 100644 docs/types/_internal_.IpVersion.html create mode 100644 docs/types/_internal_.IssueData.html create mode 100644 docs/types/_internal_.Maybe.html create mode 100644 docs/types/_internal_.MutationError.html create mode 100644 docs/types/_internal_.NonNullable.html create mode 100644 docs/types/_internal_.OK.html create mode 100644 docs/types/_internal_.Omit-1.html create mode 100644 docs/types/_internal_.Omit.html create mode 100644 docs/types/_internal_.OmitKeys.html create mode 100644 docs/types/_internal_.OptionalStringInput.html create mode 100644 docs/types/_internal_.OutputTypeOfTuple.html create mode 100644 docs/types/_internal_.OutputTypeOfTupleWithRest.html create mode 100644 docs/types/_internal_.ParseInput.html create mode 100644 docs/types/_internal_.ParseParams.html create mode 100644 docs/types/_internal_.ParsePath.html create mode 100644 docs/types/_internal_.ParsePathComponent.html create mode 100644 docs/types/_internal_.ParseReturnType.html create mode 100644 docs/types/_internal_.Partial.html create mode 100644 docs/types/_internal_.PassthroughType.html create mode 100644 docs/types/_internal_.Pick.html create mode 100644 docs/types/_internal_.PlainGraphQLError.html create mode 100644 docs/types/_internal_.PlainSDKError.html create mode 100644 docs/types/_internal_.PreprocessEffect.html create mode 100644 docs/types/_internal_.Primitive.html create mode 100644 docs/types/_internal_.RawCreateParams.html create mode 100644 docs/types/_internal_.Readonly.html create mode 100644 docs/types/_internal_.Record.html create mode 100644 docs/types/_internal_.RefinementCtx.html create mode 100644 docs/types/_internal_.RefinementEffect.html create mode 100644 docs/types/_internal_.Required.html create mode 100644 docs/types/_internal_.Result.html create mode 100644 docs/types/_internal_.SDKResult.html create mode 100644 docs/types/_internal_.SafeParseError.html create mode 100644 docs/types/_internal_.SafeParseReturnType.html create mode 100644 docs/types/_internal_.SafeParseSuccess.html create mode 100644 docs/types/_internal_.Scalars.html create mode 100644 docs/types/_internal_.StringInput.html create mode 100644 docs/types/_internal_.StringValidation.html create mode 100644 docs/types/_internal_.SyncParseReturnType.html create mode 100644 docs/types/_internal_.TransformEffect.html create mode 100644 docs/types/_internal_.TypeOf.html create mode 100644 docs/types/_internal_.UnionToIntersectionFn.html create mode 100644 docs/types/_internal_.UnionToTuple.html create mode 100644 docs/types/_internal_.UnknownError.html create mode 100644 docs/types/_internal_.UnknownKeysParam.html create mode 100644 docs/types/_internal_.UpsertCustomerIdentifierInput.html create mode 100644 docs/types/_internal_.UpsertCustomerInput.html create mode 100644 docs/types/_internal_.UpsertCustomerOnCreateInput.html create mode 100644 docs/types/_internal_.UpsertCustomerOnUpdateInput.html create mode 100644 docs/types/_internal_.Values.html create mode 100644 docs/types/_internal_.Writeable.html create mode 100644 docs/types/_internal_.ZodErrorMap.html create mode 100644 docs/types/_internal_.ZodFormattedError.html create mode 100644 docs/types/_internal_.ZodIssue.html create mode 100644 docs/types/_internal_.ZodIssueBase.html create mode 100644 docs/types/_internal_.ZodIssueOptionalMessage.html create mode 100644 docs/types/_internal_.ZodNumberCheck.html create mode 100644 docs/types/_internal_.ZodRawShape.html create mode 100644 docs/types/_internal_.ZodStringCheck.html create mode 100644 docs/types/_internal_.ZodTupleItems.html create mode 100644 docs/types/_internal_.ZodTypeAny.html create mode 100644 docs/types/_internal_.ZodUnionOptions.html create mode 100644 docs/types/_internal_.addQuestionMarks.html create mode 100644 docs/types/_internal_.allKeys.html create mode 100644 docs/types/_internal_.arrayOutputType.html create mode 100644 docs/types/_internal_.baseObjectInputType.html create mode 100644 docs/types/_internal_.baseObjectOutputType.html create mode 100644 docs/types/_internal_.deoptional.html create mode 100644 docs/types/_internal_.flatten.html create mode 100644 docs/types/_internal_.identity.html create mode 100644 docs/types/_internal_.input.html create mode 100644 docs/types/_internal_.noUndefined.html create mode 100644 docs/types/_internal_.objectInputType.html create mode 100644 docs/types/_internal_.objectOutputType.html create mode 100644 docs/types/_internal_.output.html create mode 100644 docs/types/_internal_.recursiveZodFormattedError.html create mode 100644 docs/types/_internal_.requiredKeys.html create mode 100644 docs/types/_internal_.stripPath.html create mode 100644 docs/types/_internal_.typeToFlattenedError.html create mode 100644 docs/types/_internal_.typecast.html create mode 100644 docs/variables/_internal_.BRAND-1.html create mode 100644 docs/variables/_internal_.INVALID-1.html create mode 100644 docs/variables/_internal_.PlainGraphQLError-1.html diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..d6ec7284e694fb3fe7ff620aaf9e8128e182db9c GIT binary patch literal 6148 zcmeHK%SyvQ6rE|SO({Ya3SADkE!c+?i<=PZ4;ayfN=;1BV9b;zHH%WnT7Sqd@q4^? zW+E2rR>a;5Gv_{MG6ymb#u#_!VV5zRF=jzSbgvCnOfn+JF@iju2C)plelxMZ z4*2ag7Bb21So-z*gJ~S4S*P>PE7jW8cHOF5P3y*ckhz!n**taq*%eynQpQ24`@uyt z$;bBYiA*v-N+vT^5QP&+xxS2&Q0A_jCt<2;Jsq$bR%2|p7K`3+&=&op?y@Zw!(OK? z4*P@UvSID*9~_^JALFM)zGy-@@U3LWUoq>F$eggRp27Z~^e2;fRp literal 0 HcmV?d00001 diff --git a/.gitattributes b/.gitattributes index 36c64c8..eca3860 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,2 @@ -src/graphql/types.ts linguist-generated=true \ No newline at end of file +src/graphql/types.ts linguist-generated=true +docs/* linguist-generated=true \ No newline at end of file diff --git a/.github/workflows/generated-files.yml b/.github/workflows/generated-files.yml new file mode 100644 index 0000000..97c6565 --- /dev/null +++ b/.github/workflows/generated-files.yml @@ -0,0 +1,33 @@ +name: Generated files up-to-date +on: + push: + branches: + - main + pull_request: + +jobs: + generated-files: + name: Generated files up-to-date + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: '16' + - name: Install dependencies + run: npm install + - name: Run codegen + run: npm run codegen + - name: Check if there are any changes + id: changes + run: echo "changed=$(git status --porcelain | wc -l)" >> $GITHUB_OUTPUT + - name: "Failure: generated file changes detected" + if: steps.changes.outputs.changed > 0 + run: | + echo "Changes detected:" + git status --porcelain + for file in $(git status -s | cut -c4-) + do + echo "::error file=$file::$file not up to date" + done + exit 1 diff --git a/README.md b/README.md index 02a35f8..41e83d5 100644 --- a/README.md +++ b/README.md @@ -26,22 +26,27 @@ if (result.error) { You can find out how to make an API key in our documentation: https://docs.plain.com/core-api/authentication -## Methods -This SDK is a thin wrapper on on-top of our GraphQL API. As such a lot of these documentation will link to our GraphQL documentation. If your requirements are more complex you should consider using our API directly for which you can find docs at https://docs.plain.com/. -#### getCustomerById -Allows you to fetch a customer by their id. +## Error handling +Calling methods on the client will not throw an error. Instead calling any client method will return an object with either data or an error. -Arguments: - - `variables` - - `variables.customerId`: The id of the customer you want to fetch +**You wil either receive an error or data, never both.** -Returns: - - [CustomerPartsFragment](./src/graphql/fragments/customerParts.gql) or `null` if not found. +Here is an example: -Required permissions: -- `customer:read` +``` + +function doThing() { + const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' }); + + if (result.error) { + console.log(result.error); + return; + } + + console.log(result.data.fullName); +} +``` -### createIssue -This allows you create an issue for a customer \ No newline at end of file +Errors are a union which \ No newline at end of file diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..426d813 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,71 @@ +:root { + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..4c8fa61 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..cf8d466 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PlainSDKClient\",\"url\":\"classes/PlainSDKClient.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PlainSDKClient.html#constructor\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":1024,\"name\":\"#ctx\",\"url\":\"classes/PlainSDKClient.html#_ctx\",\"classes\":\"tsd-is-private\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"rawRequest\",\"url\":\"classes/PlainSDKClient.html#rawRequest\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"getCustomerById\",\"url\":\"classes/PlainSDKClient.html#getCustomerById\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"upsertCustomer\",\"url\":\"classes/PlainSDKClient.html#upsertCustomer\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"createIssue\",\"url\":\"classes/PlainSDKClient.html#createIssue\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":4194304,\"name\":\"Actor\",\"url\":\"types/Actor.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"CustomerActor\",\"url\":\"types/CustomerActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/CustomerActor.html#__type\",\"classes\":\"\",\"parent\":\"CustomerActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/CustomerActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"CustomerActor.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/CustomerActor.html#__type.customerId\",\"classes\":\"\",\"parent\":\"CustomerActor.__type\"},{\"kind\":4194304,\"name\":\"Customer\",\"url\":\"types/Customer.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type\",\"classes\":\"\",\"parent\":\"Customer\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.__typename\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Customer.html#__type.id\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/Customer.html#__type.fullName\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/Customer.html#__type.shortName\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/Customer.html#__type.externalId\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/Customer.html#__type.status\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/Customer.html#__type.email\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.email.__type-2\",\"classes\":\"\",\"parent\":\"Customer.__type.email\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.email.__type-2.__typename-2\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/Customer.html#__type.email.__type-2.email-1\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"isVerified\",\"url\":\"types/Customer.html#__type.email.__type-2.isVerified\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"verifiedAt\",\"url\":\"types/Customer.html#__type.email.__type-2.verifiedAt\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"statusChangedAt\",\"url\":\"types/Customer.html#__type.statusChangedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3.__typename-3\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3.iso8601-1\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt.__type\"},{\"kind\":1024,\"name\":\"assignedToUser\",\"url\":\"types/Customer.html#__type.assignedToUser\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"assignedAt\",\"url\":\"types/Customer.html#__type.assignedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"updatedAt\",\"url\":\"types/Customer.html#__type.updatedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4.__typename-4\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4.iso8601-2\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"lastIdleAt\",\"url\":\"types/Customer.html#__type.lastIdleAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"types/Customer.html#__type.createdAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.createdAt.__type-1\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.createdAt.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.createdAt.__type-1.iso8601\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"types/Customer.html#__type.createdBy\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"markedAsSpamAt\",\"url\":\"types/Customer.html#__type.markedAsSpamAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":4194304,\"name\":\"DateTime\",\"url\":\"types/DateTime.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/DateTime.html#__type\",\"classes\":\"\",\"parent\":\"DateTime\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/DateTime.html#__type.__typename\",\"classes\":\"\",\"parent\":\"DateTime.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/DateTime.html#__type.iso8601\",\"classes\":\"\",\"parent\":\"DateTime.__type\"},{\"kind\":4194304,\"name\":\"DeletedCustomerActor\",\"url\":\"types/DeletedCustomerActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/DeletedCustomerActor.html#__type\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/DeletedCustomerActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/DeletedCustomerActor.html#__type.customerId\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor.__type\"},{\"kind\":4194304,\"name\":\"InternalActor\",\"url\":\"types/InternalActor.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Issue\",\"url\":\"types/Issue.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type\",\"classes\":\"\",\"parent\":\"Issue\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.__typename\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.id-1\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"issueKey\",\"url\":\"types/Issue.html#__type.issueKey\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/Issue.html#__type.status\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"customer\",\"url\":\"types/Issue.html#__type.customer\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.customer.__type-2\",\"classes\":\"\",\"parent\":\"Issue.__type.customer\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.customer.__type-2.__typename-2\",\"classes\":\"\",\"parent\":\"Issue.__type.customer.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.customer.__type-2.id\",\"classes\":\"\",\"parent\":\"Issue.__type.customer.__type\"},{\"kind\":1024,\"name\":\"priority\",\"url\":\"types/Issue.html#__type.priority\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.priority.__type-5\",\"classes\":\"\",\"parent\":\"Issue.__type.priority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.priority.__type-5.__typename-5\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/Issue.html#__type.priority.__type-5.label-1\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/Issue.html#__type.priority.__type-5.value-1\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"updatedAt\",\"url\":\"types/Issue.html#__type.updatedAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6.__typename-6\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6.iso8601-1\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"updatedBy\",\"url\":\"types/Issue.html#__type.updatedBy\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"types/Issue.html#__type.createdBy\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"types/Issue.html#__type.createdAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.createdAt.__type-1\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.createdAt.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Issue.html#__type.createdAt.__type-1.iso8601\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"issueType\",\"url\":\"types/Issue.html#__type.issueType\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.issueType.__type-3\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.issueType.__type-3.__typename-3\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.issueType.__type-3.id-2\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"publicName\",\"url\":\"types/Issue.html#__type.issueType.__type-3.publicName\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"isArchived\",\"url\":\"types/Issue.html#__type.issueType.__type-3.isArchived\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"defaultIssuePriority\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.__typename-4\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.label\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.value\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"deletedAt\",\"url\":\"types/Issue.html#__type.deletedAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":4194304,\"name\":\"IssuePriority\",\"url\":\"types/IssuePriority.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssuePriority.html#__type\",\"classes\":\"\",\"parent\":\"IssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssuePriority.html#__type.__typename\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/IssuePriority.html#__type.label\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/IssuePriority.html#__type.value\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":4194304,\"name\":\"IssueType\",\"url\":\"types/IssueType.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssueType.html#__type\",\"classes\":\"\",\"parent\":\"IssueType\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssueType.html#__type.__typename\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/IssueType.html#__type.id\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"publicName\",\"url\":\"types/IssueType.html#__type.publicName\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"isArchived\",\"url\":\"types/IssueType.html#__type.isArchived\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"defaultIssuePriority\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.label\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.value\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":4194304,\"name\":\"MachineUserActor\",\"url\":\"types/MachineUserActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MachineUserActor.html#__type\",\"classes\":\"\",\"parent\":\"MachineUserActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/MachineUserActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"MachineUserActor.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/MachineUserActor.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\"MachineUserActor.__type\"},{\"kind\":4194304,\"name\":\"MutationError\",\"url\":\"types/MutationError.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MutationError.html#__type\",\"classes\":\"\",\"parent\":\"MutationError\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/MutationError.html#__type.__typename\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/MutationError.html#__type.message\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/MutationError.html#__type.type\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/MutationError.html#__type.code\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/MutationError.html#__type.fields\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":4194304,\"name\":\"SystemActor\",\"url\":\"types/SystemActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/SystemActor.html#__type\",\"classes\":\"\",\"parent\":\"SystemActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/SystemActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"SystemActor.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/SystemActor.html#__type.systemId\",\"classes\":\"\",\"parent\":\"SystemActor.__type\"},{\"kind\":4194304,\"name\":\"UserActor\",\"url\":\"types/UserActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/UserActor.html#__type\",\"classes\":\"\",\"parent\":\"UserActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/UserActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"UserActor.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/UserActor.html#__type.userId\",\"classes\":\"\",\"parent\":\"UserActor.__type\"},{\"kind\":2,\"name\":\"\",\"url\":\"modules/_internal_.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Context\",\"url\":\"types/_internal_.Context.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Context.html#__type\",\"classes\":\"\",\"parent\":\".Context\"},{\"kind\":1024,\"name\":\"apiKey\",\"url\":\"types/_internal_.Context.html#__type.apiKey\",\"classes\":\"\",\"parent\":\".Context.__type\"},{\"kind\":4194304,\"name\":\"SDKResult\",\"url\":\"types/_internal_.SDKResult.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"Exact\",\"url\":\"types/_internal_.Exact.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"UpsertCustomerInput\",\"url\":\"types/_internal_.UpsertCustomerInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput\"},{\"kind\":1024,\"name\":\"identifier\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.identifier\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":1024,\"name\":\"onCreate\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.onCreate\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":1024,\"name\":\"onUpdate\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.onUpdate\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":4194304,\"name\":\"CreateIssueInput\",\"url\":\"types/_internal_.CreateIssueInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.CreateIssueInput.html#__type\",\"classes\":\"\",\"parent\":\".CreateIssueInput\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.customerId\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":1024,\"name\":\"issueTypeId\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.issueTypeId\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":1024,\"name\":\"priorityValue\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.priorityValue\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_CustomerActor_Fragment\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type.customerId\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_DeletedCustomerActor_Fragment\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type.customerId\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_MachineUserActor_Fragment\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_SystemActor_Fragment\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type.systemId\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_UserActor_Fragment\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type.userId\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment.__type\"},{\"kind\":8,\"name\":\"CustomerStatus\",\"url\":\"enums/_internal_.CustomerStatus.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Active\",\"url\":\"enums/_internal_.CustomerStatus.html#Active\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":16,\"name\":\"Idle\",\"url\":\"enums/_internal_.CustomerStatus.html#Idle\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":16,\"name\":\"Snoozed\",\"url\":\"enums/_internal_.CustomerStatus.html#Snoozed\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":4194304,\"name\":\"InternalActorParts_CustomerActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_CustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_CustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_DeletedCustomerActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_DeletedCustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_MachineUserActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_SystemActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type.systemId\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_UserActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type.userId\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment.__type\"},{\"kind\":8,\"name\":\"IssueStatus\",\"url\":\"enums/_internal_.IssueStatus.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Open\",\"url\":\"enums/_internal_.IssueStatus.html#Open\",\"classes\":\"\",\"parent\":\".IssueStatus\"},{\"kind\":16,\"name\":\"Resolved\",\"url\":\"enums/_internal_.IssueStatus.html#Resolved\",\"classes\":\"\",\"parent\":\".IssueStatus\"},{\"kind\":8,\"name\":\"MutationErrorType\",\"url\":\"enums/_internal_.MutationErrorType.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Forbidden\",\"url\":\"enums/_internal_.MutationErrorType.html#Forbidden\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":16,\"name\":\"Internal\",\"url\":\"enums/_internal_.MutationErrorType.html#Internal\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":16,\"name\":\"Validation\",\"url\":\"enums/_internal_.MutationErrorType.html#Validation\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":8,\"name\":\"MutationFieldErrorType\",\"url\":\"enums/_internal_.MutationFieldErrorType.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"NotFound\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#NotFound\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":16,\"name\":\"Required\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#Required\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":16,\"name\":\"Validation\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#Validation\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":4194304,\"name\":\"Result\",\"url\":\"types/_internal_.Result.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"PlainSDKError\",\"url\":\"types/_internal_.PlainSDKError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"UpsertCustomerIdentifierInput\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.customerId\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":1024,\"name\":\"emailAddress\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.emailAddress\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":4194304,\"name\":\"UpsertCustomerOnCreateInput\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput\"},{\"kind\":1024,\"name\":\"customerGroupIdentifiers\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.customerGroupIdentifiers\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.email\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.fullName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.shortName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":4194304,\"name\":\"UpsertCustomerOnUpdateInput\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.email\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.fullName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.shortName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":4194304,\"name\":\"Scalars\",\"url\":\"types/_internal_.Scalars.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Scalars.html#__type\",\"classes\":\"\",\"parent\":\".Scalars\"},{\"kind\":1024,\"name\":\"ID\",\"url\":\"types/_internal_.Scalars.html#__type.ID\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"String\",\"url\":\"types/_internal_.Scalars.html#__type.String\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Boolean\",\"url\":\"types/_internal_.Scalars.html#__type.Boolean\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Int\",\"url\":\"types/_internal_.Scalars.html#__type.Int\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Float\",\"url\":\"types/_internal_.Scalars.html#__type.Float\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":4194304,\"name\":\"InputMaybe\",\"url\":\"types/_internal_.InputMaybe.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"Data\",\"url\":\"types/_internal_.Data.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Data.html#__type\",\"classes\":\"\",\"parent\":\".Data\"},{\"kind\":1024,\"name\":\"data\",\"url\":\"types/_internal_.Data.html#__type.data\",\"classes\":\"\",\"parent\":\".Data.__type\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/_internal_.Data.html#__type.error\",\"classes\":\"\",\"parent\":\".Data.__type\"},{\"kind\":4194304,\"name\":\"Err\",\"url\":\"types/_internal_.Err.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Err.html#__type\",\"classes\":\"\",\"parent\":\".Err\"},{\"kind\":1024,\"name\":\"data\",\"url\":\"types/_internal_.Err.html#__type.data\",\"classes\":\"\",\"parent\":\".Err.__type\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/_internal_.Err.html#__type.error\",\"classes\":\"\",\"parent\":\".Err.__type\"},{\"kind\":4194304,\"name\":\"ForbiddenError\",\"url\":\"types/_internal_.ForbiddenError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ForbiddenError.html#__type\",\"classes\":\"\",\"parent\":\".ForbiddenError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.ForbiddenError.html#__type.code\",\"classes\":\"\",\"parent\":\".ForbiddenError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.ForbiddenError.html#__type.message\",\"classes\":\"\",\"parent\":\".ForbiddenError.__type\"},{\"kind\":4194304,\"name\":\"BadRequestError\",\"url\":\"types/_internal_.BadRequestError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.BadRequestError.html#__type\",\"classes\":\"\",\"parent\":\".BadRequestError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.BadRequestError.html#__type.code\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.BadRequestError.html#__type.message\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":1024,\"name\":\"graphqlErrors\",\"url\":\"types/_internal_.BadRequestError.html#__type.graphqlErrors\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":4194304,\"name\":\"InternalServerError\",\"url\":\"types/_internal_.InternalServerError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalServerError.html#__type\",\"classes\":\"\",\"parent\":\".InternalServerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.InternalServerError.html#__type.code\",\"classes\":\"\",\"parent\":\".InternalServerError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.InternalServerError.html#__type.message\",\"classes\":\"\",\"parent\":\".InternalServerError.__type\"},{\"kind\":4194304,\"name\":\"MutationError\",\"url\":\"types/_internal_.MutationError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.MutationError.html#__type\",\"classes\":\"\",\"parent\":\".MutationError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.MutationError.html#__type.code\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.MutationError.html#__type.message\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":1024,\"name\":\"errorDetails\",\"url\":\"types/_internal_.MutationError.html#__type.errorDetails\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":4194304,\"name\":\"UnknownError\",\"url\":\"types/_internal_.UnknownError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UnknownError.html#__type\",\"classes\":\"\",\"parent\":\".UnknownError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.UnknownError.html#__type.code\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.UnknownError.html#__type.message\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"types/_internal_.UnknownError.html#__type.err\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":4194304,\"name\":\"CustomerGroupIdentifier\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier\"},{\"kind\":1024,\"name\":\"customerGroupId\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type.customerGroupId\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier.__type\"},{\"kind\":1024,\"name\":\"customerGroupKey\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type.customerGroupKey\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier.__type\"},{\"kind\":4194304,\"name\":\"EmailAddressInput\",\"url\":\"types/_internal_.EmailAddressInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.EmailAddressInput.html#__type\",\"classes\":\"\",\"parent\":\".EmailAddressInput\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.EmailAddressInput.html#__type.email\",\"classes\":\"\",\"parent\":\".EmailAddressInput.__type\"},{\"kind\":1024,\"name\":\"isVerified\",\"url\":\"types/_internal_.EmailAddressInput.html#__type.isVerified\",\"classes\":\"\",\"parent\":\".EmailAddressInput.__type\"},{\"kind\":4194304,\"name\":\"OptionalStringInput\",\"url\":\"types/_internal_.OptionalStringInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.OptionalStringInput.html#__type\",\"classes\":\"\",\"parent\":\".OptionalStringInput\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/_internal_.OptionalStringInput.html#__type.value\",\"classes\":\"\",\"parent\":\".OptionalStringInput.__type\"},{\"kind\":4194304,\"name\":\"StringInput\",\"url\":\"types/_internal_.StringInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.StringInput.html#__type\",\"classes\":\"\",\"parent\":\".StringInput\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/_internal_.StringInput.html#__type.value\",\"classes\":\"\",\"parent\":\".StringInput.__type\"},{\"kind\":4194304,\"name\":\"Maybe\",\"url\":\"types/_internal_.Maybe.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":32,\"name\":\"PlainGraphQLError\",\"url\":\"variables/_internal_.PlainGraphQLError-1.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"PlainGraphQLError\",\"url\":\"types/_internal_.PlainGraphQLError.html\",\"classes\":\"\",\"parent\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,51.93]],[\"comment/0\",[]],[\"name/1\",[1,51.93]],[\"comment/1\",[]],[\"name/2\",[2,51.93]],[\"comment/2\",[]],[\"name/3\",[3,51.93]],[\"comment/3\",[]],[\"name/4\",[4,51.93]],[\"comment/4\",[]],[\"name/5\",[5,51.93]],[\"comment/5\",[]],[\"name/6\",[6,51.93]],[\"comment/6\",[]],[\"name/7\",[7,51.93]],[\"comment/7\",[]],[\"name/8\",[8,51.93]],[\"comment/8\",[]],[\"name/9\",[9,16.764]],[\"comment/9\",[]],[\"name/10\",[10,21.172]],[\"comment/10\",[]],[\"name/11\",[11,37.266]],[\"comment/11\",[]],[\"name/12\",[12,46.821]],[\"comment/12\",[]],[\"name/13\",[9,16.764]],[\"comment/13\",[]],[\"name/14\",[10,21.172]],[\"comment/14\",[]],[\"name/15\",[13,37.266]],[\"comment/15\",[]],[\"name/16\",[14,43.457]],[\"comment/16\",[]],[\"name/17\",[15,43.457]],[\"comment/17\",[]],[\"name/18\",[16,40.943]],[\"comment/18\",[]],[\"name/19\",[17,46.821]],[\"comment/19\",[]],[\"name/20\",[18,38.937]],[\"comment/20\",[]],[\"name/21\",[9,16.764]],[\"comment/21\",[]],[\"name/22\",[10,21.172]],[\"comment/22\",[]],[\"name/23\",[18,38.937]],[\"comment/23\",[]],[\"name/24\",[19,46.821]],[\"comment/24\",[]],[\"name/25\",[20,51.93]],[\"comment/25\",[]],[\"name/26\",[21,51.93]],[\"comment/26\",[]],[\"name/27\",[9,16.764]],[\"comment/27\",[]],[\"name/28\",[10,21.172]],[\"comment/28\",[]],[\"name/29\",[22,37.266]],[\"comment/29\",[]],[\"name/30\",[23,51.93]],[\"comment/30\",[]],[\"name/31\",[24,51.93]],[\"comment/31\",[]],[\"name/32\",[25,46.821]],[\"comment/32\",[]],[\"name/33\",[9,16.764]],[\"comment/33\",[]],[\"name/34\",[10,21.172]],[\"comment/34\",[]],[\"name/35\",[22,37.266]],[\"comment/35\",[]],[\"name/36\",[26,51.93]],[\"comment/36\",[]],[\"name/37\",[27,46.821]],[\"comment/37\",[]],[\"name/38\",[9,16.764]],[\"comment/38\",[]],[\"name/39\",[10,21.172]],[\"comment/39\",[]],[\"name/40\",[22,37.266]],[\"comment/40\",[]],[\"name/41\",[28,46.821]],[\"comment/41\",[]],[\"name/42\",[29,51.93]],[\"comment/42\",[]],[\"name/43\",[30,51.93]],[\"comment/43\",[]],[\"name/44\",[9,16.764]],[\"comment/44\",[]],[\"name/45\",[10,21.172]],[\"comment/45\",[]],[\"name/46\",[22,37.266]],[\"comment/46\",[]],[\"name/47\",[31,51.93]],[\"comment/47\",[]],[\"name/48\",[9,16.764]],[\"comment/48\",[]],[\"name/49\",[10,21.172]],[\"comment/49\",[]],[\"name/50\",[11,37.266]],[\"comment/50\",[]],[\"name/51\",[32,51.93]],[\"comment/51\",[]],[\"name/52\",[33,51.93]],[\"comment/52\",[]],[\"name/53\",[9,16.764]],[\"comment/53\",[]],[\"name/54\",[10,21.172]],[\"comment/54\",[]],[\"name/55\",[13,37.266]],[\"comment/55\",[]],[\"name/56\",[34,51.93]],[\"comment/56\",[]],[\"name/57\",[17,46.821]],[\"comment/57\",[]],[\"name/58\",[12,46.821]],[\"comment/58\",[]],[\"name/59\",[9,16.764]],[\"comment/59\",[]],[\"name/60\",[10,21.172]],[\"comment/60\",[]],[\"name/61\",[13,37.266]],[\"comment/61\",[]],[\"name/62\",[35,51.93]],[\"comment/62\",[]],[\"name/63\",[9,16.764]],[\"comment/63\",[]],[\"name/64\",[10,21.172]],[\"comment/64\",[]],[\"name/65\",[36,40.943]],[\"comment/65\",[]],[\"name/66\",[37,37.266]],[\"comment/66\",[]],[\"name/67\",[25,46.821]],[\"comment/67\",[]],[\"name/68\",[9,16.764]],[\"comment/68\",[]],[\"name/69\",[10,21.172]],[\"comment/69\",[]],[\"name/70\",[22,37.266]],[\"comment/70\",[]],[\"name/71\",[38,51.93]],[\"comment/71\",[]],[\"name/72\",[28,46.821]],[\"comment/72\",[]],[\"name/73\",[27,46.821]],[\"comment/73\",[]],[\"name/74\",[9,16.764]],[\"comment/74\",[]],[\"name/75\",[10,21.172]],[\"comment/75\",[]],[\"name/76\",[22,37.266]],[\"comment/76\",[]],[\"name/77\",[39,46.821]],[\"comment/77\",[]],[\"name/78\",[9,16.764]],[\"comment/78\",[]],[\"name/79\",[10,21.172]],[\"comment/79\",[]],[\"name/80\",[13,37.266]],[\"comment/80\",[]],[\"name/81\",[40,46.821]],[\"comment/81\",[]],[\"name/82\",[41,46.821]],[\"comment/82\",[]],[\"name/83\",[42,46.821]],[\"comment/83\",[]],[\"name/84\",[9,16.764]],[\"comment/84\",[]],[\"name/85\",[10,21.172]],[\"comment/85\",[]],[\"name/86\",[36,40.943]],[\"comment/86\",[]],[\"name/87\",[37,37.266]],[\"comment/87\",[]],[\"name/88\",[43,51.93]],[\"comment/88\",[]],[\"name/89\",[44,51.93]],[\"comment/89\",[]],[\"name/90\",[9,16.764]],[\"comment/90\",[]],[\"name/91\",[10,21.172]],[\"comment/91\",[]],[\"name/92\",[36,40.943]],[\"comment/92\",[]],[\"name/93\",[37,37.266]],[\"comment/93\",[]],[\"name/94\",[39,46.821]],[\"comment/94\",[]],[\"name/95\",[9,16.764]],[\"comment/95\",[]],[\"name/96\",[10,21.172]],[\"comment/96\",[]],[\"name/97\",[13,37.266]],[\"comment/97\",[]],[\"name/98\",[40,46.821]],[\"comment/98\",[]],[\"name/99\",[41,46.821]],[\"comment/99\",[]],[\"name/100\",[42,46.821]],[\"comment/100\",[]],[\"name/101\",[9,16.764]],[\"comment/101\",[]],[\"name/102\",[10,21.172]],[\"comment/102\",[]],[\"name/103\",[36,40.943]],[\"comment/103\",[]],[\"name/104\",[37,37.266]],[\"comment/104\",[]],[\"name/105\",[45,51.93]],[\"comment/105\",[]],[\"name/106\",[9,16.764]],[\"comment/106\",[]],[\"name/107\",[10,21.172]],[\"comment/107\",[]],[\"name/108\",[46,43.457]],[\"comment/108\",[]],[\"name/109\",[47,46.821]],[\"comment/109\",[]],[\"name/110\",[9,16.764]],[\"comment/110\",[]],[\"name/111\",[10,21.172]],[\"comment/111\",[]],[\"name/112\",[48,37.266]],[\"comment/112\",[]],[\"name/113\",[49,51.93]],[\"comment/113\",[]],[\"name/114\",[50,37.266]],[\"comment/114\",[]],[\"name/115\",[51,51.93]],[\"comment/115\",[]],[\"name/116\",[52,51.93]],[\"comment/116\",[]],[\"name/117\",[9,16.764]],[\"comment/117\",[]],[\"name/118\",[10,21.172]],[\"comment/118\",[]],[\"name/119\",[53,43.457]],[\"comment/119\",[]],[\"name/120\",[54,51.93]],[\"comment/120\",[]],[\"name/121\",[9,16.764]],[\"comment/121\",[]],[\"name/122\",[10,21.172]],[\"comment/122\",[]],[\"name/123\",[55,43.457]],[\"comment/123\",[]],[\"name/124\",[56,46.821]],[\"comment/124\",[]],[\"name/125\",[57,51.93]],[\"comment/125\",[]],[\"name/126\",[9,16.764]],[\"comment/126\",[]],[\"name/127\",[58,51.93]],[\"comment/127\",[]],[\"name/128\",[59,51.93]],[\"comment/128\",[]],[\"name/129\",[60,51.93]],[\"comment/129\",[]],[\"name/130\",[61,51.93]],[\"comment/130\",[]],[\"name/131\",[9,16.764]],[\"comment/131\",[]],[\"name/132\",[62,51.93]],[\"comment/132\",[]],[\"name/133\",[63,51.93]],[\"comment/133\",[]],[\"name/134\",[64,51.93]],[\"comment/134\",[]],[\"name/135\",[65,51.93]],[\"comment/135\",[]],[\"name/136\",[9,16.764]],[\"comment/136\",[]],[\"name/137\",[11,37.266]],[\"comment/137\",[]],[\"name/138\",[66,51.93]],[\"comment/138\",[]],[\"name/139\",[67,51.93]],[\"comment/139\",[]],[\"name/140\",[68,51.93]],[\"comment/140\",[]],[\"name/141\",[9,16.764]],[\"comment/141\",[]],[\"name/142\",[10,21.172]],[\"comment/142\",[]],[\"name/143\",[11,37.266]],[\"comment/143\",[]],[\"name/144\",[69,51.93]],[\"comment/144\",[]],[\"name/145\",[9,16.764]],[\"comment/145\",[]],[\"name/146\",[10,21.172]],[\"comment/146\",[]],[\"name/147\",[11,37.266]],[\"comment/147\",[]],[\"name/148\",[70,51.93]],[\"comment/148\",[]],[\"name/149\",[9,16.764]],[\"comment/149\",[]],[\"name/150\",[10,21.172]],[\"comment/150\",[]],[\"name/151\",[46,43.457]],[\"comment/151\",[]],[\"name/152\",[71,51.93]],[\"comment/152\",[]],[\"name/153\",[9,16.764]],[\"comment/153\",[]],[\"name/154\",[10,21.172]],[\"comment/154\",[]],[\"name/155\",[53,43.457]],[\"comment/155\",[]],[\"name/156\",[72,51.93]],[\"comment/156\",[]],[\"name/157\",[9,16.764]],[\"comment/157\",[]],[\"name/158\",[10,21.172]],[\"comment/158\",[]],[\"name/159\",[55,43.457]],[\"comment/159\",[]],[\"name/160\",[73,51.93]],[\"comment/160\",[]],[\"name/161\",[74,51.93]],[\"comment/161\",[]],[\"name/162\",[75,51.93]],[\"comment/162\",[]],[\"name/163\",[76,51.93]],[\"comment/163\",[]],[\"name/164\",[77,51.93]],[\"comment/164\",[]],[\"name/165\",[9,16.764]],[\"comment/165\",[]],[\"name/166\",[10,21.172]],[\"comment/166\",[]],[\"name/167\",[78,51.93]],[\"comment/167\",[]],[\"name/168\",[9,16.764]],[\"comment/168\",[]],[\"name/169\",[10,21.172]],[\"comment/169\",[]],[\"name/170\",[79,51.93]],[\"comment/170\",[]],[\"name/171\",[9,16.764]],[\"comment/171\",[]],[\"name/172\",[10,21.172]],[\"comment/172\",[]],[\"name/173\",[46,43.457]],[\"comment/173\",[]],[\"name/174\",[80,51.93]],[\"comment/174\",[]],[\"name/175\",[9,16.764]],[\"comment/175\",[]],[\"name/176\",[10,21.172]],[\"comment/176\",[]],[\"name/177\",[53,43.457]],[\"comment/177\",[]],[\"name/178\",[81,51.93]],[\"comment/178\",[]],[\"name/179\",[9,16.764]],[\"comment/179\",[]],[\"name/180\",[10,21.172]],[\"comment/180\",[]],[\"name/181\",[55,43.457]],[\"comment/181\",[]],[\"name/182\",[82,51.93]],[\"comment/182\",[]],[\"name/183\",[83,51.93]],[\"comment/183\",[]],[\"name/184\",[84,51.93]],[\"comment/184\",[]],[\"name/185\",[85,51.93]],[\"comment/185\",[]],[\"name/186\",[86,51.93]],[\"comment/186\",[]],[\"name/187\",[56,46.821]],[\"comment/187\",[]],[\"name/188\",[87,46.821]],[\"comment/188\",[]],[\"name/189\",[88,51.93]],[\"comment/189\",[]],[\"name/190\",[89,51.93]],[\"comment/190\",[]],[\"name/191\",[90,51.93]],[\"comment/191\",[]],[\"name/192\",[87,46.821]],[\"comment/192\",[]],[\"name/193\",[91,51.93]],[\"comment/193\",[]],[\"name/194\",[92,51.93]],[\"comment/194\",[]],[\"name/195\",[93,51.93]],[\"comment/195\",[]],[\"name/196\",[9,16.764]],[\"comment/196\",[]],[\"name/197\",[11,37.266]],[\"comment/197\",[]],[\"name/198\",[94,51.93]],[\"comment/198\",[]],[\"name/199\",[16,40.943]],[\"comment/199\",[]],[\"name/200\",[95,51.93]],[\"comment/200\",[]],[\"name/201\",[9,16.764]],[\"comment/201\",[]],[\"name/202\",[96,51.93]],[\"comment/202\",[]],[\"name/203\",[18,38.937]],[\"comment/203\",[]],[\"name/204\",[16,40.943]],[\"comment/204\",[]],[\"name/205\",[14,43.457]],[\"comment/205\",[]],[\"name/206\",[15,43.457]],[\"comment/206\",[]],[\"name/207\",[97,51.93]],[\"comment/207\",[]],[\"name/208\",[9,16.764]],[\"comment/208\",[]],[\"name/209\",[18,38.937]],[\"comment/209\",[]],[\"name/210\",[16,40.943]],[\"comment/210\",[]],[\"name/211\",[14,43.457]],[\"comment/211\",[]],[\"name/212\",[15,43.457]],[\"comment/212\",[]],[\"name/213\",[98,51.93]],[\"comment/213\",[]],[\"name/214\",[9,16.764]],[\"comment/214\",[]],[\"name/215\",[13,37.266]],[\"comment/215\",[]],[\"name/216\",[99,51.93]],[\"comment/216\",[]],[\"name/217\",[100,51.93]],[\"comment/217\",[]],[\"name/218\",[101,51.93]],[\"comment/218\",[]],[\"name/219\",[102,51.93]],[\"comment/219\",[]],[\"name/220\",[103,51.93]],[\"comment/220\",[]],[\"name/221\",[104,43.457]],[\"comment/221\",[]],[\"name/222\",[9,16.764]],[\"comment/222\",[]],[\"name/223\",[104,43.457]],[\"comment/223\",[]],[\"name/224\",[105,46.821]],[\"comment/224\",[]],[\"name/225\",[106,46.821]],[\"comment/225\",[]],[\"name/226\",[9,16.764]],[\"comment/226\",[]],[\"name/227\",[104,43.457]],[\"comment/227\",[]],[\"name/228\",[105,46.821]],[\"comment/228\",[]],[\"name/229\",[107,51.93]],[\"comment/229\",[]],[\"name/230\",[9,16.764]],[\"comment/230\",[]],[\"name/231\",[50,37.266]],[\"comment/231\",[]],[\"name/232\",[48,37.266]],[\"comment/232\",[]],[\"name/233\",[108,51.93]],[\"comment/233\",[]],[\"name/234\",[9,16.764]],[\"comment/234\",[]],[\"name/235\",[50,37.266]],[\"comment/235\",[]],[\"name/236\",[48,37.266]],[\"comment/236\",[]],[\"name/237\",[109,51.93]],[\"comment/237\",[]],[\"name/238\",[110,51.93]],[\"comment/238\",[]],[\"name/239\",[9,16.764]],[\"comment/239\",[]],[\"name/240\",[50,37.266]],[\"comment/240\",[]],[\"name/241\",[48,37.266]],[\"comment/241\",[]],[\"name/242\",[47,46.821]],[\"comment/242\",[]],[\"name/243\",[9,16.764]],[\"comment/243\",[]],[\"name/244\",[50,37.266]],[\"comment/244\",[]],[\"name/245\",[48,37.266]],[\"comment/245\",[]],[\"name/246\",[111,51.93]],[\"comment/246\",[]],[\"name/247\",[112,51.93]],[\"comment/247\",[]],[\"name/248\",[9,16.764]],[\"comment/248\",[]],[\"name/249\",[50,37.266]],[\"comment/249\",[]],[\"name/250\",[48,37.266]],[\"comment/250\",[]],[\"name/251\",[106,46.821]],[\"comment/251\",[]],[\"name/252\",[113,51.93]],[\"comment/252\",[]],[\"name/253\",[9,16.764]],[\"comment/253\",[]],[\"name/254\",[114,51.93]],[\"comment/254\",[]],[\"name/255\",[115,51.93]],[\"comment/255\",[]],[\"name/256\",[116,51.93]],[\"comment/256\",[]],[\"name/257\",[9,16.764]],[\"comment/257\",[]],[\"name/258\",[18,38.937]],[\"comment/258\",[]],[\"name/259\",[19,46.821]],[\"comment/259\",[]],[\"name/260\",[117,51.93]],[\"comment/260\",[]],[\"name/261\",[9,16.764]],[\"comment/261\",[]],[\"name/262\",[37,37.266]],[\"comment/262\",[]],[\"name/263\",[118,51.93]],[\"comment/263\",[]],[\"name/264\",[9,16.764]],[\"comment/264\",[]],[\"name/265\",[37,37.266]],[\"comment/265\",[]],[\"name/266\",[119,51.93]],[\"comment/266\",[]],[\"name/267\",[120,46.821]],[\"comment/267\",[]],[\"name/268\",[120,46.821]],[\"comment/268\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":9,\"name\":{\"9\":{},\"13\":{},\"21\":{},\"27\":{},\"33\":{},\"38\":{},\"44\":{},\"48\":{},\"53\":{},\"59\":{},\"63\":{},\"68\":{},\"74\":{},\"78\":{},\"84\":{},\"90\":{},\"95\":{},\"101\":{},\"106\":{},\"110\":{},\"117\":{},\"121\":{},\"126\":{},\"131\":{},\"136\":{},\"141\":{},\"145\":{},\"149\":{},\"153\":{},\"157\":{},\"165\":{},\"168\":{},\"171\":{},\"175\":{},\"179\":{},\"196\":{},\"201\":{},\"208\":{},\"214\":{},\"222\":{},\"226\":{},\"230\":{},\"234\":{},\"239\":{},\"243\":{},\"248\":{},\"253\":{},\"257\":{},\"261\":{},\"264\":{}},\"comment\":{}}],[\"__typename\",{\"_index\":10,\"name\":{\"10\":{},\"14\":{},\"22\":{},\"28\":{},\"34\":{},\"39\":{},\"45\":{},\"49\":{},\"54\":{},\"60\":{},\"64\":{},\"69\":{},\"75\":{},\"79\":{},\"85\":{},\"91\":{},\"96\":{},\"102\":{},\"107\":{},\"111\":{},\"118\":{},\"122\":{},\"142\":{},\"146\":{},\"150\":{},\"154\":{},\"158\":{},\"166\":{},\"169\":{},\"172\":{},\"176\":{},\"180\":{}},\"comment\":{}}],[\"active\",{\"_index\":74,\"name\":{\"161\":{}},\"comment\":{}}],[\"actor\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"actorparts_customeractor_fragment\",{\"_index\":68,\"name\":{\"140\":{}},\"comment\":{}}],[\"actorparts_deletedcustomeractor_fragment\",{\"_index\":69,\"name\":{\"144\":{}},\"comment\":{}}],[\"actorparts_machineuseractor_fragment\",{\"_index\":70,\"name\":{\"148\":{}},\"comment\":{}}],[\"actorparts_systemactor_fragment\",{\"_index\":71,\"name\":{\"152\":{}},\"comment\":{}}],[\"actorparts_useractor_fragment\",{\"_index\":72,\"name\":{\"156\":{}},\"comment\":{}}],[\"apikey\",{\"_index\":58,\"name\":{\"127\":{}},\"comment\":{}}],[\"assignedat\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"assignedtouser\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"badrequesterror\",{\"_index\":108,\"name\":{\"233\":{}},\"comment\":{}}],[\"boolean\",{\"_index\":100,\"name\":{\"217\":{}},\"comment\":{}}],[\"code\",{\"_index\":50,\"name\":{\"114\":{},\"231\":{},\"235\":{},\"240\":{},\"244\":{},\"249\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"context\",{\"_index\":57,\"name\":{\"125\":{}},\"comment\":{}}],[\"createdat\",{\"_index\":27,\"name\":{\"37\":{},\"73\":{}},\"comment\":{}}],[\"createdby\",{\"_index\":28,\"name\":{\"41\":{},\"72\":{}},\"comment\":{}}],[\"createissue\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"createissueinput\",{\"_index\":65,\"name\":{\"135\":{}},\"comment\":{}}],[\"ctx\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"customer\",{\"_index\":12,\"name\":{\"12\":{},\"58\":{}},\"comment\":{}}],[\"customeractor\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"customergroupid\",{\"_index\":114,\"name\":{\"254\":{}},\"comment\":{}}],[\"customergroupidentifier\",{\"_index\":113,\"name\":{\"252\":{}},\"comment\":{}}],[\"customergroupidentifiers\",{\"_index\":96,\"name\":{\"202\":{}},\"comment\":{}}],[\"customergroupkey\",{\"_index\":115,\"name\":{\"255\":{}},\"comment\":{}}],[\"customerid\",{\"_index\":11,\"name\":{\"11\":{},\"50\":{},\"137\":{},\"143\":{},\"147\":{},\"197\":{}},\"comment\":{}}],[\"customerstatus\",{\"_index\":73,\"name\":{\"160\":{}},\"comment\":{}}],[\"data\",{\"_index\":104,\"name\":{\"221\":{},\"223\":{},\"227\":{}},\"comment\":{}}],[\"datetime\",{\"_index\":30,\"name\":{\"43\":{}},\"comment\":{}}],[\"defaultissuepriority\",{\"_index\":42,\"name\":{\"83\":{},\"100\":{}},\"comment\":{}}],[\"deletedat\",{\"_index\":43,\"name\":{\"88\":{}},\"comment\":{}}],[\"deletedcustomeractor\",{\"_index\":31,\"name\":{\"47\":{}},\"comment\":{}}],[\"email\",{\"_index\":18,\"name\":{\"20\":{},\"23\":{},\"203\":{},\"209\":{},\"258\":{}},\"comment\":{}}],[\"emailaddress\",{\"_index\":94,\"name\":{\"198\":{}},\"comment\":{}}],[\"emailaddressinput\",{\"_index\":116,\"name\":{\"256\":{}},\"comment\":{}}],[\"err\",{\"_index\":106,\"name\":{\"225\":{},\"251\":{}},\"comment\":{}}],[\"error\",{\"_index\":105,\"name\":{\"224\":{},\"228\":{}},\"comment\":{}}],[\"errordetails\",{\"_index\":111,\"name\":{\"246\":{}},\"comment\":{}}],[\"exact\",{\"_index\":60,\"name\":{\"129\":{}},\"comment\":{}}],[\"externalid\",{\"_index\":16,\"name\":{\"18\":{},\"199\":{},\"204\":{},\"210\":{}},\"comment\":{}}],[\"fields\",{\"_index\":51,\"name\":{\"115\":{}},\"comment\":{}}],[\"float\",{\"_index\":102,\"name\":{\"219\":{}},\"comment\":{}}],[\"forbidden\",{\"_index\":86,\"name\":{\"186\":{}},\"comment\":{}}],[\"forbiddenerror\",{\"_index\":107,\"name\":{\"229\":{}},\"comment\":{}}],[\"fullname\",{\"_index\":14,\"name\":{\"16\":{},\"205\":{},\"211\":{}},\"comment\":{}}],[\"getcustomerbyid\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"graphqlerrors\",{\"_index\":109,\"name\":{\"237\":{}},\"comment\":{}}],[\"id\",{\"_index\":13,\"name\":{\"15\":{},\"55\":{},\"61\":{},\"80\":{},\"97\":{},\"215\":{}},\"comment\":{}}],[\"identifier\",{\"_index\":62,\"name\":{\"132\":{}},\"comment\":{}}],[\"idle\",{\"_index\":75,\"name\":{\"162\":{}},\"comment\":{}}],[\"inputmaybe\",{\"_index\":103,\"name\":{\"220\":{}},\"comment\":{}}],[\"int\",{\"_index\":101,\"name\":{\"218\":{}},\"comment\":{}}],[\"internal\",{\"_index\":56,\"name\":{\"124\":{},\"187\":{}},\"comment\":{}}],[\"internalactor\",{\"_index\":32,\"name\":{\"51\":{}},\"comment\":{}}],[\"internalactorparts_customeractor_fragment\",{\"_index\":77,\"name\":{\"164\":{}},\"comment\":{}}],[\"internalactorparts_deletedcustomeractor_fragment\",{\"_index\":78,\"name\":{\"167\":{}},\"comment\":{}}],[\"internalactorparts_machineuseractor_fragment\",{\"_index\":79,\"name\":{\"170\":{}},\"comment\":{}}],[\"internalactorparts_systemactor_fragment\",{\"_index\":80,\"name\":{\"174\":{}},\"comment\":{}}],[\"internalactorparts_useractor_fragment\",{\"_index\":81,\"name\":{\"178\":{}},\"comment\":{}}],[\"internalservererror\",{\"_index\":110,\"name\":{\"238\":{}},\"comment\":{}}],[\"isarchived\",{\"_index\":41,\"name\":{\"82\":{},\"99\":{}},\"comment\":{}}],[\"iso8601\",{\"_index\":22,\"name\":{\"29\":{},\"35\":{},\"40\":{},\"46\":{},\"70\":{},\"76\":{}},\"comment\":{}}],[\"issue\",{\"_index\":33,\"name\":{\"52\":{}},\"comment\":{}}],[\"issuekey\",{\"_index\":34,\"name\":{\"56\":{}},\"comment\":{}}],[\"issuepriority\",{\"_index\":44,\"name\":{\"89\":{}},\"comment\":{}}],[\"issuestatus\",{\"_index\":82,\"name\":{\"182\":{}},\"comment\":{}}],[\"issuetype\",{\"_index\":39,\"name\":{\"77\":{},\"94\":{}},\"comment\":{}}],[\"issuetypeid\",{\"_index\":66,\"name\":{\"138\":{}},\"comment\":{}}],[\"isverified\",{\"_index\":19,\"name\":{\"24\":{},\"259\":{}},\"comment\":{}}],[\"label\",{\"_index\":36,\"name\":{\"65\":{},\"86\":{},\"92\":{},\"103\":{}},\"comment\":{}}],[\"lastidleat\",{\"_index\":26,\"name\":{\"36\":{}},\"comment\":{}}],[\"machineuseractor\",{\"_index\":45,\"name\":{\"105\":{}},\"comment\":{}}],[\"machineuserid\",{\"_index\":46,\"name\":{\"108\":{},\"151\":{},\"173\":{}},\"comment\":{}}],[\"markedasspamat\",{\"_index\":29,\"name\":{\"42\":{}},\"comment\":{}}],[\"maybe\",{\"_index\":119,\"name\":{\"266\":{}},\"comment\":{}}],[\"message\",{\"_index\":48,\"name\":{\"112\":{},\"232\":{},\"236\":{},\"241\":{},\"245\":{},\"250\":{}},\"comment\":{}}],[\"mutationerror\",{\"_index\":47,\"name\":{\"109\":{},\"242\":{}},\"comment\":{}}],[\"mutationerrortype\",{\"_index\":85,\"name\":{\"185\":{}},\"comment\":{}}],[\"mutationfielderrortype\",{\"_index\":88,\"name\":{\"189\":{}},\"comment\":{}}],[\"notfound\",{\"_index\":89,\"name\":{\"190\":{}},\"comment\":{}}],[\"oncreate\",{\"_index\":63,\"name\":{\"133\":{}},\"comment\":{}}],[\"onupdate\",{\"_index\":64,\"name\":{\"134\":{}},\"comment\":{}}],[\"open\",{\"_index\":83,\"name\":{\"183\":{}},\"comment\":{}}],[\"optionalstringinput\",{\"_index\":117,\"name\":{\"260\":{}},\"comment\":{}}],[\"plaingraphqlerror\",{\"_index\":120,\"name\":{\"267\":{},\"268\":{}},\"comment\":{}}],[\"plainsdkclient\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"plainsdkerror\",{\"_index\":92,\"name\":{\"194\":{}},\"comment\":{}}],[\"priority\",{\"_index\":35,\"name\":{\"62\":{}},\"comment\":{}}],[\"priorityvalue\",{\"_index\":67,\"name\":{\"139\":{}},\"comment\":{}}],[\"publicname\",{\"_index\":40,\"name\":{\"81\":{},\"98\":{}},\"comment\":{}}],[\"rawrequest\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"required\",{\"_index\":90,\"name\":{\"191\":{}},\"comment\":{}}],[\"resolved\",{\"_index\":84,\"name\":{\"184\":{}},\"comment\":{}}],[\"result\",{\"_index\":91,\"name\":{\"193\":{}},\"comment\":{}}],[\"scalars\",{\"_index\":98,\"name\":{\"213\":{}},\"comment\":{}}],[\"sdkresult\",{\"_index\":59,\"name\":{\"128\":{}},\"comment\":{}}],[\"shortname\",{\"_index\":15,\"name\":{\"17\":{},\"206\":{},\"212\":{}},\"comment\":{}}],[\"snoozed\",{\"_index\":76,\"name\":{\"163\":{}},\"comment\":{}}],[\"status\",{\"_index\":17,\"name\":{\"19\":{},\"57\":{}},\"comment\":{}}],[\"statuschangedat\",{\"_index\":21,\"name\":{\"26\":{}},\"comment\":{}}],[\"string\",{\"_index\":99,\"name\":{\"216\":{}},\"comment\":{}}],[\"stringinput\",{\"_index\":118,\"name\":{\"263\":{}},\"comment\":{}}],[\"systemactor\",{\"_index\":52,\"name\":{\"116\":{}},\"comment\":{}}],[\"systemid\",{\"_index\":53,\"name\":{\"119\":{},\"155\":{},\"177\":{}},\"comment\":{}}],[\"type\",{\"_index\":49,\"name\":{\"113\":{}},\"comment\":{}}],[\"unknownerror\",{\"_index\":112,\"name\":{\"247\":{}},\"comment\":{}}],[\"updatedat\",{\"_index\":25,\"name\":{\"32\":{},\"67\":{}},\"comment\":{}}],[\"updatedby\",{\"_index\":38,\"name\":{\"71\":{}},\"comment\":{}}],[\"upsertcustomer\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"upsertcustomeridentifierinput\",{\"_index\":93,\"name\":{\"195\":{}},\"comment\":{}}],[\"upsertcustomerinput\",{\"_index\":61,\"name\":{\"130\":{}},\"comment\":{}}],[\"upsertcustomeroncreateinput\",{\"_index\":95,\"name\":{\"200\":{}},\"comment\":{}}],[\"upsertcustomeronupdateinput\",{\"_index\":97,\"name\":{\"207\":{}},\"comment\":{}}],[\"useractor\",{\"_index\":54,\"name\":{\"120\":{}},\"comment\":{}}],[\"userid\",{\"_index\":55,\"name\":{\"123\":{},\"159\":{},\"181\":{}},\"comment\":{}}],[\"validation\",{\"_index\":87,\"name\":{\"188\":{},\"192\":{}},\"comment\":{}}],[\"value\",{\"_index\":37,\"name\":{\"66\":{},\"87\":{},\"93\":{},\"104\":{},\"262\":{},\"265\":{}},\"comment\":{}}],[\"verifiedat\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..18b4f8f --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1367 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + /* object literal not included as it is not used and will be removed in 0.25 */ + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + /* object literal not included as it is not used and will be removed in 0.25 */ + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/PlainSDKClient.html b/docs/classes/PlainSDKClient.html new file mode 100644 index 0000000..f7f8e30 --- /dev/null +++ b/docs/classes/PlainSDKClient.html @@ -0,0 +1,378 @@ +PlainSDKClient | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class PlainSDKClient

+
+

Hierarchy

+
    +
  • PlainSDKClient
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
#ctx +
+
+

Methods

+
createIssue +getCustomerById +rawRequest +upsertCustomer +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private #ctx

+
#ctx: Context
+
+

Methods

+
+

createIssue

+
+
+

getCustomerById

+
+
+

rawRequest

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      args: {
          query: string;
          variables: Record<string, unknown>;
      }
      +
        +
      • +
        query: string
        • +
      • +
        variables: Record<string, unknown>
    +

    Returns SDKResult<unknown>

+
+

upsertCustomer

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ParseStatus.html b/docs/classes/_internal_.ParseStatus.html new file mode 100644 index 0000000..c6b8634 --- /dev/null +++ b/docs/classes/_internal_.ParseStatus.html @@ -0,0 +1,373 @@ +ParseStatus | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ParseStatus

+
+

Hierarchy

+
    +
  • ParseStatus
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
value +
+
+

Methods

+
abort +dirty +mergeArray +mergeObjectAsync +mergeObjectSync +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

value

+
value: "valid" | "dirty" | "aborted"
+
+

Methods

+
+

abort

+
    + +
  • +

    Returns void

+
+

dirty

+
    + +
  • +

    Returns void

+
+

Static mergeArray

+
+
+

Static mergeObjectAsync

+
+
+

Static mergeObjectSync

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodArray-1.html b/docs/classes/_internal_.ZodArray-1.html new file mode 100644 index 0000000..fd4e7cd --- /dev/null +++ b/docs/classes/_internal_.ZodArray-1.html @@ -0,0 +1,1158 @@ +ZodArray | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodArray<T, Cardinality>

+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • ZodType<arrayOutputType<T, Cardinality>, ZodArrayDef<T>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]> +
      +
    • ZodArray
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +element +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +length +max +min +nonempty +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodArrayDef<T>
+
+

Readonly _input

+
_input: Cardinality extends "atleastone"
    ? [T["_input"], ...T["_input"][]]
    : T["_input"][]
+
+

Readonly _output

+
_output: arrayOutputType<T, Cardinality>
+
+

Readonly _type

+
_type: arrayOutputType<T, Cardinality>
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<Cardinality extends "atleastone"
    ? [T["_input"], ...T["_input"][]]
    : T["_input"][], arrayOutputType<T, Cardinality>>>)
+
+

Type declaration

+
    +
  • +
      +
    • (data, params?): Promise<SafeParseReturnType<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][], arrayOutputType<T, Cardinality>>>
      • +
    • +
      +

      Parameters

      +
      +

      Returns Promise<SafeParseReturnType<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][], arrayOutputType<T, Cardinality>>>

+
+

Static create

+
create: (<T_1>(schema, params?) => ZodArray<T_1, "many">)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(schema, params?): ZodArray<T_1, "many">
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        T_1 extends ZodType<any, any, any, T_1>

      +
      +

      Parameters

      +
      +

      Returns ZodArray<T_1, "many">

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

element

+
    +
  • get element(): T
    • +
  • +

    Returns T

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodArray<T, Cardinality>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodCatch<ZodArray<T, Cardinality>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => arrayOutputType<T, Cardinality>)
      +
        +
      • +
          +
        • (ctx): arrayOutputType<T, Cardinality>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: Cardinality extends "atleastone"
                    ? [T["_input"], ...T["_input"][]]
                    : T["_input"][];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: Cardinality extends "atleastone"
                  ? [T["_input"], ...T["_input"][]]
                  : T["_input"][]
          +

          Returns arrayOutputType<T, Cardinality>

    +

    Returns ZodCatch<ZodArray<T, Cardinality>>

+
+

default

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: noUndefined<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][]>
    +

    Returns ZodDefault<ZodArray<T, Cardinality>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: (() => noUndefined<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][]>)
      +
        +
      • +
          +
        • (): noUndefined<Cardinality extends "atleastone"
              ? [T["_input"], ...T["_input"][]]
              : T["_input"][]>
          • +
        • +

          Returns noUndefined<Cardinality extends "atleastone"
              ? [T["_input"], ...T["_input"][]]
              : T["_input"][]>

    +

    Returns ZodDefault<ZodArray<T, Cardinality>>

+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodArray<T, Cardinality>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

length

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodArray<T, Cardinality>

+
+

max

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      maxLength: number
      • +
    • +
      Optional message: ErrMessage
    +

    Returns ZodArray<T, Cardinality>

+
+

min

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      minLength: number
      • +
    • +
      Optional message: ErrMessage
    +

    Returns ZodArray<T, Cardinality>

+
+

nonempty

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodArray<T, "atleastone">

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodArray<T, Cardinality>, T]>

+
+

parse

+
+
+

parseAsync

+
+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

+
+

safeParse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns SafeParseReturnType<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][], arrayOutputType<T, Cardinality>>

+
+

safeParseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<SafeParseReturnType<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][], arrayOutputType<T, Cardinality>>>

+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
    +

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodArray<T, Cardinality>, NewOut, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodBranded-1.html b/docs/classes/_internal_.ZodBranded-1.html new file mode 100644 index 0000000..48cc0ef --- /dev/null +++ b/docs/classes/_internal_.ZodBranded-1.html @@ -0,0 +1,1065 @@ +ZodBranded | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodBranded<T, B>

+
+

Type Parameters

+
    +
  • +

    T extends ZodTypeAny

    • +
  • +

    B extends string | number | symbol

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +unwrap +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

      • +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
    +

    Returns ZodBranded<T, B>

+
+

Properties

+
+

Readonly _def

+
_def: ZodBrandedDef<T>
+
+

Readonly _input

+
_input: T["_input"]
+
+

Readonly _output

+
_output: T["_output"] & BRAND<B>
+
+

Readonly _type

+
_type: T["_output"] & BRAND<B>
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<T["_input"], T["_output"] & BRAND<B>>>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodBranded<T, B>, B>

+
+

catch

+
+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodBranded<T, B>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns T["_output"] & BRAND<B>

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T["_output"] & BRAND<B>>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"] & BRAND<B>
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"] & BRAND<B>
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodBranded<T, B>, T["_output"] & BRAND<B>, T["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodBranded<T, B>, T["_output"] & BRAND<B>, T["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodBranded<T, B>, NewOut, T["_input"]>

+
+

unwrap

+
    + +
  • +

    Returns T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodCatch-1.html b/docs/classes/_internal_.ZodCatch-1.html new file mode 100644 index 0000000..b96b76b --- /dev/null +++ b/docs/classes/_internal_.ZodCatch-1.html @@ -0,0 +1,1088 @@ +ZodCatch | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodCatch<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +removeCatch +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodCatchDef<T>
+
+

Readonly _input

+
_input: unknown
+
+

Readonly _output

+
_output: T["_output"]
+
+

Readonly _type

+
_type: T["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<unknown, T["_output"]>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(type, params) => ZodCatch<T_1>)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(type, params): ZodCatch<T_1>
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        T_1 extends ZodType<any, any, any, T_1>

      +
      +

      Parameters

      +
        +
      • +
        type: T_1
        • +
      • +
        params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            catch: T_1["_output"] | (() => T_1["_output"]);
        }
      +

      Returns ZodCatch<T_1>

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodCatch<T>, T["_output"], unknown>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodCatch<T>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: T["_output"]
    +

    Returns ZodCatch<ZodCatch<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => T["_output"])
      +
        +
      • +
          +
        • (ctx): T["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: unknown;
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: unknown
          +

          Returns T["_output"]

    +

    Returns ZodCatch<ZodCatch<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodCatch<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodCatch<T>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns T["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

+
+

removeCatch

+
    + +
  • +

    Returns T

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodCatch<T>, NewOut, unknown>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodDefault-1.html b/docs/classes/_internal_.ZodDefault-1.html new file mode 100644 index 0000000..135a64c --- /dev/null +++ b/docs/classes/_internal_.ZodDefault-1.html @@ -0,0 +1,1088 @@ +ZodDefault | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodDefault<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +removeDefault +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodDefaultDef<T>
+
+

Readonly _input

+
_input: undefined | T["_input"]
+
+

Readonly _output

+
_output: noUndefined<T["_output"]>
+
+

Readonly _type

+
_type: noUndefined<T["_output"]>
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<undefined | T["_input"], noUndefined<T["_output"]>>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(type, params) => ZodDefault<T_1>)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(type, params): ZodDefault<T_1>
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        T_1 extends ZodType<any, any, any, T_1>

      +
      +

      Parameters

      +
        +
      • +
        type: T_1
        • +
      • +
        params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            default: T_1["_input"] | (() => noUndefined<T_1["_input"]>);
        }
      +

      Returns ZodDefault<T_1>

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodDefault<T>, B>

+
+

catch

+
+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodDefault<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
+
+

parseAsync

+
+
+

pipe

+
+
+

promise

+
+
+

refine

+
+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodDefault<T>, RefinedOutput, undefined | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodDefault<T>, noUndefined<T["_output"]>, undefined | T["_input"]>

+
+

removeDefault

+
    + +
  • +

    Returns T

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodDefault<T>, RefinedOutput, undefined | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
    +

    Returns ZodEffects<ZodDefault<T>, noUndefined<T["_output"]>, undefined | T["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodDefault<T>, NewOut, undefined | T["_input"]>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodEffects-1.html b/docs/classes/_internal_.ZodEffects-1.html new file mode 100644 index 0000000..21d0d0c --- /dev/null +++ b/docs/classes/_internal_.ZodEffects-1.html @@ -0,0 +1,1148 @@ +ZodEffects | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodEffects<T, Output, Input>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +createWithPreprocess +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +innerType +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +sourceType +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodEffectsDef<T>
+
+

Readonly _input

+
_input: Input
+
+

Readonly _output

+
_output: Output
+
+

Readonly _type

+
_type: Output
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<I>(schema, effect, params?) => ZodEffects<I, I["_output"], input<I>>)
+
+

Type declaration

+
+
+

Static createWithPreprocess

+
createWithPreprocess: (<I>(preprocess, schema, params?) => ZodEffects<I, I["_output"], unknown>)
+
+

Type declaration

+
    +
  • +
      +
    • <I>(preprocess, schema, params?): ZodEffects<I, I["_output"], unknown>
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        I extends ZodType<any, any, any, I>

      +
      +

      Parameters

      +
        +
      • +
        preprocess: ((arg) => unknown)
        +
          +
        • +
            +
          • (arg): unknown
            • +
          • +
            +

            Parameters

            +
              +
            • +
              arg: unknown
            +

            Returns unknown

        • +
      • +
        schema: I
        • +
      • +
        Optional params: RawCreateParams
      +

      Returns ZodEffects<I, I["_output"], unknown>

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodEffects<T, Output, Input>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: Output
    +

    Returns ZodCatch<ZodEffects<T, Output, Input>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => Output)
      +
        +
      • +
          +
        • (ctx): Output
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: Input
          +

          Returns Output

    +

    Returns ZodCatch<ZodEffects<T, Output, Input>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodEffects<T, Output, Input>

+
+

innerType

+
    + +
  • +

    Returns T

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodEffects<T, Output, Input>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Output

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<Output>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

sourceType

+
    + +
  • +

    Returns T

+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodEffects<T, Output, Input>, NewOut, Input>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodEnum-1.html b/docs/classes/_internal_.ZodEnum-1.html new file mode 100644 index 0000000..dbcc8d4 --- /dev/null +++ b/docs/classes/_internal_.ZodEnum-1.html @@ -0,0 +1,1177 @@ +ZodEnum | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodEnum<T>

+
+

Type Parameters

+
    +
  • +

    T extends [string, ...string[]]

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
Enum +Values +description +enum +options +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +exclude +extract +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends [string, ...string[]]

    +
    +

    Parameters

    +
    +

    Returns ZodEnum<T>

+
+

Properties

+
+

Readonly _def

+
_def: ZodEnumDef<T>
+
+

Readonly _input

+
_input: T[number]
+
+

Readonly _output

+
_output: T[number]
+
+

Readonly _type

+
_type: T[number]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<T[number], T[number]>>)
+
+

Type declaration

+
+
+

Static create

+
create: {
    <U, T>(values, params?): ZodEnum<Writeable<T>>;
    <U, T>(values, params?): ZodEnum<T>;
}
+
+

Type declaration

+
    +
  • +
      +
    • <U, T>(values, params?): ZodEnum<Writeable<T>>
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        U extends string

        • +
      • +

        T extends readonly [U, U, T]

      +
      +

      Parameters

      +
      +

      Returns ZodEnum<Writeable<T>>

      • +
    • <U, T>(values, params?): ZodEnum<T>
      • +
    • +
      +

      Type Parameters

      +
        +
      • +

        U extends string

        • +
      • +

        T extends [U, ...U[]]

      +
      +

      Parameters

      +
      +

      Returns ZodEnum<T>

+
+

Accessors

+
+

Enum

+
    +
  • get Enum(): Values<T>
    • +
  • +

    Returns Values<T>

+
+

Values

+
    +
  • get Values(): Values<T>
    • +
  • +

    Returns Values<T>

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

enum

+
    +
  • get enum(): Values<T>
    • +
  • +

    Returns Values<T>

+
+

options

+
    +
  • get options(): T
    • +
  • +

    Returns T

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodEnum<T>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: T[number]
    +

    Returns ZodCatch<ZodEnum<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => T[number])
      +
        +
      • +
          +
        • (ctx): T[number]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: T[number];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: T[number]
          +

          Returns T[number]

    +

    Returns ZodCatch<ZodEnum<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodEnum<T>

+
+

exclude

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      ToExclude extends readonly [T[number], T[number], ToExclude]

    +
    +

    Parameters

    +
      +
    • +
      values: ToExclude
    +

    Returns ZodEnum<typecast<Writeable<FilterEnum<T, ToExclude[number]>>, [string, ...string[]]>>

+
+

extract

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      ToExtract extends readonly [T[number], T[number], ToExtract]

    +
    +

    Parameters

    +
      +
    • +
      values: ToExtract
    +

    Returns ZodEnum<Writeable<ToExtract>>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodEnum<T>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns T[number]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T[number]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends string

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends string

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends string

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodEnum<T>, NewOut, T[number]>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodError.html b/docs/classes/_internal_.ZodError.html new file mode 100644 index 0000000..af5667f --- /dev/null +++ b/docs/classes/_internal_.ZodError.html @@ -0,0 +1,589 @@ +ZodError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodError<T>

+
+

Type Parameters

+
    +
  • +

    T = any

+
+

Hierarchy

+
    +
  • Error +
      +
    • ZodError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
addIssue +addIssues +cause? +issues +name +stack? +create +prepareStackTrace? +stackTraceLimit +
+
+

Accessors

+
errors +formErrors +isEmpty +message +
+
+

Methods

+
flatten +format +toString +captureStackTrace +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
    +

    Returns ZodError<T>

+
+

Properties

+
+

addIssue

+
addIssue: ((sub) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (sub): void
      • +
    • +
      +

      Parameters

      +
      +

      Returns void

+
+

addIssues

+
addIssues: ((subs?) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (subs?): void
      • +
    • +
      +

      Parameters

      +
      +

      Returns void

+
+

Optional cause

+
cause?: unknown
+
+

issues

+
issues: ZodIssue[]
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Static create

+
create: ((issues) => ZodError<any>)
+
+

Type declaration

+
+
+

Static Optional prepareStackTrace

+
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+

Static stackTraceLimit

+
stackTraceLimit: number
+
+

Accessors

+
+

errors

+
    +
  • get errors(): ZodIssue[]
    • +
  • +

    Returns ZodIssue[]

+
+

formErrors

+
+
+

isEmpty

+
    +
  • get isEmpty(): boolean
    • +
  • +

    Returns boolean

+
+

message

+
    +
  • get message(): string
    • +
  • +

    Returns string

+
+

Methods

+
+

flatten

+
+
+

format

+
    + +
  • +

    Returns ZodFormattedError<T, string>

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      U

    +
    +

    Parameters

    +
      +
    • +
      mapper: ((issue) => U)
      +
        +
      • +
          +
        • (issue): U
          • +
        • +
          +

          Parameters

          +
          +

          Returns U

    +

    Returns ZodFormattedError<T, U>

+
+

toString

+
    + +
  • +

    Returns string

+
+

Static captureStackTrace

+
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
      • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodIntersection-1.html b/docs/classes/_internal_.ZodIntersection-1.html new file mode 100644 index 0000000..8ece211 --- /dev/null +++ b/docs/classes/_internal_.ZodIntersection-1.html @@ -0,0 +1,1086 @@ +ZodIntersection | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodIntersection<T, U>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodIntersectionDef<T, U>
+
+

Readonly _input

+
_input: T["_input"] & U["_input"]
+
+

Readonly _output

+
_output: T["_output"] & U["_output"]
+
+

Readonly _type

+
_type: T["_output"] & U["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<T["_input"] & U["_input"], T["_output"] & U["_output"]>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1, U_1>(left, right, params?) => ZodIntersection<T_1, U_1>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

+
+

and

+
+
+

array

+
+
+

brand

+
+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: T["_output"] & U["_output"]
    +

    Returns ZodCatch<ZodIntersection<T, U>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => T["_output"] & U["_output"])
      +
        +
      • +
          +
        • (ctx): T["_output"] & U["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: T["_input"] & U["_input"];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: T["_input"] & U["_input"]
          +

          Returns T["_output"] & U["_output"]

    +

    Returns ZodCatch<ZodIntersection<T, U>>

+
+

default

+
+
+

describe

+
+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns T["_output"] & U["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T["_output"] & U["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"] & U["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"] & U["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T["_output"] & U["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodIntersection<T, U>, NewOut, T["_input"] & U["_input"]>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodNullable-1.html b/docs/classes/_internal_.ZodNullable-1.html new file mode 100644 index 0000000..11b0766 --- /dev/null +++ b/docs/classes/_internal_.ZodNullable-1.html @@ -0,0 +1,1088 @@ +ZodNullable | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodNullable<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +unwrap +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodNullableDef<T>
+
+

Readonly _input

+
_input: null | T["_input"]
+
+

Readonly _output

+
_output: null | T["_output"]
+
+

Readonly _type

+
_type: null | T["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<null | T["_input"], null | T["_output"]>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(type, params?) => ZodNullable<T_1>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

+
+

and

+
+
+

array

+
+
+

brand

+
+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: null | T["_output"]
    +

    Returns ZodCatch<ZodNullable<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => null | T["_output"])
      +
        +
      • +
          +
        • (ctx): null | T["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: null | T["_input"];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: null | T["_input"]
          +

          Returns null | T["_output"]

    +

    Returns ZodCatch<ZodNullable<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodNullable<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns null | T["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<null | T["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: null | T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: null | T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: null | T["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodNullable<T>, NewOut, null | T["_input"]>

+
+

unwrap

+
    + +
  • +

    Returns T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodNumber-1.html b/docs/classes/_internal_.ZodNumber-1.html new file mode 100644 index 0000000..526daae --- /dev/null +++ b/docs/classes/_internal_.ZodNumber-1.html @@ -0,0 +1,1393 @@ +ZodNumber | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodNumber

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +max +min +spa +step +create +
+
+

Accessors

+
description +isFinite +isInt +maxValue +minValue +
+
+

Methods

+
_addCheck +_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +finite +gt +gte +int +isNullable +isOptional +lt +lte +multipleOf +negative +nonnegative +nonpositive +nullable +nullish +optional +or +parse +parseAsync +pipe +positive +promise +refine +refinement +safe +safeParse +safeParseAsync +setLimit +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodNumberDef
+
+

Readonly _input

+
_input: number
+
+

Readonly _output

+
_output: number
+
+

Readonly _type

+
_type: number
+
+

max

+
max: ((value, message?) => ZodNumber)
+
+

Type declaration

+
+
+

min

+
min: ((value, message?) => ZodNumber)
+
+

Type declaration

+
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<number, number>>)
+
+

Type declaration

+
+
+

step

+
step: ((value, message?) => ZodNumber)
+
+

Type declaration

+
+
+

Static create

+
create: ((params?) => ZodNumber)
+
+

Type declaration

+
    +
  • +
      +
    • (params?): ZodNumber
      • +
    • +
      +

      Parameters

      +
        +
      • +
        Optional params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            coerce?: boolean;
        }
      +

      Returns ZodNumber

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

isFinite

+
    +
  • get isFinite(): boolean
    • +
  • +

    Returns boolean

+
+

isInt

+
    +
  • get isInt(): boolean
    • +
  • +

    Returns boolean

+
+

maxValue

+
    +
  • get maxValue(): null | number
    • +
  • +

    Returns null | number

+
+

minValue

+
    +
  • get minValue(): null | number
    • +
  • +

    Returns null | number

+
+

Methods

+
+

_addCheck

+
+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodNumber, B>

+
+

catch

+
+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodNumber

+
+

finite

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

gt

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

gte

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

int

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

lt

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

lte

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

multipleOf

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

negative

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

nonnegative

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

nonpositive

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns number

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<number>

+
+

pipe

+
+
+

positive

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

promise

+
+
+

refine

+
+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends number

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: number
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodNumber, RefinedOutput, number>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: number
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodNumber, number, number>

+
+

safe

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodNumber

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

Protected setLimit

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      kind: "min" | "max"
      • +
    • +
      value: number
      • +
    • +
      inclusive: boolean
      • +
    • +
      Optional message: string
    +

    Returns ZodNumber

+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends number

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodNumber, RefinedOutput, number>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodNumber, number, number>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodNumber, NewOut, number>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodObject-1.html b/docs/classes/_internal_.ZodObject-1.html new file mode 100644 index 0000000..a177f09 --- /dev/null +++ b/docs/classes/_internal_.ZodObject-1.html @@ -0,0 +1,1457 @@ +ZodObject | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodObject<T, UnknownKeys, Catchall, Output, Input>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_cached +_def +_input +_output +_type +augment +nonstrict +spa +create +lazycreate +strictCreate +
+
+

Accessors

+
description +shape +
+
+

Methods

+
_getCached +_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +catchall +deepPartial +default +describe +extend +isNullable +isOptional +keyof +merge +nullable +nullish +omit +optional +or +parse +parseAsync +partial +passthrough +pick +pipe +promise +refine +refinement +required +safeParse +safeParseAsync +setKey +strict +strip +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private _cached

+
_cached: any
+
+

Readonly _def

+
_def: ZodObjectDef<T, UnknownKeys, Catchall>
+
+

Readonly _input

+
_input: Input
+
+

Readonly _output

+
_output: Output
+
+

Readonly _type

+
_type: Output
+
+

augment

+
augment: (<Augmentation>(augmentation) => ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>>)
+
+

Type declaration

+
    +
  • +
      +
    • <Augmentation>(augmentation): ZodObject<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, UnknownKeys, Catchall, objectOutputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>, objectInputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>>
      • +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
        +
      • +
        augmentation: Augmentation
      +

      Returns ZodObject<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, UnknownKeys, Catchall, objectOutputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>, objectInputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>>

+
+

nonstrict

+
nonstrict: (() => ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall, "passthrough">, objectInputType<T, Catchall, "passthrough">>)
+
+

Type declaration

+
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
      +

      Returns ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

+
+

Static lazycreate

+
lazycreate: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
        +
      • +
        shape: (() => T_1)
        +
          +
        • +
            +
          • (): T_1
            • +
          • +

            Returns T_1

        • +
      • +
        Optional params: RawCreateParams
      +

      Returns ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

+
+

Static strictCreate

+
strictCreate: (<T_1>(shape, params?) => ZodObject<T_1, "strict", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
+
+

Type declaration

+
    +
  • +
      +
    • <T_1>(shape, params?): ZodObject<T_1, "strict", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • +
    • +
      +

      Type Parameters

      +
      +
      +

      Parameters

      +
      +

      Returns ZodObject<T_1, "strict", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

shape

+
    +
  • get shape(): T
    • +
  • +

    Returns T

+
+

Methods

+
+

_getCached

+
    +
  • _getCached(): {
        keys: string[];
        shape: T;
    }
    • +
  • +

    Returns {
        keys: string[];
        shape: T;
    }

    +
      +
    • +
      keys: string[]
      • +
    • +
      shape: T
+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

+
+

and

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      incoming: T
    +

    Returns ZodIntersection<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>

+
+

array

+
    + +
  • +

    Returns ZodArray<ZodObject<T, UnknownKeys, Catchall, Output, Input>, "many">

+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: Output
    +

    Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => Output)
      +
        +
      • +
          +
        • (ctx): Output
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: Input
          +

          Returns Output

    +

    Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

+
+

catchall

+
+
+

deepPartial

+
    + +
  • +

    Returns DeepPartial<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodObject<T, UnknownKeys, Catchall, Output, Input>

+
+

extend

+
    + +
  • +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      augmentation: Augmentation
    +

    Returns ZodObject<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Catchall, UnknownKeys>>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

keyof

+
+
+

merge

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Incoming extends ZodObject<any, any, any, {}, {}, Incoming>

      • +
    • +

      Augmentation extends any

    +
    +

    Parameters

    +
      +
    • +
      merging: Incoming
    +

    Returns ZodObject<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>

+
+

nullable

+
+
+

nullish

+
+
+

omit

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Mask extends {
          [k in string | number | symbol]?: true
      }

    +
    +

    Parameters

    +
      +
    • +
      mask: Mask
    +

    Returns ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall, objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>, objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>>

+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodObject<T, UnknownKeys, Catchall, Output, Input>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Output

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<Output>

+
+

partial

+
    + +
  • +

    Returns ZodObject<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, Catchall, UnknownKeys>>

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Mask extends {
          [k in string | number | symbol]?: true
      }

    +
    +

    Parameters

    +
      +
    • +
      mask: Mask
    +

    Returns ZodObject<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>>

+
+

passthrough

+
+
+

pick

+
+
+

pipe

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      target: T
    +

    Returns ZodPipeline<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>

+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

+
+

required

+
    + +
  • +

    Returns ZodObject<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, Catchall, UnknownKeys>>

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Mask extends {
          [k in string | number | symbol]?: true
      }

    +
    +

    Parameters

    +
      +
    • +
      mask: Mask
    +

    Returns ZodObject<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

setKey

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Key extends string

      • +
    • +

      Schema extends ZodType<any, any, any, Schema>

    +
    +

    Parameters

    +
      +
    • +
      key: Key
      • +
    • +
      schema: Schema
    +

    Returns ZodObject<T & {
        [k in string]: Schema
    }, UnknownKeys, Catchall, objectOutputType<T & {
        [k in string]: Schema
    }, Catchall, UnknownKeys>, objectInputType<T & {
        [k in string]: Schema
    }, Catchall, UnknownKeys>>

+
+

strict

+
+
+

strip

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut, Input>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodOptional-1.html b/docs/classes/_internal_.ZodOptional-1.html new file mode 100644 index 0000000..a194a09 --- /dev/null +++ b/docs/classes/_internal_.ZodOptional-1.html @@ -0,0 +1,1088 @@ +ZodOptional | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodOptional<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +unwrap +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodOptionalDef<T>
+
+

Readonly _input

+
_input: undefined | T["_input"]
+
+

Readonly _output

+
_output: undefined | T["_output"]
+
+

Readonly _type

+
_type: undefined | T["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(type, params?) => ZodOptional<T_1>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

+
+

and

+
+
+

array

+
+
+

brand

+
+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: undefined | T["_output"]
    +

    Returns ZodCatch<ZodOptional<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => undefined | T["_output"])
      +
        +
      • +
          +
        • (ctx): undefined | T["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: undefined | T["_input"];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: undefined | T["_input"]
          +

          Returns undefined | T["_output"]

    +

    Returns ZodCatch<ZodOptional<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodOptional<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns undefined | T["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<undefined | T["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: undefined | T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: undefined | T["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: undefined | T["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>

+
+

unwrap

+
    + +
  • +

    Returns T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodPipeline-1.html b/docs/classes/_internal_.ZodPipeline-1.html new file mode 100644 index 0000000..3c35664 --- /dev/null +++ b/docs/classes/_internal_.ZodPipeline-1.html @@ -0,0 +1,1079 @@ +ZodPipeline | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodPipeline<A, B>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +create +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodPipelineDef<A, B>
+
+

Readonly _input

+
_input: A["_input"]
+
+

Readonly _output

+
_output: B["_output"]
+
+

Readonly _type

+
_type: B["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<A["_input"], B["_output"]>>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodPipeline<A, B>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: B["_output"]
    +

    Returns ZodCatch<ZodPipeline<A, B>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => B["_output"])
      +
        +
      • +
          +
        • (ctx): B["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: A["_input"];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: A["_input"]
          +

          Returns B["_output"]

    +

    Returns ZodCatch<ZodPipeline<A, B>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodPipeline<A, B>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns B["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<B["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: B["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: B["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: B["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodPipeline<A, B>, NewOut, A["_input"]>

+
+

Static create

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      A extends ZodType<any, any, any, A>

      • +
    • +

      B extends ZodType<any, any, any, B>

    +
    +

    Parameters

    +
      +
    • +
      a: A
      • +
    • +
      b: B
    +

    Returns ZodPipeline<A, B>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodPromise-1.html b/docs/classes/_internal_.ZodPromise-1.html new file mode 100644 index 0000000..4bff6a4 --- /dev/null +++ b/docs/classes/_internal_.ZodPromise-1.html @@ -0,0 +1,1088 @@ +ZodPromise | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodPromise<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +unwrap +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodPromiseDef<T>
+
+

Readonly _input

+
_input: Promise<T["_input"]>
+
+

Readonly _output

+
_output: Promise<T["_output"]>
+
+

Readonly _type

+
_type: Promise<T["_output"]>
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(schema, params?) => ZodPromise<T_1>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodPromise<T>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: Promise<T["_output"]>
    +

    Returns ZodCatch<ZodPromise<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => Promise<T["_output"]>)
      +
        +
      • +
          +
        • (ctx): Promise<T["_output"]>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: Promise<T["_input"]>;
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: Promise<T["_input"]>
          +

          Returns Promise<T["_output"]>

    +

    Returns ZodCatch<ZodPromise<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodPromise<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T["_output"]>

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<Promise<T["_output"]>>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Promise<T["_output"]>
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Promise<T["_output"]>
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Promise<T["_output"]>
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodPromise<T>, NewOut, Promise<T["_input"]>>

+
+

unwrap

+
    + +
  • +

    Returns T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodString-1.html b/docs/classes/_internal_.ZodString-1.html new file mode 100644 index 0000000..1232ca6 --- /dev/null +++ b/docs/classes/_internal_.ZodString-1.html @@ -0,0 +1,1534 @@ +ZodString | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodString

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_regex +_type +nonempty +spa +toLowerCase +toUpperCase +trim +create +
+
+

Accessors

+
description +isCUID +isCUID2 +isDatetime +isEmail +isEmoji +isIP +isULID +isURL +isUUID +maxLength +minLength +
+
+

Methods

+
_addCheck +_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +cuid +cuid2 +datetime +default +describe +email +emoji +endsWith +includes +ip +isNullable +isOptional +length +max +min +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +regex +safeParse +safeParseAsync +startsWith +superRefine +transform +ulid +url +uuid +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodStringDef
+
+

Readonly _input

+
_input: string
+
+

Readonly _output

+
_output: string
+
+

Protected _regex

+
_regex: ((regex, validation, message?) => ZodEffects<ZodString, string, string>)
+
+

Type declaration

+
+
+

Readonly _type

+
_type: string
+
+

nonempty

+
nonempty: ((message?) => ZodString)
+
+

Type declaration

+
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<string, string>>)
+
+

Type declaration

+
+
+

toLowerCase

+
toLowerCase: (() => ZodString)
+
+

Type declaration

+
+
+

toUpperCase

+
toUpperCase: (() => ZodString)
+
+

Type declaration

+
+
+

trim

+
trim: (() => ZodString)
+
+

Type declaration

+
+
+

Static create

+
create: ((params?) => ZodString)
+
+

Type declaration

+
    +
  • +
      +
    • (params?): ZodString
      • +
    • +
      +

      Parameters

      +
        +
      • +
        Optional params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            coerce?: true;
        }
      +

      Returns ZodString

+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

isCUID

+
    +
  • get isCUID(): boolean
    • +
  • +

    Returns boolean

+
+

isCUID2

+
    +
  • get isCUID2(): boolean
    • +
  • +

    Returns boolean

+
+

isDatetime

+
    +
  • get isDatetime(): boolean
    • +
  • +

    Returns boolean

+
+

isEmail

+
    +
  • get isEmail(): boolean
    • +
  • +

    Returns boolean

+
+

isEmoji

+
    +
  • get isEmoji(): boolean
    • +
  • +

    Returns boolean

+
+

isIP

+
    +
  • get isIP(): boolean
    • +
  • +

    Returns boolean

+
+

isULID

+
    +
  • get isULID(): boolean
    • +
  • +

    Returns boolean

+
+

isURL

+
    +
  • get isURL(): boolean
    • +
  • +

    Returns boolean

+
+

isUUID

+
    +
  • get isUUID(): boolean
    • +
  • +

    Returns boolean

+
+

maxLength

+
    +
  • get maxLength(): null | number
    • +
  • +

    Returns null | number

+
+

minLength

+
    +
  • get minLength(): null | number
    • +
  • +

    Returns null | number

+
+

Methods

+
+

_addCheck

+
+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodString, B>

+
+

catch

+
+
+

cuid

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

cuid2

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

datetime

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional options: string | {
          message?: string;
          offset?: boolean;
          precision?: null | number;
      }
    +

    Returns ZodString

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodString

+
+

email

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

emoji

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

endsWith

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

includes

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      value: string
      • +
    • +
      Optional options: {
          message?: string;
          position?: number;
      }
      +
        +
      • +
        Optional message?: string
        • +
      • +
        Optional position?: number
    +

    Returns ZodString

+
+

ip

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional options: string | {
          message?: string;
          version?: "v4" | "v6";
      }
    +

    Returns ZodString

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

length

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

max

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      maxLength: number
      • +
    • +
      Optional message: ErrMessage
    +

    Returns ZodString

+
+

min

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      minLength: number
      • +
    • +
      Optional message: ErrMessage
    +

    Returns ZodString

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<string>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends string

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: string
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodString, RefinedOutput, string>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: string
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodString, string, string>

+
+

regex

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

startsWith

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends string

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodString, RefinedOutput, string>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodString, string, string>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodString, NewOut, string>

+
+

ulid

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

url

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+

uuid

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns ZodString

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodTuple-1.html b/docs/classes/_internal_.ZodTuple-1.html new file mode 100644 index 0000000..1cd7811 --- /dev/null +++ b/docs/classes/_internal_.ZodTuple-1.html @@ -0,0 +1,1112 @@ +ZodTuple | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodTuple<T, Rest>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +items +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +rest +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodTupleDef<T, Rest>
+
+

Readonly _input

+
_input: InputTypeOfTupleWithRest<T, Rest>
+
+

Readonly _output

+
_output: OutputTypeOfTupleWithRest<T, Rest>
+
+

Readonly _type

+
_type: OutputTypeOfTupleWithRest<T, Rest>
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(schemas, params?) => ZodTuple<T_1, null>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

items

+
    +
  • get items(): T
    • +
  • +

    Returns T

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodTuple<T, Rest>, B>

+
+

catch

+
+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodTuple<T, Rest>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodTuple<T, Rest>, T]>

+
+

parse

+
+
+

parseAsync

+
+
+

pipe

+
+
+

promise

+
+
+

refine

+
+
+

refinement

+
+
+

rest

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      Rest extends ZodType<any, any, any, Rest>

    +
    +

    Parameters

    +
      +
    • +
      rest: Rest
    +

    Returns ZodTuple<T, Rest>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
+
+

transform

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodType.html b/docs/classes/_internal_.ZodType.html new file mode 100644 index 0000000..f1aa566 --- /dev/null +++ b/docs/classes/_internal_.ZodType.html @@ -0,0 +1,1033 @@ +ZodType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodType<Output, Def, Input>Abstract

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +
+
+

Accessors

+
description +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      def: Def
    +

    Returns ZodType<Output, Def, Input>

+
+

Properties

+
+

Readonly _def

+
_def: Def
+
+

Readonly _input

+
_input: Input
+
+

Readonly _output

+
_output: Output
+
+

Readonly _type

+
_type: Output
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

Abstract _parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

+
+

and

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      incoming: T
    +

    Returns ZodIntersection<ZodType<Output, Def, Input>, T>

+
+

array

+
    + +
  • +

    Returns ZodArray<ZodType<Output, Def, Input>, "many">

+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodType<Output, Def, Input>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: Output
    +

    Returns ZodCatch<ZodType<Output, Def, Input>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => Output)
      +
        +
      • +
          +
        • (ctx): Output
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: Input
          +

          Returns Output

    +

    Returns ZodCatch<ZodType<Output, Def, Input>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodType<Output, Def, Input>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodType<Output, Def, Input>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Output

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<Output>

+
+

pipe

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      target: T
    +

    Returns ZodPipeline<ZodType<Output, Def, Input>, T>

+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | ((arg) => Partial<Omit<ZodCustomIssue, "code">>) | Partial<Omit<ZodCustomIssue, "code">>
    +

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: Output
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodUnion-1.html b/docs/classes/_internal_.ZodUnion-1.html new file mode 100644 index 0000000..80b2c3b --- /dev/null +++ b/docs/classes/_internal_.ZodUnion-1.html @@ -0,0 +1,1088 @@ +ZodUnion | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Class ZodUnion<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_def +_input +_output +_type +spa +create +
+
+

Accessors

+
description +options +
+
+

Methods

+
_getOrReturnCtx +_getType +_parse +_parseAsync +_parseSync +_processInputParams +_refinement +and +array +brand +catch +default +describe +isNullable +isOptional +nullable +nullish +optional +or +parse +parseAsync +pipe +promise +refine +refinement +safeParse +safeParseAsync +superRefine +transform +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly _def

+
_def: ZodUnionDef<T>
+
+

Readonly _input

+
_input: T[number]["_input"]
+
+

Readonly _output

+
_output: T[number]["_output"]
+
+

Readonly _type

+
_type: T[number]["_output"]
+
+

spa

+
spa: ((data, params?) => Promise<SafeParseReturnType<T[number]["_input"], T[number]["_output"]>>)
+
+

Type declaration

+
+
+

Static create

+
create: (<T_1>(types, params?) => ZodUnion<T_1>)
+
+

Type declaration

+
+
+

Accessors

+
+

description

+
    +
  • get description(): undefined | string
    • +
  • +

    Returns undefined | string

+
+

options

+
    +
  • get options(): T
    • +
  • +

    Returns T

+
+

Methods

+
+

_getOrReturnCtx

+
+
+

_getType

+
    +
  • _getType(input): string
    • +
  • +
    +

    Parameters

    +
    +

    Returns string

+
+

_parse

+
+
+

_parseAsync

+
+
+

_parseSync

+
+
+

_processInputParams

+
+
+

_refinement

+
    +
  • _refinement(refinement): ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>
    • +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => any)
      +
        +
      • +
          +
        • (arg, ctx): any
          • +
        • +
          +

          Parameters

          +
          +

          Returns any

    +

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

+
+

and

+
+
+

array

+
+
+

brand

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      B extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      Optional brand: B
    +

    Returns ZodBranded<ZodUnion<T>, B>

+
+

catch

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      def: T[number]["_output"]
    +

    Returns ZodCatch<ZodUnion<T>>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      def: ((ctx) => T[number]["_output"])
      +
        +
      • +
          +
        • (ctx): T[number]["_output"]
          • +
        • +
          +

          Parameters

          +
            +
          • +
            ctx: {
                error: ZodError<any>;
                input: T[number]["_input"];
            }
            +
              +
            • +
              error: ZodError<any>
              • +
            • +
              input: T[number]["_input"]
          +

          Returns T[number]["_output"]

    +

    Returns ZodCatch<ZodUnion<T>>

+
+

default

+
+
+

describe

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      description: string
    +

    Returns ZodUnion<T>

+
+

isNullable

+
    + +
  • +

    Returns boolean

+
+

isOptional

+
    + +
  • +

    Returns boolean

+
+

nullable

+
+
+

nullish

+
+
+

optional

+
+
+

or

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ZodType<any, any, any, T>

    +
    +

    Parameters

    +
      +
    • +
      option: T
    +

    Returns ZodUnion<[ZodUnion<T>, T]>

+
+

parse

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns T[number]["_output"]

+
+

parseAsync

+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<T[number]["_output"]>

+
+

pipe

+
+
+

promise

+
+
+

refine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    +

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • + +
  • +
    +

    Parameters

    +
    +

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

+
+

refinement

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]["_output"]
          +

          Returns arg is RefinedOutput

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      check: ((arg) => boolean)
      +
        +
      • +
          +
        • (arg): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            arg: T[number]["_output"]
          +

          Returns boolean

      • +
    • +
      refinementData: IssueData | ((arg, ctx) => IssueData)
    +

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

+
+

safeParse

+
+
+

safeParseAsync

+
+
+

superRefine

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      RefinedOutput extends any

    +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => arg is RefinedOutput)
      +
        +
      • +
          +
        • (arg, ctx): arg is RefinedOutput
          • +
        • +
          +

          Parameters

          +
          +

          Returns arg is RefinedOutput

    +

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      refinement: ((arg, ctx) => void)
      +
        +
      • +
          +
        • (arg, ctx): void
          • +
        • +
          +

          Parameters

          +
          +

          Returns void

    +

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

+
+

transform

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      NewOut

    +
    +

    Parameters

    +
      +
    • +
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      +
        +
      • +
          +
        • (arg, ctx): NewOut | Promise<NewOut>
          • +
        • +
          +

          Parameters

          +
          +

          Returns NewOut | Promise<NewOut>

    +

    Returns ZodEffects<ZodUnion<T>, NewOut, T[number]["_input"]>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/enums/_internal_.CustomerStatus.html b/docs/enums/_internal_.CustomerStatus.html new file mode 100644 index 0000000..97f38b2 --- /dev/null +++ b/docs/enums/_internal_.CustomerStatus.html @@ -0,0 +1,303 @@ +CustomerStatus | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Enumeration CustomerStatus

+
+

The core customer life cycle.

+
+
+
+
+ +
+
+

Enumeration Members

+
Active +Idle +Snoozed +
+
+

Enumeration Members

+
+

Active

+
Active: "ACTIVE"
+

The customer is currently either waiting for help or being helped, depending on if they're assigned to a user or not.

+
+
+

Idle

+
Idle: "IDLE"
+

The default status of a customer when they don't have any open issues. Any activity on their timeline will move them into ACTIVE.

+
+
+

Snoozed

+
Snoozed: "SNOOZED"
+

Indicates that a user is waiting for a customer to get back. Any activity on their timeline will move them into ACTIVE.

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/enums/_internal_.IssueStatus.html b/docs/enums/_internal_.IssueStatus.html new file mode 100644 index 0000000..4d7cc11 --- /dev/null +++ b/docs/enums/_internal_.IssueStatus.html @@ -0,0 +1,287 @@ +IssueStatus | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Enumeration IssueStatus

+
+
+
+ +
+
+

Enumeration Members

+
Open +Resolved +
+
+

Enumeration Members

+
+

Open

+
Open: "OPEN"
+
+

Resolved

+
Resolved: "RESOLVED"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/enums/_internal_.MutationErrorType.html b/docs/enums/_internal_.MutationErrorType.html new file mode 100644 index 0000000..0133f80 --- /dev/null +++ b/docs/enums/_internal_.MutationErrorType.html @@ -0,0 +1,303 @@ +MutationErrorType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Enumeration MutationErrorType

+
+

An enum for why the mutation failed overall.

+
+
+
+
+ +
+
+

Enumeration Members

+
Forbidden +Internal +Validation +
+
+

Enumeration Members

+
+

Forbidden

+
Forbidden: "FORBIDDEN"
+

The user is not authorized to do this mutation. See message for details on which permissions are missing.

+
+
+

Internal

+
Internal: "INTERNAL"
+

An unknown internal server error occurred. Retry the mutation and if it persists, please email help@plain.com

+
+
+

Validation

+
Validation: "VALIDATION"
+

Input validation failed, see the fields for details on why the input was invalid.

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/enums/_internal_.MutationFieldErrorType.html b/docs/enums/_internal_.MutationFieldErrorType.html new file mode 100644 index 0000000..a5e848c --- /dev/null +++ b/docs/enums/_internal_.MutationFieldErrorType.html @@ -0,0 +1,303 @@ +MutationFieldErrorType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Enumeration MutationFieldErrorType

+
+

An enum specific to each field, explaining why validation failed.

+
+
+
+
+ +
+
+

Enumeration Members

+
NotFound +Required +Validation +
+
+

Enumeration Members

+
+

NotFound

+
NotFound: "NOT_FOUND"
+

The input field referenced an entity that wasn't found.

+
+
+

Required

+
Required: "REQUIRED"
+

The field is required to be provided. String inputs may be trimmed and checked for emptiness.

+
+
+

Validation

+
Validation: "VALIDATION"
+

The field was provided, but didn't pass the requirements of the field. See message for details on why.

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/_internal_.DIRTY-1.html b/docs/functions/_internal_.DIRTY-1.html new file mode 100644 index 0000000..128f375 --- /dev/null +++ b/docs/functions/_internal_.DIRTY-1.html @@ -0,0 +1,274 @@ +DIRTY | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Function DIRTY

+
+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      value: T
    +

    Returns DIRTY<T>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/_internal_.OK-1.html b/docs/functions/_internal_.OK-1.html new file mode 100644 index 0000000..0f30438 --- /dev/null +++ b/docs/functions/_internal_.OK-1.html @@ -0,0 +1,274 @@ +OK | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Function OK

+
+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      value: T
    +

    Returns OK<T>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..7ae3234 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,272 @@ +@team-plain/typescript-sdk
+
+ +
+
+
+
+

@team-plain/typescript-sdk

+

@team-plain/typescript-sdk

This is the typescript/node SDK for Plain.com's Core GraphQL API. It makes it easy to make common API calls in just a few lines of code.

+

If you run into any issues please open an issue or get in touch with us at help@plain.com.

+

Basic example

import { PlainSDKClient } from "@team-plain/typescript-sdk"

const client = new PlainSDKClient({
  apiKey: 'plainApiKey__tmRD_xF5qiMH0657LkbLCC1maN4hLsBIbyOgjqEP4w'
})

const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' });

if (result.error) {
  console.log(result.error);        
} else {
  console.log(result.data.fullName);
}
+
+

Creating an API key

You can find out how to make an API key in our documentation: https://docs.plain.com/core-api/authentication

+

Error handling

Calling methods on the client will not throw an error. This is so that we can have typed errors and make everything a bit more predic

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.CallSite.html b/docs/interfaces/_internal_.CallSite.html new file mode 100644 index 0000000..b0345a0 --- /dev/null +++ b/docs/interfaces/_internal_.CallSite.html @@ -0,0 +1,440 @@ +CallSite | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface CallSite

+
+

Hierarchy

+
    +
  • CallSite
+
+
+
+ +
+
+

Methods

+
getColumnNumber +getEvalOrigin +getFileName +getFunction +getFunctionName +getLineNumber +getMethodName +getThis +getTypeName +isConstructor +isEval +isNative +isToplevel +
+
+

Methods

+
+

getColumnNumber

+
    + +
  • +

    Current column number [if this function was defined in a script]

    +
    +

    Returns null | number

+
+

getEvalOrigin

+
    + +
  • +

    A call site object representing the location where eval was called +[if this function was created using a call to eval]

    +
    +

    Returns undefined | string

+
+

getFileName

+
    + +
  • +

    Name of the script [if this function was defined in a script]

    +
    +

    Returns undefined | string

+
+

getFunction

+
    + +
  • +

    Current function

    +
    +

    Returns undefined | Function

+
+

getFunctionName

+
    + +
  • +

    Name of the current function, typically its name property. +If a name property is not available an attempt will be made to try +to infer a name from the function's context.

    +
    +

    Returns null | string

+
+

getLineNumber

+
    + +
  • +

    Current line number [if this function was defined in a script]

    +
    +

    Returns null | number

+
+

getMethodName

+
    + +
  • +

    Name of the property [of "this" or one of its prototypes] that holds +the current function

    +
    +

    Returns null | string

+
+

getThis

+
    + +
  • +

    Value of "this"

    +
    +

    Returns unknown

+
+

getTypeName

+
    + +
  • +

    Type of "this" as a string. +This is the name of the function stored in the constructor field of +"this", if available. Otherwise the object's [[Class]] internal +property.

    +
    +

    Returns null | string

+
+

isConstructor

+
    + +
  • +

    Is this a constructor call?

    +
    +

    Returns boolean

+
+

isEval

+
    + +
  • +

    Does this call take place in code defined by a call to eval?

    +
    +

    Returns boolean

+
+

isNative

+
    + +
  • +

    Is this call in native V8 code?

    +
    +

    Returns boolean

+
+

isToplevel

+
    + +
  • +

    Is this a toplevel invocation, that is, is "this" the global object?

    +
    +

    Returns boolean

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ParseContext.html b/docs/interfaces/_internal_.ParseContext.html new file mode 100644 index 0000000..462183b --- /dev/null +++ b/docs/interfaces/_internal_.ParseContext.html @@ -0,0 +1,328 @@ +ParseContext | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ParseContext

+
+

Hierarchy

+
    +
  • ParseContext
+
+
+
+ +
+
+

Properties

+
common +data +parent +parsedType +path +schemaErrorMap? +
+
+

Properties

+
+

Readonly common

+
common: {
    async: boolean;
    contextualErrorMap?: ZodErrorMap;
    issues: ZodIssue[];
}
+
+

Type declaration

+
    +
  • +
    Readonly async: boolean
    • +
  • +
    Optional Readonly contextualErrorMap?: ZodErrorMap
    • +
  • +
    Readonly issues: ZodIssue[]
+
+

Readonly data

+
data: any
+
+

Readonly parent

+
parent: null | ParseContext
+
+

Readonly parsedType

+
parsedType: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
+
+

Readonly path

+
path: ParsePath
+
+

Optional Readonly schemaErrorMap

+
schemaErrorMap?: ZodErrorMap
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodArrayDef.html b/docs/interfaces/_internal_.ZodArrayDef.html new file mode 100644 index 0000000..5c563d3 --- /dev/null +++ b/docs/interfaces/_internal_.ZodArrayDef.html @@ -0,0 +1,335 @@ +ZodArrayDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodArrayDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +exactLength +maxLength +minLength +type +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

exactLength

+
exactLength: null | {
    message?: string;
    value: number;
}
+
+

maxLength

+
maxLength: null | {
    message?: string;
    value: number;
}
+
+

minLength

+
minLength: null | {
    message?: string;
    value: number;
}
+
+

type

+
type: T
+
+

typeName

+
typeName: ZodArray
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodBrandedDef.html b/docs/interfaces/_internal_.ZodBrandedDef.html new file mode 100644 index 0000000..b3db3d0 --- /dev/null +++ b/docs/interfaces/_internal_.ZodBrandedDef.html @@ -0,0 +1,314 @@ +ZodBrandedDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodBrandedDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +type +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

type

+
type: T
+
+

typeName

+
typeName: ZodBranded
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodCatchDef.html b/docs/interfaces/_internal_.ZodCatchDef.html new file mode 100644 index 0000000..8564ea0 --- /dev/null +++ b/docs/interfaces/_internal_.ZodCatchDef.html @@ -0,0 +1,339 @@ +ZodCatchDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodCatchDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
catchValue +description? +errorMap? +innerType +typeName +
+
+

Properties

+
+

catchValue

+
catchValue: ((ctx) => T["_input"])
+
+

Type declaration

+
    +
  • +
      +
    • (ctx): T["_input"]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        ctx: {
            error: ZodError<any>;
            input: unknown;
        }
        +
          +
        • +
          error: ZodError<any>
          • +
        • +
          input: unknown
      +

      Returns T["_input"]

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

innerType

+
innerType: T
+
+

typeName

+
typeName: ZodCatch
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodCustomIssue.html b/docs/interfaces/_internal_.ZodCustomIssue.html new file mode 100644 index 0000000..ecc7136 --- /dev/null +++ b/docs/interfaces/_internal_.ZodCustomIssue.html @@ -0,0 +1,314 @@ +ZodCustomIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodCustomIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +params? +path +
+
+

Properties

+
+

code

+
code: "custom"
+
+

Optional message

+
message?: string
+
+

Optional params

+
params?: {
    [k: string]: any;
}
+
+

Type declaration

+
    +
  • +
    [k: string]: any
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodDefaultDef.html b/docs/interfaces/_internal_.ZodDefaultDef.html new file mode 100644 index 0000000..aabfb3c --- /dev/null +++ b/docs/interfaces/_internal_.ZodDefaultDef.html @@ -0,0 +1,329 @@ +ZodDefaultDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodDefaultDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
defaultValue +description? +errorMap? +innerType +typeName +
+
+

Properties

+
+

defaultValue

+
defaultValue: (() => noUndefined<T["_input"]>)
+
+

Type declaration

+
+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

innerType

+
innerType: T
+
+

typeName

+
typeName: ZodDefault
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodEffectsDef.html b/docs/interfaces/_internal_.ZodEffectsDef.html new file mode 100644 index 0000000..1746a2c --- /dev/null +++ b/docs/interfaces/_internal_.ZodEffectsDef.html @@ -0,0 +1,321 @@ +ZodEffectsDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodEffectsDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +effect +errorMap? +schema +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

effect

+
effect: Effect<any>
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

schema

+
schema: T
+
+

typeName

+
typeName: ZodEffects
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodEnumDef.html b/docs/interfaces/_internal_.ZodEnumDef.html new file mode 100644 index 0000000..6282696 --- /dev/null +++ b/docs/interfaces/_internal_.ZodEnumDef.html @@ -0,0 +1,314 @@ +ZodEnumDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodEnumDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +typeName +values +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

typeName

+
typeName: ZodEnum
+
+

values

+
values: T
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodIntersectionDef.html b/docs/interfaces/_internal_.ZodIntersectionDef.html new file mode 100644 index 0000000..265d119 --- /dev/null +++ b/docs/interfaces/_internal_.ZodIntersectionDef.html @@ -0,0 +1,323 @@ +ZodIntersectionDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodIntersectionDef<T, U>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +left +right +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

left

+
left: T
+
+

right

+
right: U
+
+

typeName

+
typeName: ZodIntersection
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html b/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html new file mode 100644 index 0000000..6e77dfd --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html @@ -0,0 +1,309 @@ +ZodInvalidArgumentsIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidArgumentsIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
argumentsError +code +message? +path +
+
+

Properties

+
+

argumentsError

+
argumentsError: ZodError<any>
+
+

code

+
code: "invalid_arguments"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidDateIssue.html b/docs/interfaces/_internal_.ZodInvalidDateIssue.html new file mode 100644 index 0000000..93d97af --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidDateIssue.html @@ -0,0 +1,302 @@ +ZodInvalidDateIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidDateIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +
+
+

Properties

+
+

code

+
code: "invalid_date"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html b/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html new file mode 100644 index 0000000..d8bc7b2 --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html @@ -0,0 +1,316 @@ +ZodInvalidEnumValueIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidEnumValueIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +options +path +received +
+
+

Properties

+
+

code

+
code: "invalid_enum_value"
+
+

Optional message

+
message?: string
+
+

options

+
options: (string | number)[]
+
+

path

+
path: (string | number)[]
+
+

received

+
received: string | number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html b/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html new file mode 100644 index 0000000..11a39cd --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html @@ -0,0 +1,302 @@ +ZodInvalidIntersectionTypesIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidIntersectionTypesIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +
+
+

Properties

+
+

code

+
code: "invalid_intersection_types"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html b/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html new file mode 100644 index 0000000..e00f93d --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html @@ -0,0 +1,316 @@ +ZodInvalidLiteralIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidLiteralIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +expected +message? +path +received +
+
+

Properties

+
+

code

+
code: "invalid_literal"
+
+

expected

+
expected: unknown
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

received

+
received: unknown
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html b/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html new file mode 100644 index 0000000..399c056 --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html @@ -0,0 +1,309 @@ +ZodInvalidReturnTypeIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidReturnTypeIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +returnTypeError +
+
+

Properties

+
+

code

+
code: "invalid_return_type"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

returnTypeError

+
returnTypeError: ZodError<any>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidStringIssue.html b/docs/interfaces/_internal_.ZodInvalidStringIssue.html new file mode 100644 index 0000000..ce27fda --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidStringIssue.html @@ -0,0 +1,309 @@ +ZodInvalidStringIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidStringIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +validation +
+
+

Properties

+
+

code

+
code: "invalid_string"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

validation

+
validation: StringValidation
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidTypeIssue.html b/docs/interfaces/_internal_.ZodInvalidTypeIssue.html new file mode 100644 index 0000000..04b736a --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidTypeIssue.html @@ -0,0 +1,316 @@ +ZodInvalidTypeIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidTypeIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +expected +message? +path +received +
+
+

Properties

+
+

code

+
code: "invalid_type"
+
+

expected

+
expected: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

received

+
received: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html b/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html new file mode 100644 index 0000000..4b4d46a --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html @@ -0,0 +1,309 @@ +ZodInvalidUnionDiscriminatorIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidUnionDiscriminatorIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +options +path +
+
+

Properties

+
+

code

+
code: "invalid_union_discriminator"
+
+

Optional message

+
message?: string
+
+

options

+
options: Primitive[]
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidUnionIssue.html b/docs/interfaces/_internal_.ZodInvalidUnionIssue.html new file mode 100644 index 0000000..e4e28dc --- /dev/null +++ b/docs/interfaces/_internal_.ZodInvalidUnionIssue.html @@ -0,0 +1,309 @@ +ZodInvalidUnionIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodInvalidUnionIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +unionErrors +
+
+

Properties

+
+

code

+
code: "invalid_union"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

unionErrors

+
unionErrors: ZodError<any>[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNotFiniteIssue.html b/docs/interfaces/_internal_.ZodNotFiniteIssue.html new file mode 100644 index 0000000..cf9f3ed --- /dev/null +++ b/docs/interfaces/_internal_.ZodNotFiniteIssue.html @@ -0,0 +1,302 @@ +ZodNotFiniteIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodNotFiniteIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +path +
+
+

Properties

+
+

code

+
code: "not_finite"
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html b/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html new file mode 100644 index 0000000..00a4084 --- /dev/null +++ b/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html @@ -0,0 +1,309 @@ +ZodNotMultipleOfIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodNotMultipleOfIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +message? +multipleOf +path +
+
+

Properties

+
+

code

+
code: "not_multiple_of"
+
+

Optional message

+
message?: string
+
+

multipleOf

+
multipleOf: number | bigint
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNullableDef.html b/docs/interfaces/_internal_.ZodNullableDef.html new file mode 100644 index 0000000..8360d26 --- /dev/null +++ b/docs/interfaces/_internal_.ZodNullableDef.html @@ -0,0 +1,314 @@ +ZodNullableDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodNullableDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +innerType +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

innerType

+
innerType: T
+
+

typeName

+
typeName: ZodNullable
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNumberDef.html b/docs/interfaces/_internal_.ZodNumberDef.html new file mode 100644 index 0000000..9058d15 --- /dev/null +++ b/docs/interfaces/_internal_.ZodNumberDef.html @@ -0,0 +1,316 @@ +ZodNumberDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodNumberDef

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
checks +coerce +description? +errorMap? +typeName +
+
+

Properties

+
+

checks

+
checks: ZodNumberCheck[]
+
+

coerce

+
coerce: boolean
+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

typeName

+
typeName: ZodNumber
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodObjectDef.html b/docs/interfaces/_internal_.ZodObjectDef.html new file mode 100644 index 0000000..3b522bc --- /dev/null +++ b/docs/interfaces/_internal_.ZodObjectDef.html @@ -0,0 +1,340 @@ +ZodObjectDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodObjectDef<T, UnknownKeys, Catchall>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
catchall +description? +errorMap? +shape +typeName +unknownKeys +
+
+

Properties

+
+

catchall

+
catchall: Catchall
+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

shape

+
shape: (() => T)
+
+

Type declaration

+
    +
  • +
      +
    • (): T
      • +
    • +

      Returns T

+
+

typeName

+
typeName: ZodObject
+
+

unknownKeys

+
unknownKeys: UnknownKeys
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodOptionalDef.html b/docs/interfaces/_internal_.ZodOptionalDef.html new file mode 100644 index 0000000..13568b0 --- /dev/null +++ b/docs/interfaces/_internal_.ZodOptionalDef.html @@ -0,0 +1,314 @@ +ZodOptionalDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodOptionalDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +innerType +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

innerType

+
innerType: T
+
+

typeName

+
typeName: ZodOptional
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodPipelineDef.html b/docs/interfaces/_internal_.ZodPipelineDef.html new file mode 100644 index 0000000..7132840 --- /dev/null +++ b/docs/interfaces/_internal_.ZodPipelineDef.html @@ -0,0 +1,323 @@ +ZodPipelineDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodPipelineDef<A, B>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +in +out +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

in

+
in: A
+
+

out

+
out: B
+
+

typeName

+
typeName: ZodPipeline
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodPromiseDef.html b/docs/interfaces/_internal_.ZodPromiseDef.html new file mode 100644 index 0000000..7cb6929 --- /dev/null +++ b/docs/interfaces/_internal_.ZodPromiseDef.html @@ -0,0 +1,314 @@ +ZodPromiseDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodPromiseDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +type +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

type

+
type: T
+
+

typeName

+
typeName: ZodPromise
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodStringDef.html b/docs/interfaces/_internal_.ZodStringDef.html new file mode 100644 index 0000000..3c97382 --- /dev/null +++ b/docs/interfaces/_internal_.ZodStringDef.html @@ -0,0 +1,316 @@ +ZodStringDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodStringDef

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
checks +coerce +description? +errorMap? +typeName +
+
+

Properties

+
+

checks

+
checks: ZodStringCheck[]
+
+

coerce

+
coerce: boolean
+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

typeName

+
typeName: ZodString
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTooBigIssue.html b/docs/interfaces/_internal_.ZodTooBigIssue.html new file mode 100644 index 0000000..667700b --- /dev/null +++ b/docs/interfaces/_internal_.ZodTooBigIssue.html @@ -0,0 +1,330 @@ +ZodTooBigIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodTooBigIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +exact? +inclusive +maximum +message? +path +type +
+
+

Properties

+
+

code

+
code: "too_big"
+
+

Optional exact

+
exact?: boolean
+
+

inclusive

+
inclusive: boolean
+
+

maximum

+
maximum: number | bigint
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+

type

+
type: "string" | "number" | "bigint" | "date" | "array" | "set"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTooSmallIssue.html b/docs/interfaces/_internal_.ZodTooSmallIssue.html new file mode 100644 index 0000000..8510637 --- /dev/null +++ b/docs/interfaces/_internal_.ZodTooSmallIssue.html @@ -0,0 +1,330 @@ +ZodTooSmallIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodTooSmallIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +exact? +inclusive +message? +minimum +path +type +
+
+

Properties

+
+

code

+
code: "too_small"
+
+

Optional exact

+
exact?: boolean
+
+

inclusive

+
inclusive: boolean
+
+

Optional message

+
message?: string
+
+

minimum

+
minimum: number | bigint
+
+

path

+
path: (string | number)[]
+
+

type

+
type: "string" | "number" | "bigint" | "date" | "array" | "set"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTupleDef.html b/docs/interfaces/_internal_.ZodTupleDef.html new file mode 100644 index 0000000..191507d --- /dev/null +++ b/docs/interfaces/_internal_.ZodTupleDef.html @@ -0,0 +1,323 @@ +ZodTupleDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodTupleDef<T, Rest>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +items +rest +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

items

+
items: T
+
+

rest

+
rest: Rest
+
+

typeName

+
typeName: ZodTuple
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTypeDef.html b/docs/interfaces/_internal_.ZodTypeDef.html new file mode 100644 index 0000000..96c05b9 --- /dev/null +++ b/docs/interfaces/_internal_.ZodTypeDef.html @@ -0,0 +1,308 @@ +ZodTypeDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodTypeDef

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodUnionDef.html b/docs/interfaces/_internal_.ZodUnionDef.html new file mode 100644 index 0000000..f0cc9b2 --- /dev/null +++ b/docs/interfaces/_internal_.ZodUnionDef.html @@ -0,0 +1,314 @@ +ZodUnionDef | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodUnionDef<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
description? +errorMap? +options +typeName +
+
+

Properties

+
+

Optional description

+
description?: string
+
+

Optional errorMap

+
errorMap?: ZodErrorMap
+
+

options

+
options: T
+
+

typeName

+
typeName: ZodUnion
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html b/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html new file mode 100644 index 0000000..a0f1dc1 --- /dev/null +++ b/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html @@ -0,0 +1,309 @@ +ZodUnrecognizedKeysIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Interface ZodUnrecognizedKeysIssue

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
code +keys +message? +path +
+
+

Properties

+
+

code

+
code: "unrecognized_keys"
+
+

keys

+
keys: string[]
+
+

Optional message

+
message?: string
+
+

path

+
path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..9052077 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,280 @@ +@team-plain/typescript-sdk
+
+ +
+
+
+
+

@team-plain/typescript-sdk

+
+
+

Index

+
+

Modules

+
<internal> +
+
+

Classes

+
PlainSDKClient +
+
+

Type Aliases

+
Actor +Customer +CustomerActor +DateTime +DeletedCustomerActor +InternalActor +Issue +IssuePriority +IssueType +MachineUserActor +MutationError +SystemActor +UserActor +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/_internal_.html b/docs/modules/_internal_.html new file mode 100644 index 0000000..4a84f74 --- /dev/null +++ b/docs/modules/_internal_.html @@ -0,0 +1,584 @@ +<internal> | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Module <internal>

+
+
+
+ +
+
+

Enumerations

+
CustomerStatus +IssueStatus +MutationErrorType +MutationFieldErrorType +
+
+

Enumeration Members

+
ZodArray +ZodBranded +ZodCatch +ZodDefault +ZodEffects +ZodEnum +ZodIntersection +ZodNullable +ZodNumber +ZodObject +ZodOptional +ZodPipeline +ZodPromise +ZodString +ZodTuple +ZodUnion +
+
+

Classes

+
ParseStatus +ZodArray +ZodBranded +ZodCatch +ZodDefault +ZodEffects +ZodEnum +ZodError +ZodIntersection +ZodNullable +ZodNumber +ZodObject +ZodOptional +ZodPipeline +ZodPromise +ZodString +ZodTuple +ZodType +ZodUnion +
+
+

Interfaces

+
CallSite +ParseContext +ZodArrayDef +ZodBrandedDef +ZodCatchDef +ZodCustomIssue +ZodDefaultDef +ZodEffectsDef +ZodEnumDef +ZodIntersectionDef +ZodInvalidArgumentsIssue +ZodInvalidDateIssue +ZodInvalidEnumValueIssue +ZodInvalidIntersectionTypesIssue +ZodInvalidLiteralIssue +ZodInvalidReturnTypeIssue +ZodInvalidStringIssue +ZodInvalidTypeIssue +ZodInvalidUnionDiscriminatorIssue +ZodInvalidUnionIssue +ZodNotFiniteIssue +ZodNotMultipleOfIssue +ZodNullableDef +ZodNumberDef +ZodObjectDef +ZodOptionalDef +ZodPipelineDef +ZodPromiseDef +ZodStringDef +ZodTooBigIssue +ZodTooSmallIssue +ZodTupleDef +ZodTypeDef +ZodUnionDef +ZodUnrecognizedKeysIssue +
+
+

Type Aliases

+
ActorParts_CustomerActor_Fragment +ActorParts_DeletedCustomerActor_Fragment +ActorParts_MachineUserActor_Fragment +ActorParts_SystemActor_Fragment +ActorParts_UserActor_Fragment +ArrayCardinality +AssertArray +AsyncParseReturnType +BRAND +BadRequestError +CastToStringTuple +CatchallInput +CatchallOutput +Context +CreateIssueInput +CustomerGroupIdentifier +DIRTY +Data +DeepPartial +Effect +EmailAddressInput +EnumValues +Err +ErrMessage +ErrorMapCtx +Exact +Exclude +Extract +FilterEnum +ForbiddenError +GetUnionLast +INVALID +InputMaybe +InputTypeOfTuple +InputTypeOfTupleWithRest +InternalActorParts_CustomerActor_Fragment +InternalActorParts_DeletedCustomerActor_Fragment +InternalActorParts_MachineUserActor_Fragment +InternalActorParts_SystemActor_Fragment +InternalActorParts_UserActor_Fragment +InternalServerError +IpVersion +IssueData +Maybe +MutationError +NonNullable +OK +Omit +Omit +OmitKeys +OptionalStringInput +OutputTypeOfTuple +OutputTypeOfTupleWithRest +ParseInput +ParseParams +ParsePath +ParsePathComponent +ParseReturnType +Partial +PassthroughType +Pick +PlainGraphQLError +PlainSDKError +PreprocessEffect +Primitive +RawCreateParams +Readonly +Record +RefinementCtx +RefinementEffect +Required +Result +SDKResult +SafeParseError +SafeParseReturnType +SafeParseSuccess +Scalars +StringInput +StringValidation +SyncParseReturnType +TransformEffect +TypeOf +UnionToIntersectionFn +UnionToTuple +UnknownError +UnknownKeysParam +UpsertCustomerIdentifierInput +UpsertCustomerInput +UpsertCustomerOnCreateInput +UpsertCustomerOnUpdateInput +Values +Writeable +ZodErrorMap +ZodFormattedError +ZodIssue +ZodIssueBase +ZodIssueOptionalMessage +ZodNumberCheck +ZodRawShape +ZodStringCheck +ZodTupleItems +ZodTypeAny +ZodUnionOptions +addQuestionMarks +allKeys +arrayOutputType +baseObjectInputType +baseObjectOutputType +deoptional +flatten +identity +input +noUndefined +objectInputType +objectOutputType +output +recursiveZodFormattedError +requiredKeys +stripPath +typeToFlattenedError +typecast +
+
+

Variables

+
BRAND +INVALID +PlainGraphQLError +
+
+

Functions

+
DIRTY +OK +
+
+

Enumeration Members

+
+

ZodArray

+
ZodArray: "ZodArray"
+
+

ZodBranded

+
ZodBranded: "ZodBranded"
+
+

ZodCatch

+
ZodCatch: "ZodCatch"
+
+

ZodDefault

+
ZodDefault: "ZodDefault"
+
+

ZodEffects

+
ZodEffects: "ZodEffects"
+
+

ZodEnum

+
ZodEnum: "ZodEnum"
+
+

ZodIntersection

+
ZodIntersection: "ZodIntersection"
+
+

ZodNullable

+
ZodNullable: "ZodNullable"
+
+

ZodNumber

+
ZodNumber: "ZodNumber"
+
+

ZodObject

+
ZodObject: "ZodObject"
+
+

ZodOptional

+
ZodOptional: "ZodOptional"
+
+

ZodPipeline

+
ZodPipeline: "ZodPipeline"
+
+

ZodPromise

+
ZodPromise: "ZodPromise"
+
+

ZodString

+
ZodString: "ZodString"
+
+

ZodTuple

+
ZodTuple: "ZodTuple"
+
+

ZodUnion

+
ZodUnion: "ZodUnion"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Actor.html b/docs/types/Actor.html new file mode 100644 index 0000000..7a7cb23 --- /dev/null +++ b/docs/types/Actor.html @@ -0,0 +1,259 @@ +Actor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Actor

+
Actor: ActorParts_CustomerActor_Fragment | ActorParts_DeletedCustomerActor_Fragment | ActorParts_MachineUserActor_Fragment | ActorParts_SystemActor_Fragment | ActorParts_UserActor_Fragment
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Customer.html b/docs/types/Customer.html new file mode 100644 index 0000000..a1d3b30 --- /dev/null +++ b/docs/types/Customer.html @@ -0,0 +1,316 @@ +Customer | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Customer

+
Customer: {
    __typename: "Customer";
    assignedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    assignedToUser: {
        __typename: "UserActor";
        userId: string;
    } | null;
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    createdBy: {
        __typename?: "CustomerActor";
    } | {
        __typename?: "DeletedCustomerActor";
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
    email: {
        __typename?: "EmailAddress";
        email: string;
        isVerified: boolean;
        verifiedAt: {
            __typename: "DateTime";
            iso8601: string;
        } | null;
    };
    externalId: string | null;
    fullName: string;
    id: string;
    lastIdleAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    markedAsSpamAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    shortName: string | null;
    status: CustomerStatus;
    statusChangedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
}
+
+

Type declaration

+
    +
  • +
    __typename: "Customer"
    • +
  • +
    assignedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • +
  • +
    assignedToUser: {
        __typename: "UserActor";
        userId: string;
    } | null
    • +
  • +
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    +
      +
    • +
      __typename: "DateTime"
      • +
    • +
      iso8601: string
    • +
  • +
    createdBy: {
        __typename?: "CustomerActor";
    } | {
        __typename?: "DeletedCustomerActor";
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
    • +
  • +
    email: {
        __typename?: "EmailAddress";
        email: string;
        isVerified: boolean;
        verifiedAt: {
            __typename: "DateTime";
            iso8601: string;
        } | null;
    }
    +
      +
    • +
      Optional __typename?: "EmailAddress"
      • +
    • +
      email: string
      • +
    • +
      isVerified: boolean
      • +
    • +
      verifiedAt: {
          __typename: "DateTime";
          iso8601: string;
      } | null
    • +
  • +
    externalId: string | null
    • +
  • +
    fullName: string
    • +
  • +
    id: string
    • +
  • +
    lastIdleAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • +
  • +
    markedAsSpamAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • +
  • +
    shortName: string | null
    • +
  • +
    status: CustomerStatus
    • +
  • +
    statusChangedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    +
      +
    • +
      __typename: "DateTime"
      • +
    • +
      iso8601: string
    • +
  • +
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    +
      +
    • +
      __typename: "DateTime"
      • +
    • +
      iso8601: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/CustomerActor.html b/docs/types/CustomerActor.html new file mode 100644 index 0000000..1be9657 --- /dev/null +++ b/docs/types/CustomerActor.html @@ -0,0 +1,266 @@ +CustomerActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CustomerActor

+
CustomerActor: {
    __typename: "CustomerActor";
    customerId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "CustomerActor"
    • +
  • +
    customerId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/DateTime.html b/docs/types/DateTime.html new file mode 100644 index 0000000..9498e62 --- /dev/null +++ b/docs/types/DateTime.html @@ -0,0 +1,266 @@ +DateTime | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias DateTime

+
DateTime: {
    __typename: "DateTime";
    iso8601: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "DateTime"
    • +
  • +
    iso8601: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/DeletedCustomerActor.html b/docs/types/DeletedCustomerActor.html new file mode 100644 index 0000000..3b10a68 --- /dev/null +++ b/docs/types/DeletedCustomerActor.html @@ -0,0 +1,266 @@ +DeletedCustomerActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias DeletedCustomerActor

+
DeletedCustomerActor: {
    __typename: "DeletedCustomerActor";
    customerId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "DeletedCustomerActor"
    • +
  • +
    customerId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/InternalActor.html b/docs/types/InternalActor.html new file mode 100644 index 0000000..01fe8ac --- /dev/null +++ b/docs/types/InternalActor.html @@ -0,0 +1,259 @@ +InternalActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActor

+
InternalActor: InternalActorParts_CustomerActor_Fragment | InternalActorParts_DeletedCustomerActor_Fragment | InternalActorParts_MachineUserActor_Fragment | InternalActorParts_SystemActor_Fragment | InternalActorParts_UserActor_Fragment
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/Issue.html b/docs/types/Issue.html new file mode 100644 index 0000000..16e9cda --- /dev/null +++ b/docs/types/Issue.html @@ -0,0 +1,326 @@ +Issue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Issue

+
Issue: {
    __typename: "Issue";
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    createdBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
    customer: {
        __typename?: "Customer";
        id: string;
    };
    deletedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    id: string;
    issueKey: string;
    issueType: {
        __typename: "IssueType";
        defaultIssuePriority: {
            __typename: "IssuePriority";
            label: string;
            value: number;
        };
        id: string;
        isArchived: boolean;
        publicName: string;
    };
    priority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    };
    status: IssueStatus;
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    updatedBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
}
+
+

Type declaration

+
    +
  • +
    __typename: "Issue"
    • +
  • +
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    +
      +
    • +
      __typename: "DateTime"
      • +
    • +
      iso8601: string
    • +
  • +
    createdBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
    • +
  • +
    customer: {
        __typename?: "Customer";
        id: string;
    }
    +
      +
    • +
      Optional __typename?: "Customer"
      • +
    • +
      id: string
    • +
  • +
    deletedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • +
  • +
    id: string
    • +
  • +
    issueKey: string
    • +
  • +
    issueType: {
        __typename: "IssueType";
        defaultIssuePriority: {
            __typename: "IssuePriority";
            label: string;
            value: number;
        };
        id: string;
        isArchived: boolean;
        publicName: string;
    }
    +
      +
    • +
      __typename: "IssueType"
      • +
    • +
      defaultIssuePriority: {
          __typename: "IssuePriority";
          label: string;
          value: number;
      }
      +
        +
      • +
        __typename: "IssuePriority"
        • +
      • +
        label: string
        • +
      • +
        value: number
      • +
    • +
      id: string
      • +
    • +
      isArchived: boolean
      • +
    • +
      publicName: string
    • +
  • +
    priority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    }
    +
      +
    • +
      __typename: "IssuePriority"
      • +
    • +
      label: string
      • +
    • +
      value: number
    • +
  • +
    status: IssueStatus
    • +
  • +
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    +
      +
    • +
      __typename: "DateTime"
      • +
    • +
      iso8601: string
    • +
  • +
    updatedBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/IssuePriority.html b/docs/types/IssuePriority.html new file mode 100644 index 0000000..b5bdf3f --- /dev/null +++ b/docs/types/IssuePriority.html @@ -0,0 +1,268 @@ +IssuePriority | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias IssuePriority

+
IssuePriority: {
    __typename: "IssuePriority";
    label: string;
    value: number;
}
+
+

Type declaration

+
    +
  • +
    __typename: "IssuePriority"
    • +
  • +
    label: string
    • +
  • +
    value: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/IssueType.html b/docs/types/IssueType.html new file mode 100644 index 0000000..3002336 --- /dev/null +++ b/docs/types/IssueType.html @@ -0,0 +1,279 @@ +IssueType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias IssueType

+
IssueType: {
    __typename: "IssueType";
    defaultIssuePriority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    };
    id: string;
    isArchived: boolean;
    publicName: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "IssueType"
    • +
  • +
    defaultIssuePriority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    }
    +
      +
    • +
      __typename: "IssuePriority"
      • +
    • +
      label: string
      • +
    • +
      value: number
    • +
  • +
    id: string
    • +
  • +
    isArchived: boolean
    • +
  • +
    publicName: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/MachineUserActor.html b/docs/types/MachineUserActor.html new file mode 100644 index 0000000..638b520 --- /dev/null +++ b/docs/types/MachineUserActor.html @@ -0,0 +1,266 @@ +MachineUserActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias MachineUserActor

+
MachineUserActor: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "MachineUserActor"
    • +
  • +
    machineUserId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/MutationError.html b/docs/types/MutationError.html new file mode 100644 index 0000000..8f54ea2 --- /dev/null +++ b/docs/types/MutationError.html @@ -0,0 +1,272 @@ +MutationError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias MutationError

+
MutationError: {
    __typename: "MutationError";
    code: string;
    fields: {
        __typename?: "MutationFieldError";
        field: string;
        message: string;
        type: MutationFieldErrorType;
    }[];
    message: string;
    type: MutationErrorType;
}
+
+

Type declaration

+
    +
  • +
    __typename: "MutationError"
    • +
  • +
    code: string
    • +
  • +
    fields: {
        __typename?: "MutationFieldError";
        field: string;
        message: string;
        type: MutationFieldErrorType;
    }[]
    • +
  • +
    message: string
    • +
  • +
    type: MutationErrorType
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/SystemActor.html b/docs/types/SystemActor.html new file mode 100644 index 0000000..60a1a7e --- /dev/null +++ b/docs/types/SystemActor.html @@ -0,0 +1,266 @@ +SystemActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SystemActor

+
SystemActor: {
    __typename: "SystemActor";
    systemId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "SystemActor"
    • +
  • +
    systemId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/UserActor.html b/docs/types/UserActor.html new file mode 100644 index 0000000..8296b17 --- /dev/null +++ b/docs/types/UserActor.html @@ -0,0 +1,266 @@ +UserActor | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UserActor

+
UserActor: {
    __typename: "UserActor";
    userId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "UserActor"
    • +
  • +
    userId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html b/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html new file mode 100644 index 0000000..b63f48d --- /dev/null +++ b/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html @@ -0,0 +1,267 @@ +ActorParts_CustomerActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ActorParts_CustomerActor_Fragment

+
ActorParts_CustomerActor_Fragment: {
    __typename: "CustomerActor";
    customerId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "CustomerActor"
    • +
  • +
    customerId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html b/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html new file mode 100644 index 0000000..ee3c789 --- /dev/null +++ b/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html @@ -0,0 +1,267 @@ +ActorParts_DeletedCustomerActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ActorParts_DeletedCustomerActor_Fragment

+
ActorParts_DeletedCustomerActor_Fragment: {
    __typename: "DeletedCustomerActor";
    customerId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "DeletedCustomerActor"
    • +
  • +
    customerId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html b/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html new file mode 100644 index 0000000..0d95f86 --- /dev/null +++ b/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html @@ -0,0 +1,267 @@ +ActorParts_MachineUserActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ActorParts_MachineUserActor_Fragment

+
ActorParts_MachineUserActor_Fragment: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "MachineUserActor"
    • +
  • +
    machineUserId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_SystemActor_Fragment.html b/docs/types/_internal_.ActorParts_SystemActor_Fragment.html new file mode 100644 index 0000000..1ccd703 --- /dev/null +++ b/docs/types/_internal_.ActorParts_SystemActor_Fragment.html @@ -0,0 +1,267 @@ +ActorParts_SystemActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ActorParts_SystemActor_Fragment

+
ActorParts_SystemActor_Fragment: {
    __typename: "SystemActor";
    systemId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "SystemActor"
    • +
  • +
    systemId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_UserActor_Fragment.html b/docs/types/_internal_.ActorParts_UserActor_Fragment.html new file mode 100644 index 0000000..86cdf2b --- /dev/null +++ b/docs/types/_internal_.ActorParts_UserActor_Fragment.html @@ -0,0 +1,267 @@ +ActorParts_UserActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ActorParts_UserActor_Fragment

+
ActorParts_UserActor_Fragment: {
    __typename: "UserActor";
    userId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "UserActor"
    • +
  • +
    userId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ArrayCardinality.html b/docs/types/_internal_.ArrayCardinality.html new file mode 100644 index 0000000..7c866b6 --- /dev/null +++ b/docs/types/_internal_.ArrayCardinality.html @@ -0,0 +1,260 @@ +ArrayCardinality | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ArrayCardinality

+
ArrayCardinality: "many" | "atleastone"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.AssertArray.html b/docs/types/_internal_.AssertArray.html new file mode 100644 index 0000000..86d5dc2 --- /dev/null +++ b/docs/types/_internal_.AssertArray.html @@ -0,0 +1,265 @@ +AssertArray | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias AssertArray<T>

+
AssertArray<T>: T extends any[]
    ? T
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.AsyncParseReturnType.html b/docs/types/_internal_.AsyncParseReturnType.html new file mode 100644 index 0000000..38bcaaf --- /dev/null +++ b/docs/types/_internal_.AsyncParseReturnType.html @@ -0,0 +1,265 @@ +AsyncParseReturnType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias AsyncParseReturnType<T>

+
AsyncParseReturnType<T>: Promise<SyncParseReturnType<T>>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.BRAND.html b/docs/types/_internal_.BRAND.html new file mode 100644 index 0000000..184eccf --- /dev/null +++ b/docs/types/_internal_.BRAND.html @@ -0,0 +1,271 @@ +BRAND | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias BRAND<T>

+
BRAND<T>: {
    [BRAND]: {
        [k in T]: true
    };
}
+
+

Type Parameters

+
    +
  • +

    T extends string | number | symbol

+
+

Type declaration

+
    +
  • +
    [BRAND]: {
        [k in T]: true
    }
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.BadRequestError.html b/docs/types/_internal_.BadRequestError.html new file mode 100644 index 0000000..8c270f5 --- /dev/null +++ b/docs/types/_internal_.BadRequestError.html @@ -0,0 +1,269 @@ +BadRequestError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias BadRequestError

+
BadRequestError: {
    code: "bad_request";
    graphqlErrors: PlainGraphQLError[];
    message: string;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.CastToStringTuple.html b/docs/types/_internal_.CastToStringTuple.html new file mode 100644 index 0000000..0c09085 --- /dev/null +++ b/docs/types/_internal_.CastToStringTuple.html @@ -0,0 +1,265 @@ +CastToStringTuple | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CastToStringTuple<T>

+
CastToStringTuple<T>: T extends [string, ...string[]]
    ? T
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.CatchallInput.html b/docs/types/_internal_.CatchallInput.html new file mode 100644 index 0000000..d790271 --- /dev/null +++ b/docs/types/_internal_.CatchallInput.html @@ -0,0 +1,265 @@ +CatchallInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CatchallInput<T>

+
CatchallInput<T>: ZodTypeAny extends T
    ? unknown
    : {
        [k: string]: T["_input"];
    }
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.CatchallOutput.html b/docs/types/_internal_.CatchallOutput.html new file mode 100644 index 0000000..bd7147d --- /dev/null +++ b/docs/types/_internal_.CatchallOutput.html @@ -0,0 +1,265 @@ +CatchallOutput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CatchallOutput<T>

+
CatchallOutput<T>: ZodTypeAny extends T
    ? unknown
    : {
        [k: string]: T["_output"];
    }
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Context.html b/docs/types/_internal_.Context.html new file mode 100644 index 0000000..9d330df --- /dev/null +++ b/docs/types/_internal_.Context.html @@ -0,0 +1,265 @@ +Context | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Context

+
Context: {
    apiKey: string;
}
+
+

Type declaration

+
    +
  • +
    apiKey: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.CreateIssueInput.html b/docs/types/_internal_.CreateIssueInput.html new file mode 100644 index 0000000..0045cef --- /dev/null +++ b/docs/types/_internal_.CreateIssueInput.html @@ -0,0 +1,272 @@ +CreateIssueInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CreateIssueInput

+
CreateIssueInput: {
    customerId: Scalars["ID"];
    issueTypeId: Scalars["ID"];
    priorityValue: InputMaybe<Scalars["Int"]>;
}
+
+

Type declaration

+
    +
  • +
    customerId: Scalars["ID"]
    • +
  • +
    issueTypeId: Scalars["ID"]
    • +
  • +
    priorityValue: InputMaybe<Scalars["Int"]>
    +

    The priority value for this issue. Overrides the issue's issue type's default priority value.

    +

    Valid values are 0, 1, 2 and 3.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.CustomerGroupIdentifier.html b/docs/types/_internal_.CustomerGroupIdentifier.html new file mode 100644 index 0000000..f765197 --- /dev/null +++ b/docs/types/_internal_.CustomerGroupIdentifier.html @@ -0,0 +1,267 @@ +CustomerGroupIdentifier | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias CustomerGroupIdentifier

+
CustomerGroupIdentifier: {
    customerGroupId: InputMaybe<Scalars["ID"]>;
    customerGroupKey: InputMaybe<Scalars["String"]>;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.DIRTY.html b/docs/types/_internal_.DIRTY.html new file mode 100644 index 0000000..be76f0f --- /dev/null +++ b/docs/types/_internal_.DIRTY.html @@ -0,0 +1,273 @@ +DIRTY | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias DIRTY<T>

+
DIRTY<T>: {
    status: "dirty";
    value: T;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    status: "dirty"
    • +
  • +
    value: T
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Data.html b/docs/types/_internal_.Data.html new file mode 100644 index 0000000..a083ce3 --- /dev/null +++ b/docs/types/_internal_.Data.html @@ -0,0 +1,272 @@ +Data | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Data<T>

+
Data<T>: {
    data: T;
    error?: never;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    data: T
    • +
  • +
    Optional error?: never
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.DeepPartial.html b/docs/types/_internal_.DeepPartial.html new file mode 100644 index 0000000..8e96817 --- /dev/null +++ b/docs/types/_internal_.DeepPartial.html @@ -0,0 +1,265 @@ +DeepPartial | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias DeepPartial<T>

+
DeepPartial<T>: T extends ZodObject<ZodRawShape>
    ? ZodObject<{
        [k in keyof T["shape"]]: ZodOptional<DeepPartial<T["shape"][k]>>
    }, T["_def"]["unknownKeys"], T["_def"]["catchall"]>
    : T extends ZodArray<infer Type, infer Card>
        ? ZodArray<DeepPartial<Type>, Card>
        : T extends ZodOptional<infer Type>
            ? ZodOptional<DeepPartial<Type>>
            : T extends ZodNullable<infer Type>
                ? ZodNullable<DeepPartial<Type>>
                : T extends ZodTuple<infer Items>
                    ? {
                            [k in keyof Items]: Items[k] extends ZodTypeAny
                                ? DeepPartial<Items[k]>
                                : never
                        } extends infer PI
                        ? PI extends ZodTupleItems
                            ? ZodTuple<PI>
                            : never
                        : never
                    : T
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Effect.html b/docs/types/_internal_.Effect.html new file mode 100644 index 0000000..97e35d3 --- /dev/null +++ b/docs/types/_internal_.Effect.html @@ -0,0 +1,265 @@ +Effect | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Effect<T>

+
Effect<T>: RefinementEffect<T> | TransformEffect<T> | PreprocessEffect<T>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.EmailAddressInput.html b/docs/types/_internal_.EmailAddressInput.html new file mode 100644 index 0000000..4fa0312 --- /dev/null +++ b/docs/types/_internal_.EmailAddressInput.html @@ -0,0 +1,267 @@ +EmailAddressInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias EmailAddressInput

+
EmailAddressInput: {
    email: Scalars["String"];
    isVerified: Scalars["Boolean"];
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.EnumValues.html b/docs/types/_internal_.EnumValues.html new file mode 100644 index 0000000..c89db25 --- /dev/null +++ b/docs/types/_internal_.EnumValues.html @@ -0,0 +1,260 @@ +EnumValues | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias EnumValues

+
EnumValues: [string, ...string[]]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Err.html b/docs/types/_internal_.Err.html new file mode 100644 index 0000000..02d9b28 --- /dev/null +++ b/docs/types/_internal_.Err.html @@ -0,0 +1,272 @@ +Err | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Err<U>

+
Err<U>: {
    data?: never;
    error: U;
}
+
+

Type Parameters

+
    +
  • +

    U

+
+

Type declaration

+
    +
  • +
    Optional data?: never
    • +
  • +
    error: U
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ErrMessage.html b/docs/types/_internal_.ErrMessage.html new file mode 100644 index 0000000..ea38f86 --- /dev/null +++ b/docs/types/_internal_.ErrMessage.html @@ -0,0 +1,260 @@ +ErrMessage | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ErrMessage

+
ErrMessage: string | {
    message?: string;
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ErrorMapCtx.html b/docs/types/_internal_.ErrorMapCtx.html new file mode 100644 index 0000000..b32b91c --- /dev/null +++ b/docs/types/_internal_.ErrorMapCtx.html @@ -0,0 +1,267 @@ +ErrorMapCtx | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ErrorMapCtx

+
ErrorMapCtx: {
    data: any;
    defaultError: string;
}
+
+

Type declaration

+
    +
  • +
    data: any
    • +
  • +
    defaultError: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Exact.html b/docs/types/_internal_.Exact.html new file mode 100644 index 0000000..ac98539 --- /dev/null +++ b/docs/types/_internal_.Exact.html @@ -0,0 +1,265 @@ +Exact | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Exact<T>

+
Exact<T>: {
    [K in keyof T]: T[K]
}
+
+

Type Parameters

+
    +
  • +

    T extends {
        [key: string]: unknown;
    }

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Exclude.html b/docs/types/_internal_.Exclude.html new file mode 100644 index 0000000..f50c050 --- /dev/null +++ b/docs/types/_internal_.Exclude.html @@ -0,0 +1,269 @@ +Exclude | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Exclude<T, U>

+
Exclude<T, U>: T extends U
    ? never
    : T
+

Exclude from T those types that are assignable to U

+
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    U

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Extract.html b/docs/types/_internal_.Extract.html new file mode 100644 index 0000000..fd31c82 --- /dev/null +++ b/docs/types/_internal_.Extract.html @@ -0,0 +1,269 @@ +Extract | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Extract<T, U>

+
Extract<T, U>: T extends U
    ? T
    : never
+

Extract from T those types that are assignable to U

+
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    U

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.FilterEnum.html b/docs/types/_internal_.FilterEnum.html new file mode 100644 index 0000000..e2edf92 --- /dev/null +++ b/docs/types/_internal_.FilterEnum.html @@ -0,0 +1,267 @@ +FilterEnum | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias FilterEnum<Values, ToExclude>

+
FilterEnum<Values, ToExclude>: Values extends []
    ? []
    : Values extends [infer Head, ...(infer Rest)]
        ? Head extends ToExclude
            ? FilterEnum<Rest, ToExclude>
            : [Head, ...FilterEnum<Rest, ToExclude>]
        : never
+
+

Type Parameters

+
    +
  • +

    Values

    • +
  • +

    ToExclude

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ForbiddenError.html b/docs/types/_internal_.ForbiddenError.html new file mode 100644 index 0000000..8d844db --- /dev/null +++ b/docs/types/_internal_.ForbiddenError.html @@ -0,0 +1,267 @@ +ForbiddenError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ForbiddenError

+
ForbiddenError: {
    code: "forbidden";
    message: string;
}
+
+

Type declaration

+
    +
  • +
    code: "forbidden"
    • +
  • +
    message: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.GetUnionLast.html b/docs/types/_internal_.GetUnionLast.html new file mode 100644 index 0000000..42e4fe4 --- /dev/null +++ b/docs/types/_internal_.GetUnionLast.html @@ -0,0 +1,265 @@ +GetUnionLast | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias GetUnionLast<T>

+
GetUnionLast<T>: UnionToIntersectionFn<T> extends (() => infer Last)
    ? Last
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.INVALID.html b/docs/types/_internal_.INVALID.html new file mode 100644 index 0000000..e47d168 --- /dev/null +++ b/docs/types/_internal_.INVALID.html @@ -0,0 +1,266 @@ +INVALID | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias INVALID

+
INVALID: {
    status: "aborted";
}
+
+

Type declaration

+
    +
  • +
    status: "aborted"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InputMaybe.html b/docs/types/_internal_.InputMaybe.html new file mode 100644 index 0000000..3361339 --- /dev/null +++ b/docs/types/_internal_.InputMaybe.html @@ -0,0 +1,265 @@ +InputMaybe | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InputMaybe<T>

+
InputMaybe<T>: Maybe<T>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InputTypeOfTuple.html b/docs/types/_internal_.InputTypeOfTuple.html new file mode 100644 index 0000000..b2dbfb9 --- /dev/null +++ b/docs/types/_internal_.InputTypeOfTuple.html @@ -0,0 +1,265 @@ +InputTypeOfTuple | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InputTypeOfTuple<T>

+
InputTypeOfTuple<T>: AssertArray<{
    [k in keyof T]: T[k] extends ZodType<any, any>
        ? T[k]["_input"]
        : never
}>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InputTypeOfTupleWithRest.html b/docs/types/_internal_.InputTypeOfTupleWithRest.html new file mode 100644 index 0000000..990cef6 --- /dev/null +++ b/docs/types/_internal_.InputTypeOfTupleWithRest.html @@ -0,0 +1,267 @@ +InputTypeOfTupleWithRest | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InputTypeOfTupleWithRest<T, Rest>

+
InputTypeOfTupleWithRest<T, Rest>: Rest extends ZodTypeAny
    ? [...InputTypeOfTuple<T>, ...Rest["_input"][]]
    : InputTypeOfTuple<T>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html b/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html new file mode 100644 index 0000000..e8f2bcf --- /dev/null +++ b/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html @@ -0,0 +1,265 @@ +InternalActorParts_CustomerActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActorParts_CustomerActor_Fragment

+
InternalActorParts_CustomerActor_Fragment: {
    __typename?: "CustomerActor";
}
+
+

Type declaration

+
    +
  • +
    Optional __typename?: "CustomerActor"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html b/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html new file mode 100644 index 0000000..32d101a --- /dev/null +++ b/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html @@ -0,0 +1,265 @@ +InternalActorParts_DeletedCustomerActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActorParts_DeletedCustomerActor_Fragment

+
InternalActorParts_DeletedCustomerActor_Fragment: {
    __typename?: "DeletedCustomerActor";
}
+
+

Type declaration

+
    +
  • +
    Optional __typename?: "DeletedCustomerActor"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html b/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html new file mode 100644 index 0000000..b31c47a --- /dev/null +++ b/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html @@ -0,0 +1,267 @@ +InternalActorParts_MachineUserActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActorParts_MachineUserActor_Fragment

+
InternalActorParts_MachineUserActor_Fragment: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "MachineUserActor"
    • +
  • +
    machineUserId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html b/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html new file mode 100644 index 0000000..caf7fe0 --- /dev/null +++ b/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html @@ -0,0 +1,267 @@ +InternalActorParts_SystemActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActorParts_SystemActor_Fragment

+
InternalActorParts_SystemActor_Fragment: {
    __typename: "SystemActor";
    systemId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "SystemActor"
    • +
  • +
    systemId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html b/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html new file mode 100644 index 0000000..8b103e7 --- /dev/null +++ b/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html @@ -0,0 +1,267 @@ +InternalActorParts_UserActor_Fragment | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalActorParts_UserActor_Fragment

+
InternalActorParts_UserActor_Fragment: {
    __typename: "UserActor";
    userId: string;
}
+
+

Type declaration

+
    +
  • +
    __typename: "UserActor"
    • +
  • +
    userId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.InternalServerError.html b/docs/types/_internal_.InternalServerError.html new file mode 100644 index 0000000..2a60d15 --- /dev/null +++ b/docs/types/_internal_.InternalServerError.html @@ -0,0 +1,267 @@ +InternalServerError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias InternalServerError

+
InternalServerError: {
    code: "internal_server_error";
    message: string;
}
+
+

Type declaration

+
    +
  • +
    code: "internal_server_error"
    • +
  • +
    message: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.IpVersion.html b/docs/types/_internal_.IpVersion.html new file mode 100644 index 0000000..c42f0d3 --- /dev/null +++ b/docs/types/_internal_.IpVersion.html @@ -0,0 +1,260 @@ +IpVersion | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias IpVersion

+
IpVersion: "v4" | "v6"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.IssueData.html b/docs/types/_internal_.IssueData.html new file mode 100644 index 0000000..902b523 --- /dev/null +++ b/docs/types/_internal_.IssueData.html @@ -0,0 +1,260 @@ +IssueData | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias IssueData

+
IssueData: stripPath<ZodIssueOptionalMessage> & {
    fatal?: boolean;
    path?: (string | number)[];
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Maybe.html b/docs/types/_internal_.Maybe.html new file mode 100644 index 0000000..650d67e --- /dev/null +++ b/docs/types/_internal_.Maybe.html @@ -0,0 +1,265 @@ +Maybe | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Maybe<T>

+
Maybe<T>: T | null
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.MutationError.html b/docs/types/_internal_.MutationError.html new file mode 100644 index 0000000..56f99f2 --- /dev/null +++ b/docs/types/_internal_.MutationError.html @@ -0,0 +1,269 @@ +MutationError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias MutationError

+
MutationError: {
    code: "mutation_error";
    errorDetails: MutationError;
    message: string;
}
+
+

Type declaration

+
    +
  • +
    code: "mutation_error"
    • +
  • +
    errorDetails: MutationError
    • +
  • +
    message: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.NonNullable.html b/docs/types/_internal_.NonNullable.html new file mode 100644 index 0000000..3241724 --- /dev/null +++ b/docs/types/_internal_.NonNullable.html @@ -0,0 +1,267 @@ +NonNullable | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias NonNullable<T>

+
NonNullable<T>: T & {}
+

Exclude null and undefined from T

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.OK.html b/docs/types/_internal_.OK.html new file mode 100644 index 0000000..7b28601 --- /dev/null +++ b/docs/types/_internal_.OK.html @@ -0,0 +1,273 @@ +OK | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias OK<T>

+
OK<T>: {
    status: "valid";
    value: T;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    status: "valid"
    • +
  • +
    value: T
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Omit-1.html b/docs/types/_internal_.Omit-1.html new file mode 100644 index 0000000..140fe0e --- /dev/null +++ b/docs/types/_internal_.Omit-1.html @@ -0,0 +1,267 @@ +Omit | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Omit<T, K>

+
Omit<T, K>: Pick<T, Exclude<keyof T, K>>
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    K extends keyof T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Omit.html b/docs/types/_internal_.Omit.html new file mode 100644 index 0000000..05081a8 --- /dev/null +++ b/docs/types/_internal_.Omit.html @@ -0,0 +1,269 @@ +Omit | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Omit<T, K>

+
Omit<T, K>: Pick<T, Exclude<keyof T, K>>
+

Construct a type with the properties of T except for those in type K.

+
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    K extends keyof any

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.OmitKeys.html b/docs/types/_internal_.OmitKeys.html new file mode 100644 index 0000000..4e4f05b --- /dev/null +++ b/docs/types/_internal_.OmitKeys.html @@ -0,0 +1,267 @@ +OmitKeys | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias OmitKeys<T, K>

+
OmitKeys<T, K>: Pick<T, Exclude<keyof T, K>>
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    K extends string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.OptionalStringInput.html b/docs/types/_internal_.OptionalStringInput.html new file mode 100644 index 0000000..0375987 --- /dev/null +++ b/docs/types/_internal_.OptionalStringInput.html @@ -0,0 +1,265 @@ +OptionalStringInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias OptionalStringInput

+
OptionalStringInput: {
    value: InputMaybe<Scalars["String"]>;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.OutputTypeOfTuple.html b/docs/types/_internal_.OutputTypeOfTuple.html new file mode 100644 index 0000000..ba97012 --- /dev/null +++ b/docs/types/_internal_.OutputTypeOfTuple.html @@ -0,0 +1,265 @@ +OutputTypeOfTuple | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias OutputTypeOfTuple<T>

+
OutputTypeOfTuple<T>: AssertArray<{
    [k in keyof T]: T[k] extends ZodType<any, any>
        ? T[k]["_output"]
        : never
}>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.OutputTypeOfTupleWithRest.html b/docs/types/_internal_.OutputTypeOfTupleWithRest.html new file mode 100644 index 0000000..2f9e4f9 --- /dev/null +++ b/docs/types/_internal_.OutputTypeOfTupleWithRest.html @@ -0,0 +1,267 @@ +OutputTypeOfTupleWithRest | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias OutputTypeOfTupleWithRest<T, Rest>

+
OutputTypeOfTupleWithRest<T, Rest>: Rest extends ZodTypeAny
    ? [...OutputTypeOfTuple<T>, ...Rest["_output"][]]
    : OutputTypeOfTuple<T>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ParseInput.html b/docs/types/_internal_.ParseInput.html new file mode 100644 index 0000000..1ea45fe --- /dev/null +++ b/docs/types/_internal_.ParseInput.html @@ -0,0 +1,269 @@ +ParseInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ParseInput

+
ParseInput: {
    data: any;
    parent: ParseContext;
    path: (string | number)[];
}
+
+

Type declaration

+
    +
  • +
    data: any
    • +
  • +
    parent: ParseContext
    • +
  • +
    path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ParseParams.html b/docs/types/_internal_.ParseParams.html new file mode 100644 index 0000000..c8e7463 --- /dev/null +++ b/docs/types/_internal_.ParseParams.html @@ -0,0 +1,269 @@ +ParseParams | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ParseParams

+
ParseParams: {
    async: boolean;
    errorMap: ZodErrorMap;
    path: (string | number)[];
}
+
+

Type declaration

+
    +
  • +
    async: boolean
    • +
  • +
    errorMap: ZodErrorMap
    • +
  • +
    path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ParsePath.html b/docs/types/_internal_.ParsePath.html new file mode 100644 index 0000000..0153a37 --- /dev/null +++ b/docs/types/_internal_.ParsePath.html @@ -0,0 +1,260 @@ +ParsePath | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ParsePath

+
ParsePath: ParsePathComponent[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ParsePathComponent.html b/docs/types/_internal_.ParsePathComponent.html new file mode 100644 index 0000000..b39a286 --- /dev/null +++ b/docs/types/_internal_.ParsePathComponent.html @@ -0,0 +1,260 @@ +ParsePathComponent | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ParsePathComponent

+
ParsePathComponent: string | number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ParseReturnType.html b/docs/types/_internal_.ParseReturnType.html new file mode 100644 index 0000000..d924a08 --- /dev/null +++ b/docs/types/_internal_.ParseReturnType.html @@ -0,0 +1,265 @@ +ParseReturnType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ParseReturnType<T>

+
ParseReturnType<T>: SyncParseReturnType<T> | AsyncParseReturnType<T>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Partial.html b/docs/types/_internal_.Partial.html new file mode 100644 index 0000000..66dabf8 --- /dev/null +++ b/docs/types/_internal_.Partial.html @@ -0,0 +1,267 @@ +Partial | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Partial<T>

+
Partial<T>: {
    [P in keyof T]?: T[P]
}
+

Make all properties in T optional

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.PassthroughType.html b/docs/types/_internal_.PassthroughType.html new file mode 100644 index 0000000..af81918 --- /dev/null +++ b/docs/types/_internal_.PassthroughType.html @@ -0,0 +1,265 @@ +PassthroughType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias PassthroughType<T>

+
PassthroughType<T>: T extends "passthrough"
    ? {
        [k: string]: unknown;
    }
    : unknown
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Pick.html b/docs/types/_internal_.Pick.html new file mode 100644 index 0000000..cc4d3ef --- /dev/null +++ b/docs/types/_internal_.Pick.html @@ -0,0 +1,269 @@ +Pick | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Pick<T, K>

+
Pick<T, K>: {
    [P in K]: T[P]
}
+

From T, pick a set of properties whose keys are in the union K

+
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    K extends keyof T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.PlainGraphQLError.html b/docs/types/_internal_.PlainGraphQLError.html new file mode 100644 index 0000000..d9792c0 --- /dev/null +++ b/docs/types/_internal_.PlainGraphQLError.html @@ -0,0 +1,261 @@ +PlainGraphQLError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias PlainGraphQLError

+
PlainGraphQLError: TypeOf<typeof PlainGraphQLError>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.PlainSDKError.html b/docs/types/_internal_.PlainSDKError.html new file mode 100644 index 0000000..6ff32c5 --- /dev/null +++ b/docs/types/_internal_.PlainSDKError.html @@ -0,0 +1,260 @@ +PlainSDKError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias PlainSDKError

+
PlainSDKError: ForbiddenError | BadRequestError | InternalServerError | MutationError | UnknownError
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.PreprocessEffect.html b/docs/types/_internal_.PreprocessEffect.html new file mode 100644 index 0000000..704765d --- /dev/null +++ b/docs/types/_internal_.PreprocessEffect.html @@ -0,0 +1,283 @@ +PreprocessEffect | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias PreprocessEffect<T>

+
PreprocessEffect<T>: {
    transform: ((arg) => any);
    type: "preprocess";
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    transform: ((arg) => any)
    +
      +
    • +
        +
      • (arg): any
        • +
      • +
        +

        Parameters

        +
          +
        • +
          arg: T
        +

        Returns any

    • +
  • +
    type: "preprocess"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Primitive.html b/docs/types/_internal_.Primitive.html new file mode 100644 index 0000000..c8e09ea --- /dev/null +++ b/docs/types/_internal_.Primitive.html @@ -0,0 +1,260 @@ +Primitive | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Primitive

+
Primitive: string | number | symbol | bigint | boolean | null | undefined
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.RawCreateParams.html b/docs/types/_internal_.RawCreateParams.html new file mode 100644 index 0000000..946ba7d --- /dev/null +++ b/docs/types/_internal_.RawCreateParams.html @@ -0,0 +1,260 @@ +RawCreateParams | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias RawCreateParams

+
RawCreateParams: {
    description?: string;
    errorMap?: ZodErrorMap;
    invalid_type_error?: string;
    required_error?: string;
} | undefined
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Readonly.html b/docs/types/_internal_.Readonly.html new file mode 100644 index 0000000..3c6221e --- /dev/null +++ b/docs/types/_internal_.Readonly.html @@ -0,0 +1,267 @@ +Readonly | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Readonly<T>

+
Readonly<T>: {
    readonly [P in keyof T]: T[P]
}
+

Make all properties in T readonly

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Record.html b/docs/types/_internal_.Record.html new file mode 100644 index 0000000..8f161cf --- /dev/null +++ b/docs/types/_internal_.Record.html @@ -0,0 +1,269 @@ +Record | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Record<K, T>

+
Record<K, T>: {
    [P in K]: T
}
+

Construct a type with a set of properties K of type T

+
+
+

Type Parameters

+
    +
  • +

    K extends keyof any

    • +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.RefinementCtx.html b/docs/types/_internal_.RefinementCtx.html new file mode 100644 index 0000000..3f08372 --- /dev/null +++ b/docs/types/_internal_.RefinementCtx.html @@ -0,0 +1,278 @@ +RefinementCtx | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias RefinementCtx

+
RefinementCtx: {
    addIssue: ((arg) => void);
    path: (string | number)[];
}
+
+

Type declaration

+
    +
  • +
    addIssue: ((arg) => void)
    +
      +
    • +
        +
      • (arg): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    • +
  • +
    path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.RefinementEffect.html b/docs/types/_internal_.RefinementEffect.html new file mode 100644 index 0000000..214d360 --- /dev/null +++ b/docs/types/_internal_.RefinementEffect.html @@ -0,0 +1,285 @@ +RefinementEffect | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias RefinementEffect<T>

+
RefinementEffect<T>: {
    refinement: ((arg, ctx) => any);
    type: "refinement";
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    refinement: ((arg, ctx) => any)
    +
      +
    • +
        +
      • (arg, ctx): any
        • +
      • +
        +

        Parameters

        +
        +

        Returns any

    • +
  • +
    type: "refinement"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Required.html b/docs/types/_internal_.Required.html new file mode 100644 index 0000000..157bba8 --- /dev/null +++ b/docs/types/_internal_.Required.html @@ -0,0 +1,267 @@ +Required | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Required<T>

+
Required<T>: {
    [P in keyof T]-?: T[P]
}
+

Make all properties in T required

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Result.html b/docs/types/_internal_.Result.html new file mode 100644 index 0000000..6e688db --- /dev/null +++ b/docs/types/_internal_.Result.html @@ -0,0 +1,267 @@ +Result | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Result<T, U>

+
Result<T, U>: NonNullable<Data<T> | Err<U>>
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    U

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.SDKResult.html b/docs/types/_internal_.SDKResult.html new file mode 100644 index 0000000..4a87409 --- /dev/null +++ b/docs/types/_internal_.SDKResult.html @@ -0,0 +1,265 @@ +SDKResult | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SDKResult<T>

+
SDKResult<T>: Promise<Result<T, PlainSDKError>>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseError.html b/docs/types/_internal_.SafeParseError.html new file mode 100644 index 0000000..d7c3f59 --- /dev/null +++ b/docs/types/_internal_.SafeParseError.html @@ -0,0 +1,272 @@ +SafeParseError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SafeParseError<Input>

+
SafeParseError<Input>: {
    error: ZodError<Input>;
    success: false;
}
+
+

Type Parameters

+
    +
  • +

    Input

+
+

Type declaration

+
    +
  • +
    error: ZodError<Input>
    • +
  • +
    success: false
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseReturnType.html b/docs/types/_internal_.SafeParseReturnType.html new file mode 100644 index 0000000..cf9b110 --- /dev/null +++ b/docs/types/_internal_.SafeParseReturnType.html @@ -0,0 +1,267 @@ +SafeParseReturnType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SafeParseReturnType<Input, Output>

+
SafeParseReturnType<Input, Output>: SafeParseSuccess<Output> | SafeParseError<Input>
+
+

Type Parameters

+
    +
  • +

    Input

    • +
  • +

    Output

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseSuccess.html b/docs/types/_internal_.SafeParseSuccess.html new file mode 100644 index 0000000..ee36d4f --- /dev/null +++ b/docs/types/_internal_.SafeParseSuccess.html @@ -0,0 +1,272 @@ +SafeParseSuccess | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SafeParseSuccess<Output>

+
SafeParseSuccess<Output>: {
    data: Output;
    success: true;
}
+
+

Type Parameters

+
    +
  • +

    Output

+
+

Type declaration

+
    +
  • +
    data: Output
    • +
  • +
    success: true
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Scalars.html b/docs/types/_internal_.Scalars.html new file mode 100644 index 0000000..1594d5a --- /dev/null +++ b/docs/types/_internal_.Scalars.html @@ -0,0 +1,275 @@ +Scalars | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Scalars

+
Scalars: {
    Boolean: boolean;
    Float: number;
    ID: string;
    Int: number;
    String: string;
}
+

All built-in and custom scalars, mapped to their actual values

+
+
+

Type declaration

+
    +
  • +
    Boolean: boolean
    • +
  • +
    Float: number
    • +
  • +
    ID: string
    • +
  • +
    Int: number
    • +
  • +
    String: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.StringInput.html b/docs/types/_internal_.StringInput.html new file mode 100644 index 0000000..3fd6b96 --- /dev/null +++ b/docs/types/_internal_.StringInput.html @@ -0,0 +1,265 @@ +StringInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias StringInput

+
StringInput: {
    value: Scalars["String"];
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.StringValidation.html b/docs/types/_internal_.StringValidation.html new file mode 100644 index 0000000..f891dea --- /dev/null +++ b/docs/types/_internal_.StringValidation.html @@ -0,0 +1,260 @@ +StringValidation | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias StringValidation

+
StringValidation: "email" | "url" | "emoji" | "uuid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "ip" | {
    includes: string;
    position?: number;
} | {
    startsWith: string;
} | {
    endsWith: string;
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.SyncParseReturnType.html b/docs/types/_internal_.SyncParseReturnType.html new file mode 100644 index 0000000..2cd7e2b --- /dev/null +++ b/docs/types/_internal_.SyncParseReturnType.html @@ -0,0 +1,265 @@ +SyncParseReturnType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias SyncParseReturnType<T>

+
SyncParseReturnType<T>: OK<T> | DIRTY<T> | INVALID
+
+

Type Parameters

+
    +
  • +

    T = any

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.TransformEffect.html b/docs/types/_internal_.TransformEffect.html new file mode 100644 index 0000000..d19efb8 --- /dev/null +++ b/docs/types/_internal_.TransformEffect.html @@ -0,0 +1,285 @@ +TransformEffect | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias TransformEffect<T>

+
TransformEffect<T>: {
    transform: ((arg, ctx) => any);
    type: "transform";
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    transform: ((arg, ctx) => any)
    +
      +
    • +
        +
      • (arg, ctx): any
        • +
      • +
        +

        Parameters

        +
        +

        Returns any

    • +
  • +
    type: "transform"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.TypeOf.html b/docs/types/_internal_.TypeOf.html new file mode 100644 index 0000000..4565855 --- /dev/null +++ b/docs/types/_internal_.TypeOf.html @@ -0,0 +1,265 @@ +TypeOf | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias TypeOf<T>

+
TypeOf<T>: T["_output"]
+
+

Type Parameters

+
    +
  • +

    T extends ZodType<any, any, any>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UnionToIntersectionFn.html b/docs/types/_internal_.UnionToIntersectionFn.html new file mode 100644 index 0000000..ce7ea88 --- /dev/null +++ b/docs/types/_internal_.UnionToIntersectionFn.html @@ -0,0 +1,265 @@ +UnionToIntersectionFn | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UnionToIntersectionFn<T>

+
UnionToIntersectionFn<T>: (T extends unknown
        ? ((k) => void)
        : never) extends ((k) => void)
    ? Intersection
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UnionToTuple.html b/docs/types/_internal_.UnionToTuple.html new file mode 100644 index 0000000..686e1f8 --- /dev/null +++ b/docs/types/_internal_.UnionToTuple.html @@ -0,0 +1,267 @@ +UnionToTuple | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UnionToTuple<T, Tuple>

+
UnionToTuple<T, Tuple>: [T] extends [never]
    ? Tuple
    : UnionToTuple<Exclude<T, GetUnionLast<T>>, [GetUnionLast<T>, ...Tuple]>
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    Tuple extends unknown[] = []

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UnknownError.html b/docs/types/_internal_.UnknownError.html new file mode 100644 index 0000000..5771c5a --- /dev/null +++ b/docs/types/_internal_.UnknownError.html @@ -0,0 +1,269 @@ +UnknownError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UnknownError

+
UnknownError: {
    code: "unknown";
    err?: unknown;
    message: string;
}
+
+

Type declaration

+
    +
  • +
    code: "unknown"
    • +
  • +
    Optional err?: unknown
    • +
  • +
    message: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UnknownKeysParam.html b/docs/types/_internal_.UnknownKeysParam.html new file mode 100644 index 0000000..2a016b9 --- /dev/null +++ b/docs/types/_internal_.UnknownKeysParam.html @@ -0,0 +1,260 @@ +UnknownKeysParam | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UnknownKeysParam

+
UnknownKeysParam: "passthrough" | "strict" | "strip"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerIdentifierInput.html b/docs/types/_internal_.UpsertCustomerIdentifierInput.html new file mode 100644 index 0000000..ad9aa88 --- /dev/null +++ b/docs/types/_internal_.UpsertCustomerIdentifierInput.html @@ -0,0 +1,269 @@ +UpsertCustomerIdentifierInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UpsertCustomerIdentifierInput

+
UpsertCustomerIdentifierInput: {
    customerId: InputMaybe<Scalars["ID"]>;
    emailAddress: InputMaybe<Scalars["String"]>;
    externalId: InputMaybe<Scalars["ID"]>;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerInput.html b/docs/types/_internal_.UpsertCustomerInput.html new file mode 100644 index 0000000..c444786 --- /dev/null +++ b/docs/types/_internal_.UpsertCustomerInput.html @@ -0,0 +1,269 @@ +UpsertCustomerInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UpsertCustomerInput

+
UpsertCustomerInput: {
    identifier: UpsertCustomerIdentifierInput;
    onCreate: UpsertCustomerOnCreateInput;
    onUpdate: UpsertCustomerOnUpdateInput;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerOnCreateInput.html b/docs/types/_internal_.UpsertCustomerOnCreateInput.html new file mode 100644 index 0000000..b98d69a --- /dev/null +++ b/docs/types/_internal_.UpsertCustomerOnCreateInput.html @@ -0,0 +1,273 @@ +UpsertCustomerOnCreateInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UpsertCustomerOnCreateInput

+
UpsertCustomerOnCreateInput: {
    customerGroupIdentifiers: InputMaybe<CustomerGroupIdentifier[]>;
    email: EmailAddressInput;
    externalId: InputMaybe<Scalars["ID"]>;
    fullName: Scalars["String"];
    shortName: InputMaybe<Scalars["String"]>;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerOnUpdateInput.html b/docs/types/_internal_.UpsertCustomerOnUpdateInput.html new file mode 100644 index 0000000..ac2a4df --- /dev/null +++ b/docs/types/_internal_.UpsertCustomerOnUpdateInput.html @@ -0,0 +1,271 @@ +UpsertCustomerOnUpdateInput | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias UpsertCustomerOnUpdateInput

+
UpsertCustomerOnUpdateInput: {
    email: InputMaybe<EmailAddressInput>;
    externalId: InputMaybe<OptionalStringInput>;
    fullName: InputMaybe<StringInput>;
    shortName: InputMaybe<OptionalStringInput>;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Values.html b/docs/types/_internal_.Values.html new file mode 100644 index 0000000..65d1d56 --- /dev/null +++ b/docs/types/_internal_.Values.html @@ -0,0 +1,265 @@ +Values | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Values<T>

+
Values<T>: {
    [k in T[number]]: k
}
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.Writeable.html b/docs/types/_internal_.Writeable.html new file mode 100644 index 0000000..eac05d9 --- /dev/null +++ b/docs/types/_internal_.Writeable.html @@ -0,0 +1,265 @@ +Writeable | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias Writeable<T>

+
Writeable<T>: {
    -readonly [P in keyof T]: T[P]
}
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodErrorMap.html b/docs/types/_internal_.ZodErrorMap.html new file mode 100644 index 0000000..c031940 --- /dev/null +++ b/docs/types/_internal_.ZodErrorMap.html @@ -0,0 +1,278 @@ +ZodErrorMap | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodErrorMap

+
ZodErrorMap: ((issue, _ctx) => {
    message: string;
})
+
+

Type declaration

+
    +
  • +
      +
    • (issue, _ctx): {
          message: string;
      }
      • +
    • +
      +

      Parameters

      +
      +

      Returns {
          message: string;
      }

      +
        +
      • +
        message: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodFormattedError.html b/docs/types/_internal_.ZodFormattedError.html new file mode 100644 index 0000000..baf55fe --- /dev/null +++ b/docs/types/_internal_.ZodFormattedError.html @@ -0,0 +1,267 @@ +ZodFormattedError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodFormattedError<T, U>

+
ZodFormattedError<T, U>: {
    _errors: U[];
} & recursiveZodFormattedError<NonNullable<T>>
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    U = string

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssue.html b/docs/types/_internal_.ZodIssue.html new file mode 100644 index 0000000..461a459 --- /dev/null +++ b/docs/types/_internal_.ZodIssue.html @@ -0,0 +1,260 @@ +ZodIssue | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodIssue

+
ZodIssue: ZodIssueOptionalMessage & {
    fatal?: boolean;
    message: string;
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssueBase.html b/docs/types/_internal_.ZodIssueBase.html new file mode 100644 index 0000000..28e7547 --- /dev/null +++ b/docs/types/_internal_.ZodIssueBase.html @@ -0,0 +1,267 @@ +ZodIssueBase | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodIssueBase

+
ZodIssueBase: {
    message?: string;
    path: (string | number)[];
}
+
+

Type declaration

+
    +
  • +
    Optional message?: string
    • +
  • +
    path: (string | number)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssueOptionalMessage.html b/docs/types/_internal_.ZodIssueOptionalMessage.html new file mode 100644 index 0000000..c96028e --- /dev/null +++ b/docs/types/_internal_.ZodIssueOptionalMessage.html @@ -0,0 +1,260 @@ +ZodIssueOptionalMessage | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodIssueOptionalMessage

+
ZodIssueOptionalMessage: ZodInvalidTypeIssue | ZodInvalidLiteralIssue | ZodUnrecognizedKeysIssue | ZodInvalidUnionIssue | ZodInvalidUnionDiscriminatorIssue | ZodInvalidEnumValueIssue | ZodInvalidArgumentsIssue | ZodInvalidReturnTypeIssue | ZodInvalidDateIssue | ZodInvalidStringIssue | ZodTooSmallIssue | ZodTooBigIssue | ZodInvalidIntersectionTypesIssue | ZodNotMultipleOfIssue | ZodNotFiniteIssue | ZodCustomIssue
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodNumberCheck.html b/docs/types/_internal_.ZodNumberCheck.html new file mode 100644 index 0000000..193f741 --- /dev/null +++ b/docs/types/_internal_.ZodNumberCheck.html @@ -0,0 +1,260 @@ +ZodNumberCheck | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodNumberCheck

+
ZodNumberCheck: {
    inclusive: boolean;
    kind: "min";
    message?: string;
    value: number;
} | {
    inclusive: boolean;
    kind: "max";
    message?: string;
    value: number;
} | {
    kind: "int";
    message?: string;
} | {
    kind: "multipleOf";
    message?: string;
    value: number;
} | {
    kind: "finite";
    message?: string;
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodRawShape.html b/docs/types/_internal_.ZodRawShape.html new file mode 100644 index 0000000..cf1ab80 --- /dev/null +++ b/docs/types/_internal_.ZodRawShape.html @@ -0,0 +1,265 @@ +ZodRawShape | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodRawShape

+
ZodRawShape: {
    [k: string]: ZodTypeAny;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodStringCheck.html b/docs/types/_internal_.ZodStringCheck.html new file mode 100644 index 0000000..4e20e7f --- /dev/null +++ b/docs/types/_internal_.ZodStringCheck.html @@ -0,0 +1,260 @@ +ZodStringCheck | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodStringCheck

+
ZodStringCheck: {
    kind: "min";
    message?: string;
    value: number;
} | {
    kind: "max";
    message?: string;
    value: number;
} | {
    kind: "length";
    message?: string;
    value: number;
} | {
    kind: "email";
    message?: string;
} | {
    kind: "url";
    message?: string;
} | {
    kind: "emoji";
    message?: string;
} | {
    kind: "uuid";
    message?: string;
} | {
    kind: "cuid";
    message?: string;
} | {
    kind: "includes";
    message?: string;
    position?: number;
    value: string;
} | {
    kind: "cuid2";
    message?: string;
} | {
    kind: "ulid";
    message?: string;
} | {
    kind: "startsWith";
    message?: string;
    value: string;
} | {
    kind: "endsWith";
    message?: string;
    value: string;
} | {
    kind: "regex";
    message?: string;
    regex: RegExp;
} | {
    kind: "trim";
    message?: string;
} | {
    kind: "toLowerCase";
    message?: string;
} | {
    kind: "toUpperCase";
    message?: string;
} | {
    kind: "datetime";
    message?: string;
    offset: boolean;
    precision: number | null;
} | {
    kind: "ip";
    message?: string;
    version?: IpVersion;
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodTupleItems.html b/docs/types/_internal_.ZodTupleItems.html new file mode 100644 index 0000000..619ffe7 --- /dev/null +++ b/docs/types/_internal_.ZodTupleItems.html @@ -0,0 +1,260 @@ +ZodTupleItems | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodTupleItems

+
ZodTupleItems: [ZodTypeAny, ...ZodTypeAny[]]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodTypeAny.html b/docs/types/_internal_.ZodTypeAny.html new file mode 100644 index 0000000..6be2e95 --- /dev/null +++ b/docs/types/_internal_.ZodTypeAny.html @@ -0,0 +1,260 @@ +ZodTypeAny | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodTypeAny

+
ZodTypeAny: ZodType<any, any, any>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.ZodUnionOptions.html b/docs/types/_internal_.ZodUnionOptions.html new file mode 100644 index 0000000..6a99d50 --- /dev/null +++ b/docs/types/_internal_.ZodUnionOptions.html @@ -0,0 +1,260 @@ +ZodUnionOptions | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias ZodUnionOptions

+
ZodUnionOptions: Readonly<[ZodTypeAny, ...ZodTypeAny[]]>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.addQuestionMarks.html b/docs/types/_internal_.addQuestionMarks.html new file mode 100644 index 0000000..44e2a28 --- /dev/null +++ b/docs/types/_internal_.addQuestionMarks.html @@ -0,0 +1,267 @@ +addQuestionMarks | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias addQuestionMarks<T, R>

+
addQuestionMarks<T, R>: Pick<Required<T>, R> & Partial<T>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.allKeys.html b/docs/types/_internal_.allKeys.html new file mode 100644 index 0000000..89db901 --- /dev/null +++ b/docs/types/_internal_.allKeys.html @@ -0,0 +1,265 @@ +allKeys | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias allKeys<T>

+
allKeys<T>: T extends any
    ? keyof T
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.arrayOutputType.html b/docs/types/_internal_.arrayOutputType.html new file mode 100644 index 0000000..b479bd4 --- /dev/null +++ b/docs/types/_internal_.arrayOutputType.html @@ -0,0 +1,267 @@ +arrayOutputType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias arrayOutputType<T, Cardinality>

+
arrayOutputType<T, Cardinality>: Cardinality extends "atleastone"
    ? [T["_output"], ...T["_output"][]]
    : T["_output"][]
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.baseObjectInputType.html b/docs/types/_internal_.baseObjectInputType.html new file mode 100644 index 0000000..a155ff1 --- /dev/null +++ b/docs/types/_internal_.baseObjectInputType.html @@ -0,0 +1,265 @@ +baseObjectInputType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias baseObjectInputType<Shape>

+
baseObjectInputType<Shape>: addQuestionMarks<{
    [k in keyof Shape]: Shape[k]["_input"]
}>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.baseObjectOutputType.html b/docs/types/_internal_.baseObjectOutputType.html new file mode 100644 index 0000000..4aa4d8b --- /dev/null +++ b/docs/types/_internal_.baseObjectOutputType.html @@ -0,0 +1,265 @@ +baseObjectOutputType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias baseObjectOutputType<Shape>

+
baseObjectOutputType<Shape>: {
    [k in keyof Shape]: Shape[k]["_output"]
}
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.deoptional.html b/docs/types/_internal_.deoptional.html new file mode 100644 index 0000000..5de4673 --- /dev/null +++ b/docs/types/_internal_.deoptional.html @@ -0,0 +1,265 @@ +deoptional | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias deoptional<T>

+
deoptional<T>: T extends ZodOptional<infer U>
    ? deoptional<U>
    : T extends ZodNullable<infer U>
        ? ZodNullable<deoptional<U>>
        : T
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.flatten.html b/docs/types/_internal_.flatten.html new file mode 100644 index 0000000..ef87c87 --- /dev/null +++ b/docs/types/_internal_.flatten.html @@ -0,0 +1,265 @@ +flatten | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias flatten<T>

+
flatten<T>: identity<{
    [k in keyof T]: T[k]
}>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.identity.html b/docs/types/_internal_.identity.html new file mode 100644 index 0000000..2a0a876 --- /dev/null +++ b/docs/types/_internal_.identity.html @@ -0,0 +1,265 @@ +identity | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias identity<T>

+
identity<T>: T
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.input.html b/docs/types/_internal_.input.html new file mode 100644 index 0000000..7e219d6 --- /dev/null +++ b/docs/types/_internal_.input.html @@ -0,0 +1,265 @@ +input | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias input<T>

+
input<T>: T["_input"]
+
+

Type Parameters

+
    +
  • +

    T extends ZodType<any, any, any>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.noUndefined.html b/docs/types/_internal_.noUndefined.html new file mode 100644 index 0000000..9725d24 --- /dev/null +++ b/docs/types/_internal_.noUndefined.html @@ -0,0 +1,265 @@ +noUndefined | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias noUndefined<T>

+
noUndefined<T>: T extends undefined
    ? never
    : T
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.objectInputType.html b/docs/types/_internal_.objectInputType.html new file mode 100644 index 0000000..23f7d30 --- /dev/null +++ b/docs/types/_internal_.objectInputType.html @@ -0,0 +1,269 @@ +objectInputType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias objectInputType<Shape, Catchall, UnknownKeys>

+
objectInputType<Shape, Catchall, UnknownKeys>: flatten<baseObjectInputType<Shape>> & CatchallInput<Catchall> & PassthroughType<UnknownKeys>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.objectOutputType.html b/docs/types/_internal_.objectOutputType.html new file mode 100644 index 0000000..91370b2 --- /dev/null +++ b/docs/types/_internal_.objectOutputType.html @@ -0,0 +1,269 @@ +objectOutputType | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias objectOutputType<Shape, Catchall, UnknownKeys>

+
objectOutputType<Shape, Catchall, UnknownKeys>: flatten<addQuestionMarks<baseObjectOutputType<Shape>>> & CatchallOutput<Catchall> & PassthroughType<UnknownKeys>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.output.html b/docs/types/_internal_.output.html new file mode 100644 index 0000000..0befaf7 --- /dev/null +++ b/docs/types/_internal_.output.html @@ -0,0 +1,265 @@ +output | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias output<T>

+
output<T>: T["_output"]
+
+

Type Parameters

+
    +
  • +

    T extends ZodType<any, any, any>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.recursiveZodFormattedError.html b/docs/types/_internal_.recursiveZodFormattedError.html new file mode 100644 index 0000000..1541152 --- /dev/null +++ b/docs/types/_internal_.recursiveZodFormattedError.html @@ -0,0 +1,265 @@ +recursiveZodFormattedError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias recursiveZodFormattedError<T>

+
recursiveZodFormattedError<T>: T extends [any, ...any[]]
    ? {
        [K in keyof T]?: ZodFormattedError<T[K]>
    }
    : T extends any[]
        ? {
            [k: number]: ZodFormattedError<T[number]>;
        }
        : T extends object
            ? {
                [K in keyof T]?: ZodFormattedError<T[K]>
            }
            : unknown
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.requiredKeys.html b/docs/types/_internal_.requiredKeys.html new file mode 100644 index 0000000..f118b66 --- /dev/null +++ b/docs/types/_internal_.requiredKeys.html @@ -0,0 +1,265 @@ +requiredKeys | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias requiredKeys<T>

+
requiredKeys<T>: {
    [k in keyof T]: undefined extends T[k]
        ? never
        : k
}[keyof T]
+
+

Type Parameters

+
    +
  • +

    T extends object

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.stripPath.html b/docs/types/_internal_.stripPath.html new file mode 100644 index 0000000..90d6ec3 --- /dev/null +++ b/docs/types/_internal_.stripPath.html @@ -0,0 +1,265 @@ +stripPath | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias stripPath<T>

+
stripPath<T>: T extends any
    ? OmitKeys<T, "path">
    : never
+
+

Type Parameters

+
    +
  • +

    T extends object

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.typeToFlattenedError.html b/docs/types/_internal_.typeToFlattenedError.html new file mode 100644 index 0000000..a465a5c --- /dev/null +++ b/docs/types/_internal_.typeToFlattenedError.html @@ -0,0 +1,274 @@ +typeToFlattenedError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias typeToFlattenedError<T, U>

+
typeToFlattenedError<T, U>: {
    fieldErrors: {
        [P in allKeys<T>]?: U[]
    };
    formErrors: U[];
}
+
+

Type Parameters

+
    +
  • +

    T

    • +
  • +

    U = string

+
+

Type declaration

+
    +
  • +
    fieldErrors: {
        [P in allKeys<T>]?: U[]
    }
    • +
  • +
    formErrors: U[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/_internal_.typecast.html b/docs/types/_internal_.typecast.html new file mode 100644 index 0000000..280abcc --- /dev/null +++ b/docs/types/_internal_.typecast.html @@ -0,0 +1,267 @@ +typecast | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Type alias typecast<A, T>

+
typecast<A, T>: A extends T
    ? A
    : never
+
+

Type Parameters

+
    +
  • +

    A

    • +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/_internal_.BRAND-1.html b/docs/variables/_internal_.BRAND-1.html new file mode 100644 index 0000000..70993b7 --- /dev/null +++ b/docs/variables/_internal_.BRAND-1.html @@ -0,0 +1,261 @@ +BRAND | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Variable BRANDConst

+
BRAND: unique symbol
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/_internal_.INVALID-1.html b/docs/variables/_internal_.INVALID-1.html new file mode 100644 index 0000000..bdd54df --- /dev/null +++ b/docs/variables/_internal_.INVALID-1.html @@ -0,0 +1,261 @@ +INVALID | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Variable INVALID

+
INVALID: INVALID
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/_internal_.PlainGraphQLError-1.html b/docs/variables/_internal_.PlainGraphQLError-1.html new file mode 100644 index 0000000..f23f303 --- /dev/null +++ b/docs/variables/_internal_.PlainGraphQLError-1.html @@ -0,0 +1,261 @@ +PlainGraphQLError | @team-plain/typescript-sdk
+
+ +
+
+
+
+ +

Variable PlainGraphQLErrorConst

+
PlainGraphQLError: ZodObject<{
    extensions: ZodObject<{
        code: ZodString;
    }, "strip", ZodTypeAny, {
        code: string;
    }, {
        code: string;
    }>;
    locations: ZodArray<ZodObject<{
        column: ZodNumber;
        line: ZodNumber;
    }, "strip", ZodTypeAny, {
        column: number;
        line: number;
    }, {
        column: number;
        line: number;
    }>, "many">;
    message: ZodString;
    path: ZodArray<ZodUnion<[ZodString, ZodNumber]>, "many">;
}, "strip", ZodTypeAny, {
    extensions: { code: string; };
    locations: ({ line: number; column: number; })[];
    message: string;
    path: (string | number)[];
}, {
    extensions: { code: string; };
    locations: ({ line: number; column: number; })[];
    message: string;
    path: (string | number)[];
}> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index aff9a05..b6df70d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@team-plain/typescript-sdk", - "version": "0.0.3", + "version": "0.0.7", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@team-plain/typescript-sdk", - "version": "0.0.3", + "version": "0.0.7", "license": "MIT", "dependencies": { "@graphql-typed-document-node/core": "^3.2.0", @@ -30,6 +30,8 @@ "rollup": "^3.21.5", "rollup-plugin-dts": "^5.3.0", "rollup-plugin-esbuild": "^5.0.0", + "typedoc": "^0.24.7", + "typedoc-plugin-missing-exports": "^2.0.0", "vitest": "^0.31.0" } }, @@ -3526,6 +3528,12 @@ "node": ">=8" } }, + "node_modules/ansi-sequence-parser": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz", + "integrity": "sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==", + "dev": true + }, "node_modules/ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", @@ -6715,6 +6723,12 @@ "yallist": "^3.0.2" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "node_modules/magic-string": { "version": "0.30.0", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.0.tgz", @@ -6748,6 +6762,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, "node_modules/md5-hex": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/md5-hex/-/md5-hex-3.0.1.tgz", @@ -8190,6 +8216,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/shiki": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.2.tgz", + "integrity": "sha512-ltSZlSLOuSY0M0Y75KA+ieRaZ0Trf5Wl3gutE7jzLuIcWxLp5i/uEnLoQWNvgKXQ5OMpGkJnVMRLAuzjc0LJ2A==", + "dev": true, + "dependencies": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "node_modules/side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -8876,6 +8914,60 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/typedoc": { + "version": "0.24.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.24.7.tgz", + "integrity": "sha512-zzfKDFIZADA+XRIp2rMzLe9xZ6pt12yQOhCr7cD7/PBTjhPmMyMvGrkZ2lPNJitg3Hj1SeiYFNzCsSDrlpxpKw==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.0", + "shiki": "^0.14.1" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 14.14" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x" + } + }, + "node_modules/typedoc-plugin-missing-exports": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-2.0.0.tgz", + "integrity": "sha512-t0QlKCm27/8DaheJkLo/gInSNjzBXgSciGhoLpL6sLyXZibm7SuwJtHvg4qXI2IjJfFBgW9mJvvszpoxMyB0TA==", + "dev": true, + "peerDependencies": { + "typedoc": "0.24.x" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.0.tgz", + "integrity": "sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/typescript": { "version": "5.0.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", @@ -9206,6 +9298,18 @@ } } }, + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "node_modules/wcwidth": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", @@ -12067,6 +12171,12 @@ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", "dev": true }, + "ansi-sequence-parser": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz", + "integrity": "sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==", + "dev": true + }, "ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", @@ -14428,6 +14538,12 @@ "yallist": "^3.0.2" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "magic-string": { "version": "0.30.0", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.0.tgz", @@ -14449,6 +14565,12 @@ "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", "dev": true }, + "marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true + }, "md5-hex": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/md5-hex/-/md5-hex-3.0.1.tgz", @@ -15493,6 +15615,18 @@ "integrity": "sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==", "dev": true }, + "shiki": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.2.tgz", + "integrity": "sha512-ltSZlSLOuSY0M0Y75KA+ieRaZ0Trf5Wl3gutE7jzLuIcWxLp5i/uEnLoQWNvgKXQ5OMpGkJnVMRLAuzjc0LJ2A==", + "dev": true, + "requires": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -16050,6 +16184,45 @@ "is-typed-array": "^1.1.9" } }, + "typedoc": { + "version": "0.24.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.24.7.tgz", + "integrity": "sha512-zzfKDFIZADA+XRIp2rMzLe9xZ6pt12yQOhCr7cD7/PBTjhPmMyMvGrkZ2lPNJitg3Hj1SeiYFNzCsSDrlpxpKw==", + "dev": true, + "requires": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.0", + "shiki": "^0.14.1" + }, + "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.0.tgz", + "integrity": "sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, + "typedoc-plugin-missing-exports": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-2.0.0.tgz", + "integrity": "sha512-t0QlKCm27/8DaheJkLo/gInSNjzBXgSciGhoLpL6sLyXZibm7SuwJtHvg4qXI2IjJfFBgW9mJvvszpoxMyB0TA==", + "dev": true, + "requires": {} + }, "typescript": { "version": "5.0.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", @@ -16234,6 +16407,18 @@ "why-is-node-running": "^2.2.2" } }, + "vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "wcwidth": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", diff --git a/package.json b/package.json index 8752b58..9b82380 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,9 @@ "typings": "dist/index.d.ts", "scripts": { "build": "rm -rf dist && rollup -c", - "codegen": "graphql-codegen", + "codegen": "npm run codegen:graphql && npm run codegen:docs", + "codegen:graphql": "graphql-codegen", + "codegen:docs": "typedoc --plugin typedoc-plugin-missing-exports src/index.ts", "typecheck": "tsc --noEmit", "lint": "eslint 'src/**/*.ts'", "test": "vitest", @@ -31,6 +33,8 @@ "rollup": "^3.21.5", "rollup-plugin-dts": "^5.3.0", "rollup-plugin-esbuild": "^5.0.0", + "typedoc": "^0.24.7", + "typedoc-plugin-missing-exports": "^2.0.0", "vitest": "^0.31.0" }, "dependencies": { diff --git a/src/client.ts b/src/client.ts index dc0dc94..5107a4a 100644 --- a/src/client.ts +++ b/src/client.ts @@ -57,6 +57,9 @@ export class PlainSDKClient { }); } + /** + * Get a customer by id + */ async getCustomerById(args: CustomerByIdQueryVariables): SDKResult { const res = await request(this.#ctx, { query: CustomerByIdDocument, diff --git a/src/error.ts b/src/error.ts index a7f7748..01979f4 100644 --- a/src/error.ts +++ b/src/error.ts @@ -3,33 +3,33 @@ import { MutationErrorPartsFragment } from './graphql/types'; /* 400 */ type BadRequestError = { - code: 'bad_request'; + type: 'bad_request'; message: string; graphqlErrors: PlainGraphQLError[]; }; /* 401 */ type ForbiddenError = { - code: 'forbidden'; + type: 'forbidden'; message: string; }; /* 500 */ type InternalServerError = { - code: 'internal_server_error'; + type: 'internal_server_error'; message: string; }; /* Unhandled/unexpected errors */ type UnknownError = { - code: 'unknown'; + type: 'unknown'; message: string; err?: unknown; }; /* Handled mutation errors */ type MutationError = { - code: 'mutation_error'; + type: 'mutation_error'; message: string; errorDetails: MutationErrorPartsFragment; }; diff --git a/src/request.ts b/src/request.ts index b73e508..159d73e 100644 --- a/src/request.ts +++ b/src/request.ts @@ -42,7 +42,7 @@ export async function request( if (mutationError) { return { error: { - code: 'mutation_error', + type: 'mutation_error', message: mutationError.message, errorDetails: mutationError, }, @@ -59,7 +59,7 @@ export async function request( if (err.response.status === 401) { return { error: { - code: 'forbidden', + type: 'forbidden', message: 'Authentication failed. Please check the provided API key.', }, }; @@ -68,7 +68,7 @@ export async function request( if (err.response.status === 400 && isPlainGraphQLResponse(err.response.data)) { return { error: { - code: 'bad_request', + type: 'bad_request', message: 'Missing or invalid arguments provided.', graphqlErrors: err.response.data.errors || [], }, @@ -78,7 +78,7 @@ export async function request( if (err.response.status === 500) { return { error: { - code: 'internal_server_error', + type: 'internal_server_error', message: 'Internal server error.', }, }; @@ -88,7 +88,7 @@ export async function request( if (err.request) { return { error: { - code: 'unknown', + type: 'unknown', message: err.message, }, }; @@ -98,7 +98,7 @@ export async function request( // Case 3: Something completely unhandled happened return { error: { - code: 'unknown', + type: 'unknown', message: 'Unknown error', err, }, diff --git a/src/tests/error-handling.test.ts b/src/tests/error-handling.test.ts index c240ace..c8da562 100644 --- a/src/tests/error-handling.test.ts +++ b/src/tests/error-handling.test.ts @@ -17,7 +17,7 @@ describe('error handling', () => { const result = await client.getCustomerById({ customerId: 'c_123' }); expect(result.error).toEqual({ - code: 'internal_server_error', + type: 'internal_server_error', message: 'Internal server error.', }); @@ -32,7 +32,7 @@ describe('error handling', () => { const result = await client.getCustomerById({ customerId: 'c_123' }); expect(result.error).toEqual({ - code: 'forbidden', + type: 'forbidden', message: expect.stringContaining('Authentication failed'), }); diff --git a/src/tests/mutation.test.ts b/src/tests/mutation.test.ts index ec99987..351fab8 100644 --- a/src/tests/mutation.test.ts +++ b/src/tests/mutation.test.ts @@ -118,7 +118,7 @@ describe('mutation test - create an issue', () => { const result = await client.createIssue({ customerId: '', issueTypeId: '', priorityValue: 1 }); const err: PlainSDKError = { - code: 'mutation_error', + type: 'mutation_error', message: 'There was a validation error.', errorDetails: graphqlError, }; diff --git a/src/tests/query.test.ts b/src/tests/query.test.ts index 1085fc1..6c4ef73 100644 --- a/src/tests/query.test.ts +++ b/src/tests/query.test.ts @@ -102,7 +102,7 @@ describe('query test - customer by id', () => { const result = await client.getCustomerById({} as any); const err: PlainSDKError = { - code: 'bad_request', + type: 'bad_request', message: 'Missing or invalid arguments provided.', graphqlErrors, }; diff --git a/src/tests/raw-request.test.ts b/src/tests/raw-request.test.ts index 1cf7b70..90e765e 100644 --- a/src/tests/raw-request.test.ts +++ b/src/tests/raw-request.test.ts @@ -66,7 +66,7 @@ describe('raw request', () => { }); const err: PlainSDKError = { - code: 'bad_request', + type: 'bad_request', message: 'Missing or invalid arguments provided.', graphqlErrors, }; From b78c1ece78959c8a92855754c732aef9a1e5b40b Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Fri, 12 May 2023 12:43:41 +0200 Subject: [PATCH 04/14] update attributes --- .gitattributes | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitattributes b/.gitattributes index eca3860..3aef92f 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,2 @@ src/graphql/types.ts linguist-generated=true -docs/* linguist-generated=true \ No newline at end of file +docs/**/* linguist-generated=true \ No newline at end of file From fd8dd2bceadc1370e22af4c30ec50d77da78e144 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Sat, 13 May 2023 11:57:06 +0200 Subject: [PATCH 05/14] remove docs from generated code --- .gitattributes | 3 +- .gitignore | 5 +- docs/.nojekyll | 1 - docs/assets/highlight.css | 71 - docs/assets/main.js | 58 - docs/assets/search.js | 1 - docs/assets/style.css | 1367 --------------- docs/classes/PlainSDKClient.html | 378 ---- docs/classes/_internal_.ParseStatus.html | 373 ---- docs/classes/_internal_.ZodArray-1.html | 1158 ------------- docs/classes/_internal_.ZodBranded-1.html | 1065 ------------ docs/classes/_internal_.ZodCatch-1.html | 1088 ------------ docs/classes/_internal_.ZodDefault-1.html | 1088 ------------ docs/classes/_internal_.ZodEffects-1.html | 1148 ------------ docs/classes/_internal_.ZodEnum-1.html | 1177 ------------- docs/classes/_internal_.ZodError.html | 589 ------- .../classes/_internal_.ZodIntersection-1.html | 1086 ------------ docs/classes/_internal_.ZodNullable-1.html | 1088 ------------ docs/classes/_internal_.ZodNumber-1.html | 1393 --------------- docs/classes/_internal_.ZodObject-1.html | 1457 ---------------- docs/classes/_internal_.ZodOptional-1.html | 1088 ------------ docs/classes/_internal_.ZodPipeline-1.html | 1079 ------------ docs/classes/_internal_.ZodPromise-1.html | 1088 ------------ docs/classes/_internal_.ZodString-1.html | 1534 ----------------- docs/classes/_internal_.ZodTuple-1.html | 1112 ------------ docs/classes/_internal_.ZodType.html | 1033 ----------- docs/classes/_internal_.ZodUnion-1.html | 1088 ------------ docs/enums/_internal_.CustomerStatus.html | 303 ---- docs/enums/_internal_.IssueStatus.html | 287 --- docs/enums/_internal_.MutationErrorType.html | 303 ---- .../_internal_.MutationFieldErrorType.html | 303 ---- docs/functions/_internal_.DIRTY-1.html | 274 --- docs/functions/_internal_.OK-1.html | 274 --- docs/index.html | 272 --- docs/interfaces/_internal_.CallSite.html | 440 ----- docs/interfaces/_internal_.ParseContext.html | 328 ---- docs/interfaces/_internal_.ZodArrayDef.html | 335 ---- docs/interfaces/_internal_.ZodBrandedDef.html | 314 ---- docs/interfaces/_internal_.ZodCatchDef.html | 339 ---- .../interfaces/_internal_.ZodCustomIssue.html | 314 ---- docs/interfaces/_internal_.ZodDefaultDef.html | 329 ---- docs/interfaces/_internal_.ZodEffectsDef.html | 321 ---- docs/interfaces/_internal_.ZodEnumDef.html | 314 ---- .../_internal_.ZodIntersectionDef.html | 323 ---- .../_internal_.ZodInvalidArgumentsIssue.html | 309 ---- .../_internal_.ZodInvalidDateIssue.html | 302 ---- .../_internal_.ZodInvalidEnumValueIssue.html | 316 ---- ...nal_.ZodInvalidIntersectionTypesIssue.html | 302 ---- .../_internal_.ZodInvalidLiteralIssue.html | 316 ---- .../_internal_.ZodInvalidReturnTypeIssue.html | 309 ---- .../_internal_.ZodInvalidStringIssue.html | 309 ---- .../_internal_.ZodInvalidTypeIssue.html | 316 ---- ...al_.ZodInvalidUnionDiscriminatorIssue.html | 309 ---- .../_internal_.ZodInvalidUnionIssue.html | 309 ---- .../_internal_.ZodNotFiniteIssue.html | 302 ---- .../_internal_.ZodNotMultipleOfIssue.html | 309 ---- .../interfaces/_internal_.ZodNullableDef.html | 314 ---- docs/interfaces/_internal_.ZodNumberDef.html | 316 ---- docs/interfaces/_internal_.ZodObjectDef.html | 340 ---- .../interfaces/_internal_.ZodOptionalDef.html | 314 ---- .../interfaces/_internal_.ZodPipelineDef.html | 323 ---- docs/interfaces/_internal_.ZodPromiseDef.html | 314 ---- docs/interfaces/_internal_.ZodStringDef.html | 316 ---- .../interfaces/_internal_.ZodTooBigIssue.html | 330 ---- .../_internal_.ZodTooSmallIssue.html | 330 ---- docs/interfaces/_internal_.ZodTupleDef.html | 323 ---- docs/interfaces/_internal_.ZodTypeDef.html | 308 ---- docs/interfaces/_internal_.ZodUnionDef.html | 314 ---- .../_internal_.ZodUnrecognizedKeysIssue.html | 309 ---- docs/modules.html | 280 --- docs/modules/_internal_.html | 584 ------- docs/types/Actor.html | 259 --- docs/types/Customer.html | 316 ---- docs/types/CustomerActor.html | 266 --- docs/types/DateTime.html | 266 --- docs/types/DeletedCustomerActor.html | 266 --- docs/types/InternalActor.html | 259 --- docs/types/Issue.html | 326 ---- docs/types/IssuePriority.html | 268 --- docs/types/IssueType.html | 279 --- docs/types/MachineUserActor.html | 266 --- docs/types/MutationError.html | 272 --- docs/types/SystemActor.html | 266 --- docs/types/UserActor.html | 266 --- ...al_.ActorParts_CustomerActor_Fragment.html | 267 --- ...orParts_DeletedCustomerActor_Fragment.html | 267 --- ....ActorParts_MachineUserActor_Fragment.html | 267 --- ...rnal_.ActorParts_SystemActor_Fragment.html | 267 --- ...ternal_.ActorParts_UserActor_Fragment.html | 267 --- docs/types/_internal_.ArrayCardinality.html | 260 --- docs/types/_internal_.AssertArray.html | 265 --- .../_internal_.AsyncParseReturnType.html | 265 --- docs/types/_internal_.BRAND.html | 271 --- docs/types/_internal_.BadRequestError.html | 269 --- docs/types/_internal_.CastToStringTuple.html | 265 --- docs/types/_internal_.CatchallInput.html | 265 --- docs/types/_internal_.CatchallOutput.html | 265 --- docs/types/_internal_.Context.html | 265 --- docs/types/_internal_.CreateIssueInput.html | 272 --- .../_internal_.CustomerGroupIdentifier.html | 267 --- docs/types/_internal_.DIRTY.html | 273 --- docs/types/_internal_.Data.html | 272 --- docs/types/_internal_.DeepPartial.html | 265 --- docs/types/_internal_.Effect.html | 265 --- docs/types/_internal_.EmailAddressInput.html | 267 --- docs/types/_internal_.EnumValues.html | 260 --- docs/types/_internal_.Err.html | 272 --- docs/types/_internal_.ErrMessage.html | 260 --- docs/types/_internal_.ErrorMapCtx.html | 267 --- docs/types/_internal_.Exact.html | 265 --- docs/types/_internal_.Exclude.html | 269 --- docs/types/_internal_.Extract.html | 269 --- docs/types/_internal_.FilterEnum.html | 267 --- docs/types/_internal_.ForbiddenError.html | 267 --- docs/types/_internal_.GetUnionLast.html | 265 --- docs/types/_internal_.INVALID.html | 266 --- docs/types/_internal_.InputMaybe.html | 265 --- docs/types/_internal_.InputTypeOfTuple.html | 265 --- .../_internal_.InputTypeOfTupleWithRest.html | 267 --- ...rnalActorParts_CustomerActor_Fragment.html | 265 --- ...orParts_DeletedCustomerActor_Fragment.html | 265 --- ...lActorParts_MachineUserActor_Fragment.html | 267 --- ...ternalActorParts_SystemActor_Fragment.html | 267 --- ...InternalActorParts_UserActor_Fragment.html | 267 --- .../types/_internal_.InternalServerError.html | 267 --- docs/types/_internal_.IpVersion.html | 260 --- docs/types/_internal_.IssueData.html | 260 --- docs/types/_internal_.Maybe.html | 265 --- docs/types/_internal_.MutationError.html | 269 --- docs/types/_internal_.NonNullable.html | 267 --- docs/types/_internal_.OK.html | 273 --- docs/types/_internal_.Omit-1.html | 267 --- docs/types/_internal_.Omit.html | 269 --- docs/types/_internal_.OmitKeys.html | 267 --- .../types/_internal_.OptionalStringInput.html | 265 --- docs/types/_internal_.OutputTypeOfTuple.html | 265 --- .../_internal_.OutputTypeOfTupleWithRest.html | 267 --- docs/types/_internal_.ParseInput.html | 269 --- docs/types/_internal_.ParseParams.html | 269 --- docs/types/_internal_.ParsePath.html | 260 --- docs/types/_internal_.ParsePathComponent.html | 260 --- docs/types/_internal_.ParseReturnType.html | 265 --- docs/types/_internal_.Partial.html | 267 --- docs/types/_internal_.PassthroughType.html | 265 --- docs/types/_internal_.Pick.html | 269 --- docs/types/_internal_.PlainGraphQLError.html | 261 --- docs/types/_internal_.PlainSDKError.html | 260 --- docs/types/_internal_.PreprocessEffect.html | 283 --- docs/types/_internal_.Primitive.html | 260 --- docs/types/_internal_.RawCreateParams.html | 260 --- docs/types/_internal_.Readonly.html | 267 --- docs/types/_internal_.Record.html | 269 --- docs/types/_internal_.RefinementCtx.html | 278 --- docs/types/_internal_.RefinementEffect.html | 285 --- docs/types/_internal_.Required.html | 267 --- docs/types/_internal_.Result.html | 267 --- docs/types/_internal_.SDKResult.html | 265 --- docs/types/_internal_.SafeParseError.html | 272 --- .../types/_internal_.SafeParseReturnType.html | 267 --- docs/types/_internal_.SafeParseSuccess.html | 272 --- docs/types/_internal_.Scalars.html | 275 --- docs/types/_internal_.StringInput.html | 265 --- docs/types/_internal_.StringValidation.html | 260 --- .../types/_internal_.SyncParseReturnType.html | 265 --- docs/types/_internal_.TransformEffect.html | 285 --- docs/types/_internal_.TypeOf.html | 265 --- .../_internal_.UnionToIntersectionFn.html | 265 --- docs/types/_internal_.UnionToTuple.html | 267 --- docs/types/_internal_.UnknownError.html | 269 --- docs/types/_internal_.UnknownKeysParam.html | 260 --- ...ternal_.UpsertCustomerIdentifierInput.html | 269 --- .../types/_internal_.UpsertCustomerInput.html | 269 --- ...internal_.UpsertCustomerOnCreateInput.html | 273 --- ...internal_.UpsertCustomerOnUpdateInput.html | 271 --- docs/types/_internal_.Values.html | 265 --- docs/types/_internal_.Writeable.html | 265 --- docs/types/_internal_.ZodErrorMap.html | 278 --- docs/types/_internal_.ZodFormattedError.html | 267 --- docs/types/_internal_.ZodIssue.html | 260 --- docs/types/_internal_.ZodIssueBase.html | 267 --- .../_internal_.ZodIssueOptionalMessage.html | 260 --- docs/types/_internal_.ZodNumberCheck.html | 260 --- docs/types/_internal_.ZodRawShape.html | 265 --- docs/types/_internal_.ZodStringCheck.html | 260 --- docs/types/_internal_.ZodTupleItems.html | 260 --- docs/types/_internal_.ZodTypeAny.html | 260 --- docs/types/_internal_.ZodUnionOptions.html | 260 --- docs/types/_internal_.addQuestionMarks.html | 267 --- docs/types/_internal_.allKeys.html | 265 --- docs/types/_internal_.arrayOutputType.html | 267 --- .../types/_internal_.baseObjectInputType.html | 265 --- .../_internal_.baseObjectOutputType.html | 265 --- docs/types/_internal_.deoptional.html | 265 --- docs/types/_internal_.flatten.html | 265 --- docs/types/_internal_.identity.html | 265 --- docs/types/_internal_.input.html | 265 --- docs/types/_internal_.noUndefined.html | 265 --- docs/types/_internal_.objectInputType.html | 269 --- docs/types/_internal_.objectOutputType.html | 269 --- docs/types/_internal_.output.html | 265 --- ..._internal_.recursiveZodFormattedError.html | 265 --- docs/types/_internal_.requiredKeys.html | 265 --- docs/types/_internal_.stripPath.html | 265 --- .../_internal_.typeToFlattenedError.html | 274 --- docs/types/_internal_.typecast.html | 267 --- docs/variables/_internal_.BRAND-1.html | 261 --- docs/variables/_internal_.INVALID-1.html | 261 --- .../_internal_.PlainGraphQLError-1.html | 261 --- package.json | 5 +- 209 files changed, 7 insertions(+), 73325 deletions(-) delete mode 100644 docs/.nojekyll delete mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/main.js delete mode 100644 docs/assets/search.js delete mode 100644 docs/assets/style.css delete mode 100644 docs/classes/PlainSDKClient.html delete mode 100644 docs/classes/_internal_.ParseStatus.html delete mode 100644 docs/classes/_internal_.ZodArray-1.html delete mode 100644 docs/classes/_internal_.ZodBranded-1.html delete mode 100644 docs/classes/_internal_.ZodCatch-1.html delete mode 100644 docs/classes/_internal_.ZodDefault-1.html delete mode 100644 docs/classes/_internal_.ZodEffects-1.html delete mode 100644 docs/classes/_internal_.ZodEnum-1.html delete mode 100644 docs/classes/_internal_.ZodError.html delete mode 100644 docs/classes/_internal_.ZodIntersection-1.html delete mode 100644 docs/classes/_internal_.ZodNullable-1.html delete mode 100644 docs/classes/_internal_.ZodNumber-1.html delete mode 100644 docs/classes/_internal_.ZodObject-1.html delete mode 100644 docs/classes/_internal_.ZodOptional-1.html delete mode 100644 docs/classes/_internal_.ZodPipeline-1.html delete mode 100644 docs/classes/_internal_.ZodPromise-1.html delete mode 100644 docs/classes/_internal_.ZodString-1.html delete mode 100644 docs/classes/_internal_.ZodTuple-1.html delete mode 100644 docs/classes/_internal_.ZodType.html delete mode 100644 docs/classes/_internal_.ZodUnion-1.html delete mode 100644 docs/enums/_internal_.CustomerStatus.html delete mode 100644 docs/enums/_internal_.IssueStatus.html delete mode 100644 docs/enums/_internal_.MutationErrorType.html delete mode 100644 docs/enums/_internal_.MutationFieldErrorType.html delete mode 100644 docs/functions/_internal_.DIRTY-1.html delete mode 100644 docs/functions/_internal_.OK-1.html delete mode 100644 docs/index.html delete mode 100644 docs/interfaces/_internal_.CallSite.html delete mode 100644 docs/interfaces/_internal_.ParseContext.html delete mode 100644 docs/interfaces/_internal_.ZodArrayDef.html delete mode 100644 docs/interfaces/_internal_.ZodBrandedDef.html delete mode 100644 docs/interfaces/_internal_.ZodCatchDef.html delete mode 100644 docs/interfaces/_internal_.ZodCustomIssue.html delete mode 100644 docs/interfaces/_internal_.ZodDefaultDef.html delete mode 100644 docs/interfaces/_internal_.ZodEffectsDef.html delete mode 100644 docs/interfaces/_internal_.ZodEnumDef.html delete mode 100644 docs/interfaces/_internal_.ZodIntersectionDef.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidDateIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidLiteralIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidStringIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidTypeIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html delete mode 100644 docs/interfaces/_internal_.ZodInvalidUnionIssue.html delete mode 100644 docs/interfaces/_internal_.ZodNotFiniteIssue.html delete mode 100644 docs/interfaces/_internal_.ZodNotMultipleOfIssue.html delete mode 100644 docs/interfaces/_internal_.ZodNullableDef.html delete mode 100644 docs/interfaces/_internal_.ZodNumberDef.html delete mode 100644 docs/interfaces/_internal_.ZodObjectDef.html delete mode 100644 docs/interfaces/_internal_.ZodOptionalDef.html delete mode 100644 docs/interfaces/_internal_.ZodPipelineDef.html delete mode 100644 docs/interfaces/_internal_.ZodPromiseDef.html delete mode 100644 docs/interfaces/_internal_.ZodStringDef.html delete mode 100644 docs/interfaces/_internal_.ZodTooBigIssue.html delete mode 100644 docs/interfaces/_internal_.ZodTooSmallIssue.html delete mode 100644 docs/interfaces/_internal_.ZodTupleDef.html delete mode 100644 docs/interfaces/_internal_.ZodTypeDef.html delete mode 100644 docs/interfaces/_internal_.ZodUnionDef.html delete mode 100644 docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html delete mode 100644 docs/modules.html delete mode 100644 docs/modules/_internal_.html delete mode 100644 docs/types/Actor.html delete mode 100644 docs/types/Customer.html delete mode 100644 docs/types/CustomerActor.html delete mode 100644 docs/types/DateTime.html delete mode 100644 docs/types/DeletedCustomerActor.html delete mode 100644 docs/types/InternalActor.html delete mode 100644 docs/types/Issue.html delete mode 100644 docs/types/IssuePriority.html delete mode 100644 docs/types/IssueType.html delete mode 100644 docs/types/MachineUserActor.html delete mode 100644 docs/types/MutationError.html delete mode 100644 docs/types/SystemActor.html delete mode 100644 docs/types/UserActor.html delete mode 100644 docs/types/_internal_.ActorParts_CustomerActor_Fragment.html delete mode 100644 docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html delete mode 100644 docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html delete mode 100644 docs/types/_internal_.ActorParts_SystemActor_Fragment.html delete mode 100644 docs/types/_internal_.ActorParts_UserActor_Fragment.html delete mode 100644 docs/types/_internal_.ArrayCardinality.html delete mode 100644 docs/types/_internal_.AssertArray.html delete mode 100644 docs/types/_internal_.AsyncParseReturnType.html delete mode 100644 docs/types/_internal_.BRAND.html delete mode 100644 docs/types/_internal_.BadRequestError.html delete mode 100644 docs/types/_internal_.CastToStringTuple.html delete mode 100644 docs/types/_internal_.CatchallInput.html delete mode 100644 docs/types/_internal_.CatchallOutput.html delete mode 100644 docs/types/_internal_.Context.html delete mode 100644 docs/types/_internal_.CreateIssueInput.html delete mode 100644 docs/types/_internal_.CustomerGroupIdentifier.html delete mode 100644 docs/types/_internal_.DIRTY.html delete mode 100644 docs/types/_internal_.Data.html delete mode 100644 docs/types/_internal_.DeepPartial.html delete mode 100644 docs/types/_internal_.Effect.html delete mode 100644 docs/types/_internal_.EmailAddressInput.html delete mode 100644 docs/types/_internal_.EnumValues.html delete mode 100644 docs/types/_internal_.Err.html delete mode 100644 docs/types/_internal_.ErrMessage.html delete mode 100644 docs/types/_internal_.ErrorMapCtx.html delete mode 100644 docs/types/_internal_.Exact.html delete mode 100644 docs/types/_internal_.Exclude.html delete mode 100644 docs/types/_internal_.Extract.html delete mode 100644 docs/types/_internal_.FilterEnum.html delete mode 100644 docs/types/_internal_.ForbiddenError.html delete mode 100644 docs/types/_internal_.GetUnionLast.html delete mode 100644 docs/types/_internal_.INVALID.html delete mode 100644 docs/types/_internal_.InputMaybe.html delete mode 100644 docs/types/_internal_.InputTypeOfTuple.html delete mode 100644 docs/types/_internal_.InputTypeOfTupleWithRest.html delete mode 100644 docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html delete mode 100644 docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html delete mode 100644 docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html delete mode 100644 docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html delete mode 100644 docs/types/_internal_.InternalActorParts_UserActor_Fragment.html delete mode 100644 docs/types/_internal_.InternalServerError.html delete mode 100644 docs/types/_internal_.IpVersion.html delete mode 100644 docs/types/_internal_.IssueData.html delete mode 100644 docs/types/_internal_.Maybe.html delete mode 100644 docs/types/_internal_.MutationError.html delete mode 100644 docs/types/_internal_.NonNullable.html delete mode 100644 docs/types/_internal_.OK.html delete mode 100644 docs/types/_internal_.Omit-1.html delete mode 100644 docs/types/_internal_.Omit.html delete mode 100644 docs/types/_internal_.OmitKeys.html delete mode 100644 docs/types/_internal_.OptionalStringInput.html delete mode 100644 docs/types/_internal_.OutputTypeOfTuple.html delete mode 100644 docs/types/_internal_.OutputTypeOfTupleWithRest.html delete mode 100644 docs/types/_internal_.ParseInput.html delete mode 100644 docs/types/_internal_.ParseParams.html delete mode 100644 docs/types/_internal_.ParsePath.html delete mode 100644 docs/types/_internal_.ParsePathComponent.html delete mode 100644 docs/types/_internal_.ParseReturnType.html delete mode 100644 docs/types/_internal_.Partial.html delete mode 100644 docs/types/_internal_.PassthroughType.html delete mode 100644 docs/types/_internal_.Pick.html delete mode 100644 docs/types/_internal_.PlainGraphQLError.html delete mode 100644 docs/types/_internal_.PlainSDKError.html delete mode 100644 docs/types/_internal_.PreprocessEffect.html delete mode 100644 docs/types/_internal_.Primitive.html delete mode 100644 docs/types/_internal_.RawCreateParams.html delete mode 100644 docs/types/_internal_.Readonly.html delete mode 100644 docs/types/_internal_.Record.html delete mode 100644 docs/types/_internal_.RefinementCtx.html delete mode 100644 docs/types/_internal_.RefinementEffect.html delete mode 100644 docs/types/_internal_.Required.html delete mode 100644 docs/types/_internal_.Result.html delete mode 100644 docs/types/_internal_.SDKResult.html delete mode 100644 docs/types/_internal_.SafeParseError.html delete mode 100644 docs/types/_internal_.SafeParseReturnType.html delete mode 100644 docs/types/_internal_.SafeParseSuccess.html delete mode 100644 docs/types/_internal_.Scalars.html delete mode 100644 docs/types/_internal_.StringInput.html delete mode 100644 docs/types/_internal_.StringValidation.html delete mode 100644 docs/types/_internal_.SyncParseReturnType.html delete mode 100644 docs/types/_internal_.TransformEffect.html delete mode 100644 docs/types/_internal_.TypeOf.html delete mode 100644 docs/types/_internal_.UnionToIntersectionFn.html delete mode 100644 docs/types/_internal_.UnionToTuple.html delete mode 100644 docs/types/_internal_.UnknownError.html delete mode 100644 docs/types/_internal_.UnknownKeysParam.html delete mode 100644 docs/types/_internal_.UpsertCustomerIdentifierInput.html delete mode 100644 docs/types/_internal_.UpsertCustomerInput.html delete mode 100644 docs/types/_internal_.UpsertCustomerOnCreateInput.html delete mode 100644 docs/types/_internal_.UpsertCustomerOnUpdateInput.html delete mode 100644 docs/types/_internal_.Values.html delete mode 100644 docs/types/_internal_.Writeable.html delete mode 100644 docs/types/_internal_.ZodErrorMap.html delete mode 100644 docs/types/_internal_.ZodFormattedError.html delete mode 100644 docs/types/_internal_.ZodIssue.html delete mode 100644 docs/types/_internal_.ZodIssueBase.html delete mode 100644 docs/types/_internal_.ZodIssueOptionalMessage.html delete mode 100644 docs/types/_internal_.ZodNumberCheck.html delete mode 100644 docs/types/_internal_.ZodRawShape.html delete mode 100644 docs/types/_internal_.ZodStringCheck.html delete mode 100644 docs/types/_internal_.ZodTupleItems.html delete mode 100644 docs/types/_internal_.ZodTypeAny.html delete mode 100644 docs/types/_internal_.ZodUnionOptions.html delete mode 100644 docs/types/_internal_.addQuestionMarks.html delete mode 100644 docs/types/_internal_.allKeys.html delete mode 100644 docs/types/_internal_.arrayOutputType.html delete mode 100644 docs/types/_internal_.baseObjectInputType.html delete mode 100644 docs/types/_internal_.baseObjectOutputType.html delete mode 100644 docs/types/_internal_.deoptional.html delete mode 100644 docs/types/_internal_.flatten.html delete mode 100644 docs/types/_internal_.identity.html delete mode 100644 docs/types/_internal_.input.html delete mode 100644 docs/types/_internal_.noUndefined.html delete mode 100644 docs/types/_internal_.objectInputType.html delete mode 100644 docs/types/_internal_.objectOutputType.html delete mode 100644 docs/types/_internal_.output.html delete mode 100644 docs/types/_internal_.recursiveZodFormattedError.html delete mode 100644 docs/types/_internal_.requiredKeys.html delete mode 100644 docs/types/_internal_.stripPath.html delete mode 100644 docs/types/_internal_.typeToFlattenedError.html delete mode 100644 docs/types/_internal_.typecast.html delete mode 100644 docs/variables/_internal_.BRAND-1.html delete mode 100644 docs/variables/_internal_.INVALID-1.html delete mode 100644 docs/variables/_internal_.PlainGraphQLError-1.html diff --git a/.gitattributes b/.gitattributes index 3aef92f..36c64c8 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1 @@ -src/graphql/types.ts linguist-generated=true -docs/**/* linguist-generated=true \ No newline at end of file +src/graphql/types.ts linguist-generated=true \ No newline at end of file diff --git a/.gitignore b/.gitignore index c2dd9a5..9860320 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ node_modules dist -.vscode \ No newline at end of file +.vscode + +# These are generated and not commited +docs \ No newline at end of file diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 426d813..0000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,71 +0,0 @@ -:root { - --light-hl-0: #AF00DB; - --dark-hl-0: #C586C0; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #001080; - --dark-hl-2: #9CDCFE; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #0000FF; - --dark-hl-4: #569CD6; - --light-hl-5: #0070C1; - --dark-hl-5: #4FC1FF; - --light-hl-6: #795E26; - --dark-hl-6: #DCDCAA; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index 4c8fa61..0000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,58 +0,0 @@ -"use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index cf8d466..0000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":128,\"name\":\"PlainSDKClient\",\"url\":\"classes/PlainSDKClient.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/PlainSDKClient.html#constructor\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":1024,\"name\":\"#ctx\",\"url\":\"classes/PlainSDKClient.html#_ctx\",\"classes\":\"tsd-is-private\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"rawRequest\",\"url\":\"classes/PlainSDKClient.html#rawRequest\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"getCustomerById\",\"url\":\"classes/PlainSDKClient.html#getCustomerById\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"upsertCustomer\",\"url\":\"classes/PlainSDKClient.html#upsertCustomer\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":2048,\"name\":\"createIssue\",\"url\":\"classes/PlainSDKClient.html#createIssue\",\"classes\":\"\",\"parent\":\"PlainSDKClient\"},{\"kind\":4194304,\"name\":\"Actor\",\"url\":\"types/Actor.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"CustomerActor\",\"url\":\"types/CustomerActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/CustomerActor.html#__type\",\"classes\":\"\",\"parent\":\"CustomerActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/CustomerActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"CustomerActor.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/CustomerActor.html#__type.customerId\",\"classes\":\"\",\"parent\":\"CustomerActor.__type\"},{\"kind\":4194304,\"name\":\"Customer\",\"url\":\"types/Customer.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type\",\"classes\":\"\",\"parent\":\"Customer\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.__typename\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Customer.html#__type.id\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/Customer.html#__type.fullName\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/Customer.html#__type.shortName\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/Customer.html#__type.externalId\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/Customer.html#__type.status\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/Customer.html#__type.email\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.email.__type-2\",\"classes\":\"\",\"parent\":\"Customer.__type.email\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.email.__type-2.__typename-2\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/Customer.html#__type.email.__type-2.email-1\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"isVerified\",\"url\":\"types/Customer.html#__type.email.__type-2.isVerified\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"verifiedAt\",\"url\":\"types/Customer.html#__type.email.__type-2.verifiedAt\",\"classes\":\"\",\"parent\":\"Customer.__type.email.__type\"},{\"kind\":1024,\"name\":\"statusChangedAt\",\"url\":\"types/Customer.html#__type.statusChangedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3.__typename-3\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.statusChangedAt.__type-3.iso8601-1\",\"classes\":\"\",\"parent\":\"Customer.__type.statusChangedAt.__type\"},{\"kind\":1024,\"name\":\"assignedToUser\",\"url\":\"types/Customer.html#__type.assignedToUser\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"assignedAt\",\"url\":\"types/Customer.html#__type.assignedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"updatedAt\",\"url\":\"types/Customer.html#__type.updatedAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4.__typename-4\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.updatedAt.__type-4.iso8601-2\",\"classes\":\"\",\"parent\":\"Customer.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"lastIdleAt\",\"url\":\"types/Customer.html#__type.lastIdleAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"types/Customer.html#__type.createdAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Customer.html#__type.createdAt.__type-1\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Customer.html#__type.createdAt.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Customer.html#__type.createdAt.__type-1.iso8601\",\"classes\":\"\",\"parent\":\"Customer.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"types/Customer.html#__type.createdBy\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":1024,\"name\":\"markedAsSpamAt\",\"url\":\"types/Customer.html#__type.markedAsSpamAt\",\"classes\":\"\",\"parent\":\"Customer.__type\"},{\"kind\":4194304,\"name\":\"DateTime\",\"url\":\"types/DateTime.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/DateTime.html#__type\",\"classes\":\"\",\"parent\":\"DateTime\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/DateTime.html#__type.__typename\",\"classes\":\"\",\"parent\":\"DateTime.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/DateTime.html#__type.iso8601\",\"classes\":\"\",\"parent\":\"DateTime.__type\"},{\"kind\":4194304,\"name\":\"DeletedCustomerActor\",\"url\":\"types/DeletedCustomerActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/DeletedCustomerActor.html#__type\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/DeletedCustomerActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/DeletedCustomerActor.html#__type.customerId\",\"classes\":\"\",\"parent\":\"DeletedCustomerActor.__type\"},{\"kind\":4194304,\"name\":\"InternalActor\",\"url\":\"types/InternalActor.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Issue\",\"url\":\"types/Issue.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type\",\"classes\":\"\",\"parent\":\"Issue\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.__typename\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.id-1\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"issueKey\",\"url\":\"types/Issue.html#__type.issueKey\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/Issue.html#__type.status\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"customer\",\"url\":\"types/Issue.html#__type.customer\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.customer.__type-2\",\"classes\":\"\",\"parent\":\"Issue.__type.customer\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.customer.__type-2.__typename-2\",\"classes\":\"\",\"parent\":\"Issue.__type.customer.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.customer.__type-2.id\",\"classes\":\"\",\"parent\":\"Issue.__type.customer.__type\"},{\"kind\":1024,\"name\":\"priority\",\"url\":\"types/Issue.html#__type.priority\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.priority.__type-5\",\"classes\":\"\",\"parent\":\"Issue.__type.priority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.priority.__type-5.__typename-5\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/Issue.html#__type.priority.__type-5.label-1\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/Issue.html#__type.priority.__type-5.value-1\",\"classes\":\"\",\"parent\":\"Issue.__type.priority.__type\"},{\"kind\":1024,\"name\":\"updatedAt\",\"url\":\"types/Issue.html#__type.updatedAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6.__typename-6\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Issue.html#__type.updatedAt.__type-6.iso8601-1\",\"classes\":\"\",\"parent\":\"Issue.__type.updatedAt.__type\"},{\"kind\":1024,\"name\":\"updatedBy\",\"url\":\"types/Issue.html#__type.updatedBy\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"createdBy\",\"url\":\"types/Issue.html#__type.createdBy\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":1024,\"name\":\"createdAt\",\"url\":\"types/Issue.html#__type.createdAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.createdAt.__type-1\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.createdAt.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"iso8601\",\"url\":\"types/Issue.html#__type.createdAt.__type-1.iso8601\",\"classes\":\"\",\"parent\":\"Issue.__type.createdAt.__type\"},{\"kind\":1024,\"name\":\"issueType\",\"url\":\"types/Issue.html#__type.issueType\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.issueType.__type-3\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.issueType.__type-3.__typename-3\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/Issue.html#__type.issueType.__type-3.id-2\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"publicName\",\"url\":\"types/Issue.html#__type.issueType.__type-3.publicName\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"isArchived\",\"url\":\"types/Issue.html#__type.issueType.__type-3.isArchived\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":1024,\"name\":\"defaultIssuePriority\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.__typename-4\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.label\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/Issue.html#__type.issueType.__type-3.defaultIssuePriority.__type-4.value\",\"classes\":\"\",\"parent\":\"Issue.__type.issueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"deletedAt\",\"url\":\"types/Issue.html#__type.deletedAt\",\"classes\":\"\",\"parent\":\"Issue.__type\"},{\"kind\":4194304,\"name\":\"IssuePriority\",\"url\":\"types/IssuePriority.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssuePriority.html#__type\",\"classes\":\"\",\"parent\":\"IssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssuePriority.html#__type.__typename\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/IssuePriority.html#__type.label\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/IssuePriority.html#__type.value\",\"classes\":\"\",\"parent\":\"IssuePriority.__type\"},{\"kind\":4194304,\"name\":\"IssueType\",\"url\":\"types/IssueType.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssueType.html#__type\",\"classes\":\"\",\"parent\":\"IssueType\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssueType.html#__type.__typename\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/IssueType.html#__type.id\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"publicName\",\"url\":\"types/IssueType.html#__type.publicName\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"isArchived\",\"url\":\"types/IssueType.html#__type.isArchived\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":1024,\"name\":\"defaultIssuePriority\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority\",\"classes\":\"\",\"parent\":\"IssueType.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.__typename-1\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.label\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/IssueType.html#__type.defaultIssuePriority.__type-1.value\",\"classes\":\"\",\"parent\":\"IssueType.__type.defaultIssuePriority.__type\"},{\"kind\":4194304,\"name\":\"MachineUserActor\",\"url\":\"types/MachineUserActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MachineUserActor.html#__type\",\"classes\":\"\",\"parent\":\"MachineUserActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/MachineUserActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"MachineUserActor.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/MachineUserActor.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\"MachineUserActor.__type\"},{\"kind\":4194304,\"name\":\"MutationError\",\"url\":\"types/MutationError.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MutationError.html#__type\",\"classes\":\"\",\"parent\":\"MutationError\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/MutationError.html#__type.__typename\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/MutationError.html#__type.message\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/MutationError.html#__type.type\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/MutationError.html#__type.code\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/MutationError.html#__type.fields\",\"classes\":\"\",\"parent\":\"MutationError.__type\"},{\"kind\":4194304,\"name\":\"SystemActor\",\"url\":\"types/SystemActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/SystemActor.html#__type\",\"classes\":\"\",\"parent\":\"SystemActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/SystemActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"SystemActor.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/SystemActor.html#__type.systemId\",\"classes\":\"\",\"parent\":\"SystemActor.__type\"},{\"kind\":4194304,\"name\":\"UserActor\",\"url\":\"types/UserActor.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/UserActor.html#__type\",\"classes\":\"\",\"parent\":\"UserActor\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/UserActor.html#__type.__typename\",\"classes\":\"\",\"parent\":\"UserActor.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/UserActor.html#__type.userId\",\"classes\":\"\",\"parent\":\"UserActor.__type\"},{\"kind\":2,\"name\":\"\",\"url\":\"modules/_internal_.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Context\",\"url\":\"types/_internal_.Context.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Context.html#__type\",\"classes\":\"\",\"parent\":\".Context\"},{\"kind\":1024,\"name\":\"apiKey\",\"url\":\"types/_internal_.Context.html#__type.apiKey\",\"classes\":\"\",\"parent\":\".Context.__type\"},{\"kind\":4194304,\"name\":\"SDKResult\",\"url\":\"types/_internal_.SDKResult.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"Exact\",\"url\":\"types/_internal_.Exact.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"UpsertCustomerInput\",\"url\":\"types/_internal_.UpsertCustomerInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput\"},{\"kind\":1024,\"name\":\"identifier\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.identifier\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":1024,\"name\":\"onCreate\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.onCreate\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":1024,\"name\":\"onUpdate\",\"url\":\"types/_internal_.UpsertCustomerInput.html#__type.onUpdate\",\"classes\":\"\",\"parent\":\".UpsertCustomerInput.__type\"},{\"kind\":4194304,\"name\":\"CreateIssueInput\",\"url\":\"types/_internal_.CreateIssueInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.CreateIssueInput.html#__type\",\"classes\":\"\",\"parent\":\".CreateIssueInput\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.customerId\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":1024,\"name\":\"issueTypeId\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.issueTypeId\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":1024,\"name\":\"priorityValue\",\"url\":\"types/_internal_.CreateIssueInput.html#__type.priorityValue\",\"classes\":\"\",\"parent\":\".CreateIssueInput.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_CustomerActor_Fragment\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.ActorParts_CustomerActor_Fragment.html#__type.customerId\",\"classes\":\"\",\"parent\":\".ActorParts_CustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_DeletedCustomerActor_Fragment\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html#__type.customerId\",\"classes\":\"\",\"parent\":\".ActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_MachineUserActor_Fragment\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/_internal_.ActorParts_MachineUserActor_Fragment.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\".ActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_SystemActor_Fragment\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/_internal_.ActorParts_SystemActor_Fragment.html#__type.systemId\",\"classes\":\"\",\"parent\":\".ActorParts_SystemActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"ActorParts_UserActor_Fragment\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/_internal_.ActorParts_UserActor_Fragment.html#__type.userId\",\"classes\":\"\",\"parent\":\".ActorParts_UserActor_Fragment.__type\"},{\"kind\":8,\"name\":\"CustomerStatus\",\"url\":\"enums/_internal_.CustomerStatus.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Active\",\"url\":\"enums/_internal_.CustomerStatus.html#Active\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":16,\"name\":\"Idle\",\"url\":\"enums/_internal_.CustomerStatus.html#Idle\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":16,\"name\":\"Snoozed\",\"url\":\"enums/_internal_.CustomerStatus.html#Snoozed\",\"classes\":\"\",\"parent\":\".CustomerStatus\"},{\"kind\":4194304,\"name\":\"InternalActorParts_CustomerActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_CustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_CustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_CustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_DeletedCustomerActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_DeletedCustomerActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_DeletedCustomerActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_MachineUserActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"machineUserId\",\"url\":\"types/_internal_.InternalActorParts_MachineUserActor_Fragment.html#__type.machineUserId\",\"classes\":\"\",\"parent\":\".InternalActorParts_MachineUserActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_SystemActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"systemId\",\"url\":\"types/_internal_.InternalActorParts_SystemActor_Fragment.html#__type.systemId\",\"classes\":\"\",\"parent\":\".InternalActorParts_SystemActor_Fragment.__type\"},{\"kind\":4194304,\"name\":\"InternalActorParts_UserActor_Fragment\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment\"},{\"kind\":1024,\"name\":\"__typename\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type.__typename\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment.__type\"},{\"kind\":1024,\"name\":\"userId\",\"url\":\"types/_internal_.InternalActorParts_UserActor_Fragment.html#__type.userId\",\"classes\":\"\",\"parent\":\".InternalActorParts_UserActor_Fragment.__type\"},{\"kind\":8,\"name\":\"IssueStatus\",\"url\":\"enums/_internal_.IssueStatus.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Open\",\"url\":\"enums/_internal_.IssueStatus.html#Open\",\"classes\":\"\",\"parent\":\".IssueStatus\"},{\"kind\":16,\"name\":\"Resolved\",\"url\":\"enums/_internal_.IssueStatus.html#Resolved\",\"classes\":\"\",\"parent\":\".IssueStatus\"},{\"kind\":8,\"name\":\"MutationErrorType\",\"url\":\"enums/_internal_.MutationErrorType.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"Forbidden\",\"url\":\"enums/_internal_.MutationErrorType.html#Forbidden\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":16,\"name\":\"Internal\",\"url\":\"enums/_internal_.MutationErrorType.html#Internal\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":16,\"name\":\"Validation\",\"url\":\"enums/_internal_.MutationErrorType.html#Validation\",\"classes\":\"\",\"parent\":\".MutationErrorType\"},{\"kind\":8,\"name\":\"MutationFieldErrorType\",\"url\":\"enums/_internal_.MutationFieldErrorType.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":16,\"name\":\"NotFound\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#NotFound\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":16,\"name\":\"Required\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#Required\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":16,\"name\":\"Validation\",\"url\":\"enums/_internal_.MutationFieldErrorType.html#Validation\",\"classes\":\"\",\"parent\":\".MutationFieldErrorType\"},{\"kind\":4194304,\"name\":\"Result\",\"url\":\"types/_internal_.Result.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"PlainSDKError\",\"url\":\"types/_internal_.PlainSDKError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"UpsertCustomerIdentifierInput\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput\"},{\"kind\":1024,\"name\":\"customerId\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.customerId\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":1024,\"name\":\"emailAddress\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.emailAddress\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerIdentifierInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerIdentifierInput.__type\"},{\"kind\":4194304,\"name\":\"UpsertCustomerOnCreateInput\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput\"},{\"kind\":1024,\"name\":\"customerGroupIdentifiers\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.customerGroupIdentifiers\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.email\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.fullName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/_internal_.UpsertCustomerOnCreateInput.html#__type.shortName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnCreateInput.__type\"},{\"kind\":4194304,\"name\":\"UpsertCustomerOnUpdateInput\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.email\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"externalId\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.externalId\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"fullName\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.fullName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":1024,\"name\":\"shortName\",\"url\":\"types/_internal_.UpsertCustomerOnUpdateInput.html#__type.shortName\",\"classes\":\"\",\"parent\":\".UpsertCustomerOnUpdateInput.__type\"},{\"kind\":4194304,\"name\":\"Scalars\",\"url\":\"types/_internal_.Scalars.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Scalars.html#__type\",\"classes\":\"\",\"parent\":\".Scalars\"},{\"kind\":1024,\"name\":\"ID\",\"url\":\"types/_internal_.Scalars.html#__type.ID\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"String\",\"url\":\"types/_internal_.Scalars.html#__type.String\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Boolean\",\"url\":\"types/_internal_.Scalars.html#__type.Boolean\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Int\",\"url\":\"types/_internal_.Scalars.html#__type.Int\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":1024,\"name\":\"Float\",\"url\":\"types/_internal_.Scalars.html#__type.Float\",\"classes\":\"\",\"parent\":\".Scalars.__type\"},{\"kind\":4194304,\"name\":\"InputMaybe\",\"url\":\"types/_internal_.InputMaybe.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"Data\",\"url\":\"types/_internal_.Data.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Data.html#__type\",\"classes\":\"\",\"parent\":\".Data\"},{\"kind\":1024,\"name\":\"data\",\"url\":\"types/_internal_.Data.html#__type.data\",\"classes\":\"\",\"parent\":\".Data.__type\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/_internal_.Data.html#__type.error\",\"classes\":\"\",\"parent\":\".Data.__type\"},{\"kind\":4194304,\"name\":\"Err\",\"url\":\"types/_internal_.Err.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.Err.html#__type\",\"classes\":\"\",\"parent\":\".Err\"},{\"kind\":1024,\"name\":\"data\",\"url\":\"types/_internal_.Err.html#__type.data\",\"classes\":\"\",\"parent\":\".Err.__type\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/_internal_.Err.html#__type.error\",\"classes\":\"\",\"parent\":\".Err.__type\"},{\"kind\":4194304,\"name\":\"ForbiddenError\",\"url\":\"types/_internal_.ForbiddenError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.ForbiddenError.html#__type\",\"classes\":\"\",\"parent\":\".ForbiddenError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.ForbiddenError.html#__type.code\",\"classes\":\"\",\"parent\":\".ForbiddenError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.ForbiddenError.html#__type.message\",\"classes\":\"\",\"parent\":\".ForbiddenError.__type\"},{\"kind\":4194304,\"name\":\"BadRequestError\",\"url\":\"types/_internal_.BadRequestError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.BadRequestError.html#__type\",\"classes\":\"\",\"parent\":\".BadRequestError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.BadRequestError.html#__type.code\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.BadRequestError.html#__type.message\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":1024,\"name\":\"graphqlErrors\",\"url\":\"types/_internal_.BadRequestError.html#__type.graphqlErrors\",\"classes\":\"\",\"parent\":\".BadRequestError.__type\"},{\"kind\":4194304,\"name\":\"InternalServerError\",\"url\":\"types/_internal_.InternalServerError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.InternalServerError.html#__type\",\"classes\":\"\",\"parent\":\".InternalServerError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.InternalServerError.html#__type.code\",\"classes\":\"\",\"parent\":\".InternalServerError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.InternalServerError.html#__type.message\",\"classes\":\"\",\"parent\":\".InternalServerError.__type\"},{\"kind\":4194304,\"name\":\"MutationError\",\"url\":\"types/_internal_.MutationError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.MutationError.html#__type\",\"classes\":\"\",\"parent\":\".MutationError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.MutationError.html#__type.code\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.MutationError.html#__type.message\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":1024,\"name\":\"errorDetails\",\"url\":\"types/_internal_.MutationError.html#__type.errorDetails\",\"classes\":\"\",\"parent\":\".MutationError.__type\"},{\"kind\":4194304,\"name\":\"UnknownError\",\"url\":\"types/_internal_.UnknownError.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.UnknownError.html#__type\",\"classes\":\"\",\"parent\":\".UnknownError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/_internal_.UnknownError.html#__type.code\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/_internal_.UnknownError.html#__type.message\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"types/_internal_.UnknownError.html#__type.err\",\"classes\":\"\",\"parent\":\".UnknownError.__type\"},{\"kind\":4194304,\"name\":\"CustomerGroupIdentifier\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier\"},{\"kind\":1024,\"name\":\"customerGroupId\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type.customerGroupId\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier.__type\"},{\"kind\":1024,\"name\":\"customerGroupKey\",\"url\":\"types/_internal_.CustomerGroupIdentifier.html#__type.customerGroupKey\",\"classes\":\"\",\"parent\":\".CustomerGroupIdentifier.__type\"},{\"kind\":4194304,\"name\":\"EmailAddressInput\",\"url\":\"types/_internal_.EmailAddressInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.EmailAddressInput.html#__type\",\"classes\":\"\",\"parent\":\".EmailAddressInput\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"types/_internal_.EmailAddressInput.html#__type.email\",\"classes\":\"\",\"parent\":\".EmailAddressInput.__type\"},{\"kind\":1024,\"name\":\"isVerified\",\"url\":\"types/_internal_.EmailAddressInput.html#__type.isVerified\",\"classes\":\"\",\"parent\":\".EmailAddressInput.__type\"},{\"kind\":4194304,\"name\":\"OptionalStringInput\",\"url\":\"types/_internal_.OptionalStringInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.OptionalStringInput.html#__type\",\"classes\":\"\",\"parent\":\".OptionalStringInput\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/_internal_.OptionalStringInput.html#__type.value\",\"classes\":\"\",\"parent\":\".OptionalStringInput.__type\"},{\"kind\":4194304,\"name\":\"StringInput\",\"url\":\"types/_internal_.StringInput.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_internal_.StringInput.html#__type\",\"classes\":\"\",\"parent\":\".StringInput\"},{\"kind\":1024,\"name\":\"value\",\"url\":\"types/_internal_.StringInput.html#__type.value\",\"classes\":\"\",\"parent\":\".StringInput.__type\"},{\"kind\":4194304,\"name\":\"Maybe\",\"url\":\"types/_internal_.Maybe.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":32,\"name\":\"PlainGraphQLError\",\"url\":\"variables/_internal_.PlainGraphQLError-1.html\",\"classes\":\"\",\"parent\":\"\"},{\"kind\":4194304,\"name\":\"PlainGraphQLError\",\"url\":\"types/_internal_.PlainGraphQLError.html\",\"classes\":\"\",\"parent\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,51.93]],[\"comment/0\",[]],[\"name/1\",[1,51.93]],[\"comment/1\",[]],[\"name/2\",[2,51.93]],[\"comment/2\",[]],[\"name/3\",[3,51.93]],[\"comment/3\",[]],[\"name/4\",[4,51.93]],[\"comment/4\",[]],[\"name/5\",[5,51.93]],[\"comment/5\",[]],[\"name/6\",[6,51.93]],[\"comment/6\",[]],[\"name/7\",[7,51.93]],[\"comment/7\",[]],[\"name/8\",[8,51.93]],[\"comment/8\",[]],[\"name/9\",[9,16.764]],[\"comment/9\",[]],[\"name/10\",[10,21.172]],[\"comment/10\",[]],[\"name/11\",[11,37.266]],[\"comment/11\",[]],[\"name/12\",[12,46.821]],[\"comment/12\",[]],[\"name/13\",[9,16.764]],[\"comment/13\",[]],[\"name/14\",[10,21.172]],[\"comment/14\",[]],[\"name/15\",[13,37.266]],[\"comment/15\",[]],[\"name/16\",[14,43.457]],[\"comment/16\",[]],[\"name/17\",[15,43.457]],[\"comment/17\",[]],[\"name/18\",[16,40.943]],[\"comment/18\",[]],[\"name/19\",[17,46.821]],[\"comment/19\",[]],[\"name/20\",[18,38.937]],[\"comment/20\",[]],[\"name/21\",[9,16.764]],[\"comment/21\",[]],[\"name/22\",[10,21.172]],[\"comment/22\",[]],[\"name/23\",[18,38.937]],[\"comment/23\",[]],[\"name/24\",[19,46.821]],[\"comment/24\",[]],[\"name/25\",[20,51.93]],[\"comment/25\",[]],[\"name/26\",[21,51.93]],[\"comment/26\",[]],[\"name/27\",[9,16.764]],[\"comment/27\",[]],[\"name/28\",[10,21.172]],[\"comment/28\",[]],[\"name/29\",[22,37.266]],[\"comment/29\",[]],[\"name/30\",[23,51.93]],[\"comment/30\",[]],[\"name/31\",[24,51.93]],[\"comment/31\",[]],[\"name/32\",[25,46.821]],[\"comment/32\",[]],[\"name/33\",[9,16.764]],[\"comment/33\",[]],[\"name/34\",[10,21.172]],[\"comment/34\",[]],[\"name/35\",[22,37.266]],[\"comment/35\",[]],[\"name/36\",[26,51.93]],[\"comment/36\",[]],[\"name/37\",[27,46.821]],[\"comment/37\",[]],[\"name/38\",[9,16.764]],[\"comment/38\",[]],[\"name/39\",[10,21.172]],[\"comment/39\",[]],[\"name/40\",[22,37.266]],[\"comment/40\",[]],[\"name/41\",[28,46.821]],[\"comment/41\",[]],[\"name/42\",[29,51.93]],[\"comment/42\",[]],[\"name/43\",[30,51.93]],[\"comment/43\",[]],[\"name/44\",[9,16.764]],[\"comment/44\",[]],[\"name/45\",[10,21.172]],[\"comment/45\",[]],[\"name/46\",[22,37.266]],[\"comment/46\",[]],[\"name/47\",[31,51.93]],[\"comment/47\",[]],[\"name/48\",[9,16.764]],[\"comment/48\",[]],[\"name/49\",[10,21.172]],[\"comment/49\",[]],[\"name/50\",[11,37.266]],[\"comment/50\",[]],[\"name/51\",[32,51.93]],[\"comment/51\",[]],[\"name/52\",[33,51.93]],[\"comment/52\",[]],[\"name/53\",[9,16.764]],[\"comment/53\",[]],[\"name/54\",[10,21.172]],[\"comment/54\",[]],[\"name/55\",[13,37.266]],[\"comment/55\",[]],[\"name/56\",[34,51.93]],[\"comment/56\",[]],[\"name/57\",[17,46.821]],[\"comment/57\",[]],[\"name/58\",[12,46.821]],[\"comment/58\",[]],[\"name/59\",[9,16.764]],[\"comment/59\",[]],[\"name/60\",[10,21.172]],[\"comment/60\",[]],[\"name/61\",[13,37.266]],[\"comment/61\",[]],[\"name/62\",[35,51.93]],[\"comment/62\",[]],[\"name/63\",[9,16.764]],[\"comment/63\",[]],[\"name/64\",[10,21.172]],[\"comment/64\",[]],[\"name/65\",[36,40.943]],[\"comment/65\",[]],[\"name/66\",[37,37.266]],[\"comment/66\",[]],[\"name/67\",[25,46.821]],[\"comment/67\",[]],[\"name/68\",[9,16.764]],[\"comment/68\",[]],[\"name/69\",[10,21.172]],[\"comment/69\",[]],[\"name/70\",[22,37.266]],[\"comment/70\",[]],[\"name/71\",[38,51.93]],[\"comment/71\",[]],[\"name/72\",[28,46.821]],[\"comment/72\",[]],[\"name/73\",[27,46.821]],[\"comment/73\",[]],[\"name/74\",[9,16.764]],[\"comment/74\",[]],[\"name/75\",[10,21.172]],[\"comment/75\",[]],[\"name/76\",[22,37.266]],[\"comment/76\",[]],[\"name/77\",[39,46.821]],[\"comment/77\",[]],[\"name/78\",[9,16.764]],[\"comment/78\",[]],[\"name/79\",[10,21.172]],[\"comment/79\",[]],[\"name/80\",[13,37.266]],[\"comment/80\",[]],[\"name/81\",[40,46.821]],[\"comment/81\",[]],[\"name/82\",[41,46.821]],[\"comment/82\",[]],[\"name/83\",[42,46.821]],[\"comment/83\",[]],[\"name/84\",[9,16.764]],[\"comment/84\",[]],[\"name/85\",[10,21.172]],[\"comment/85\",[]],[\"name/86\",[36,40.943]],[\"comment/86\",[]],[\"name/87\",[37,37.266]],[\"comment/87\",[]],[\"name/88\",[43,51.93]],[\"comment/88\",[]],[\"name/89\",[44,51.93]],[\"comment/89\",[]],[\"name/90\",[9,16.764]],[\"comment/90\",[]],[\"name/91\",[10,21.172]],[\"comment/91\",[]],[\"name/92\",[36,40.943]],[\"comment/92\",[]],[\"name/93\",[37,37.266]],[\"comment/93\",[]],[\"name/94\",[39,46.821]],[\"comment/94\",[]],[\"name/95\",[9,16.764]],[\"comment/95\",[]],[\"name/96\",[10,21.172]],[\"comment/96\",[]],[\"name/97\",[13,37.266]],[\"comment/97\",[]],[\"name/98\",[40,46.821]],[\"comment/98\",[]],[\"name/99\",[41,46.821]],[\"comment/99\",[]],[\"name/100\",[42,46.821]],[\"comment/100\",[]],[\"name/101\",[9,16.764]],[\"comment/101\",[]],[\"name/102\",[10,21.172]],[\"comment/102\",[]],[\"name/103\",[36,40.943]],[\"comment/103\",[]],[\"name/104\",[37,37.266]],[\"comment/104\",[]],[\"name/105\",[45,51.93]],[\"comment/105\",[]],[\"name/106\",[9,16.764]],[\"comment/106\",[]],[\"name/107\",[10,21.172]],[\"comment/107\",[]],[\"name/108\",[46,43.457]],[\"comment/108\",[]],[\"name/109\",[47,46.821]],[\"comment/109\",[]],[\"name/110\",[9,16.764]],[\"comment/110\",[]],[\"name/111\",[10,21.172]],[\"comment/111\",[]],[\"name/112\",[48,37.266]],[\"comment/112\",[]],[\"name/113\",[49,51.93]],[\"comment/113\",[]],[\"name/114\",[50,37.266]],[\"comment/114\",[]],[\"name/115\",[51,51.93]],[\"comment/115\",[]],[\"name/116\",[52,51.93]],[\"comment/116\",[]],[\"name/117\",[9,16.764]],[\"comment/117\",[]],[\"name/118\",[10,21.172]],[\"comment/118\",[]],[\"name/119\",[53,43.457]],[\"comment/119\",[]],[\"name/120\",[54,51.93]],[\"comment/120\",[]],[\"name/121\",[9,16.764]],[\"comment/121\",[]],[\"name/122\",[10,21.172]],[\"comment/122\",[]],[\"name/123\",[55,43.457]],[\"comment/123\",[]],[\"name/124\",[56,46.821]],[\"comment/124\",[]],[\"name/125\",[57,51.93]],[\"comment/125\",[]],[\"name/126\",[9,16.764]],[\"comment/126\",[]],[\"name/127\",[58,51.93]],[\"comment/127\",[]],[\"name/128\",[59,51.93]],[\"comment/128\",[]],[\"name/129\",[60,51.93]],[\"comment/129\",[]],[\"name/130\",[61,51.93]],[\"comment/130\",[]],[\"name/131\",[9,16.764]],[\"comment/131\",[]],[\"name/132\",[62,51.93]],[\"comment/132\",[]],[\"name/133\",[63,51.93]],[\"comment/133\",[]],[\"name/134\",[64,51.93]],[\"comment/134\",[]],[\"name/135\",[65,51.93]],[\"comment/135\",[]],[\"name/136\",[9,16.764]],[\"comment/136\",[]],[\"name/137\",[11,37.266]],[\"comment/137\",[]],[\"name/138\",[66,51.93]],[\"comment/138\",[]],[\"name/139\",[67,51.93]],[\"comment/139\",[]],[\"name/140\",[68,51.93]],[\"comment/140\",[]],[\"name/141\",[9,16.764]],[\"comment/141\",[]],[\"name/142\",[10,21.172]],[\"comment/142\",[]],[\"name/143\",[11,37.266]],[\"comment/143\",[]],[\"name/144\",[69,51.93]],[\"comment/144\",[]],[\"name/145\",[9,16.764]],[\"comment/145\",[]],[\"name/146\",[10,21.172]],[\"comment/146\",[]],[\"name/147\",[11,37.266]],[\"comment/147\",[]],[\"name/148\",[70,51.93]],[\"comment/148\",[]],[\"name/149\",[9,16.764]],[\"comment/149\",[]],[\"name/150\",[10,21.172]],[\"comment/150\",[]],[\"name/151\",[46,43.457]],[\"comment/151\",[]],[\"name/152\",[71,51.93]],[\"comment/152\",[]],[\"name/153\",[9,16.764]],[\"comment/153\",[]],[\"name/154\",[10,21.172]],[\"comment/154\",[]],[\"name/155\",[53,43.457]],[\"comment/155\",[]],[\"name/156\",[72,51.93]],[\"comment/156\",[]],[\"name/157\",[9,16.764]],[\"comment/157\",[]],[\"name/158\",[10,21.172]],[\"comment/158\",[]],[\"name/159\",[55,43.457]],[\"comment/159\",[]],[\"name/160\",[73,51.93]],[\"comment/160\",[]],[\"name/161\",[74,51.93]],[\"comment/161\",[]],[\"name/162\",[75,51.93]],[\"comment/162\",[]],[\"name/163\",[76,51.93]],[\"comment/163\",[]],[\"name/164\",[77,51.93]],[\"comment/164\",[]],[\"name/165\",[9,16.764]],[\"comment/165\",[]],[\"name/166\",[10,21.172]],[\"comment/166\",[]],[\"name/167\",[78,51.93]],[\"comment/167\",[]],[\"name/168\",[9,16.764]],[\"comment/168\",[]],[\"name/169\",[10,21.172]],[\"comment/169\",[]],[\"name/170\",[79,51.93]],[\"comment/170\",[]],[\"name/171\",[9,16.764]],[\"comment/171\",[]],[\"name/172\",[10,21.172]],[\"comment/172\",[]],[\"name/173\",[46,43.457]],[\"comment/173\",[]],[\"name/174\",[80,51.93]],[\"comment/174\",[]],[\"name/175\",[9,16.764]],[\"comment/175\",[]],[\"name/176\",[10,21.172]],[\"comment/176\",[]],[\"name/177\",[53,43.457]],[\"comment/177\",[]],[\"name/178\",[81,51.93]],[\"comment/178\",[]],[\"name/179\",[9,16.764]],[\"comment/179\",[]],[\"name/180\",[10,21.172]],[\"comment/180\",[]],[\"name/181\",[55,43.457]],[\"comment/181\",[]],[\"name/182\",[82,51.93]],[\"comment/182\",[]],[\"name/183\",[83,51.93]],[\"comment/183\",[]],[\"name/184\",[84,51.93]],[\"comment/184\",[]],[\"name/185\",[85,51.93]],[\"comment/185\",[]],[\"name/186\",[86,51.93]],[\"comment/186\",[]],[\"name/187\",[56,46.821]],[\"comment/187\",[]],[\"name/188\",[87,46.821]],[\"comment/188\",[]],[\"name/189\",[88,51.93]],[\"comment/189\",[]],[\"name/190\",[89,51.93]],[\"comment/190\",[]],[\"name/191\",[90,51.93]],[\"comment/191\",[]],[\"name/192\",[87,46.821]],[\"comment/192\",[]],[\"name/193\",[91,51.93]],[\"comment/193\",[]],[\"name/194\",[92,51.93]],[\"comment/194\",[]],[\"name/195\",[93,51.93]],[\"comment/195\",[]],[\"name/196\",[9,16.764]],[\"comment/196\",[]],[\"name/197\",[11,37.266]],[\"comment/197\",[]],[\"name/198\",[94,51.93]],[\"comment/198\",[]],[\"name/199\",[16,40.943]],[\"comment/199\",[]],[\"name/200\",[95,51.93]],[\"comment/200\",[]],[\"name/201\",[9,16.764]],[\"comment/201\",[]],[\"name/202\",[96,51.93]],[\"comment/202\",[]],[\"name/203\",[18,38.937]],[\"comment/203\",[]],[\"name/204\",[16,40.943]],[\"comment/204\",[]],[\"name/205\",[14,43.457]],[\"comment/205\",[]],[\"name/206\",[15,43.457]],[\"comment/206\",[]],[\"name/207\",[97,51.93]],[\"comment/207\",[]],[\"name/208\",[9,16.764]],[\"comment/208\",[]],[\"name/209\",[18,38.937]],[\"comment/209\",[]],[\"name/210\",[16,40.943]],[\"comment/210\",[]],[\"name/211\",[14,43.457]],[\"comment/211\",[]],[\"name/212\",[15,43.457]],[\"comment/212\",[]],[\"name/213\",[98,51.93]],[\"comment/213\",[]],[\"name/214\",[9,16.764]],[\"comment/214\",[]],[\"name/215\",[13,37.266]],[\"comment/215\",[]],[\"name/216\",[99,51.93]],[\"comment/216\",[]],[\"name/217\",[100,51.93]],[\"comment/217\",[]],[\"name/218\",[101,51.93]],[\"comment/218\",[]],[\"name/219\",[102,51.93]],[\"comment/219\",[]],[\"name/220\",[103,51.93]],[\"comment/220\",[]],[\"name/221\",[104,43.457]],[\"comment/221\",[]],[\"name/222\",[9,16.764]],[\"comment/222\",[]],[\"name/223\",[104,43.457]],[\"comment/223\",[]],[\"name/224\",[105,46.821]],[\"comment/224\",[]],[\"name/225\",[106,46.821]],[\"comment/225\",[]],[\"name/226\",[9,16.764]],[\"comment/226\",[]],[\"name/227\",[104,43.457]],[\"comment/227\",[]],[\"name/228\",[105,46.821]],[\"comment/228\",[]],[\"name/229\",[107,51.93]],[\"comment/229\",[]],[\"name/230\",[9,16.764]],[\"comment/230\",[]],[\"name/231\",[50,37.266]],[\"comment/231\",[]],[\"name/232\",[48,37.266]],[\"comment/232\",[]],[\"name/233\",[108,51.93]],[\"comment/233\",[]],[\"name/234\",[9,16.764]],[\"comment/234\",[]],[\"name/235\",[50,37.266]],[\"comment/235\",[]],[\"name/236\",[48,37.266]],[\"comment/236\",[]],[\"name/237\",[109,51.93]],[\"comment/237\",[]],[\"name/238\",[110,51.93]],[\"comment/238\",[]],[\"name/239\",[9,16.764]],[\"comment/239\",[]],[\"name/240\",[50,37.266]],[\"comment/240\",[]],[\"name/241\",[48,37.266]],[\"comment/241\",[]],[\"name/242\",[47,46.821]],[\"comment/242\",[]],[\"name/243\",[9,16.764]],[\"comment/243\",[]],[\"name/244\",[50,37.266]],[\"comment/244\",[]],[\"name/245\",[48,37.266]],[\"comment/245\",[]],[\"name/246\",[111,51.93]],[\"comment/246\",[]],[\"name/247\",[112,51.93]],[\"comment/247\",[]],[\"name/248\",[9,16.764]],[\"comment/248\",[]],[\"name/249\",[50,37.266]],[\"comment/249\",[]],[\"name/250\",[48,37.266]],[\"comment/250\",[]],[\"name/251\",[106,46.821]],[\"comment/251\",[]],[\"name/252\",[113,51.93]],[\"comment/252\",[]],[\"name/253\",[9,16.764]],[\"comment/253\",[]],[\"name/254\",[114,51.93]],[\"comment/254\",[]],[\"name/255\",[115,51.93]],[\"comment/255\",[]],[\"name/256\",[116,51.93]],[\"comment/256\",[]],[\"name/257\",[9,16.764]],[\"comment/257\",[]],[\"name/258\",[18,38.937]],[\"comment/258\",[]],[\"name/259\",[19,46.821]],[\"comment/259\",[]],[\"name/260\",[117,51.93]],[\"comment/260\",[]],[\"name/261\",[9,16.764]],[\"comment/261\",[]],[\"name/262\",[37,37.266]],[\"comment/262\",[]],[\"name/263\",[118,51.93]],[\"comment/263\",[]],[\"name/264\",[9,16.764]],[\"comment/264\",[]],[\"name/265\",[37,37.266]],[\"comment/265\",[]],[\"name/266\",[119,51.93]],[\"comment/266\",[]],[\"name/267\",[120,46.821]],[\"comment/267\",[]],[\"name/268\",[120,46.821]],[\"comment/268\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":9,\"name\":{\"9\":{},\"13\":{},\"21\":{},\"27\":{},\"33\":{},\"38\":{},\"44\":{},\"48\":{},\"53\":{},\"59\":{},\"63\":{},\"68\":{},\"74\":{},\"78\":{},\"84\":{},\"90\":{},\"95\":{},\"101\":{},\"106\":{},\"110\":{},\"117\":{},\"121\":{},\"126\":{},\"131\":{},\"136\":{},\"141\":{},\"145\":{},\"149\":{},\"153\":{},\"157\":{},\"165\":{},\"168\":{},\"171\":{},\"175\":{},\"179\":{},\"196\":{},\"201\":{},\"208\":{},\"214\":{},\"222\":{},\"226\":{},\"230\":{},\"234\":{},\"239\":{},\"243\":{},\"248\":{},\"253\":{},\"257\":{},\"261\":{},\"264\":{}},\"comment\":{}}],[\"__typename\",{\"_index\":10,\"name\":{\"10\":{},\"14\":{},\"22\":{},\"28\":{},\"34\":{},\"39\":{},\"45\":{},\"49\":{},\"54\":{},\"60\":{},\"64\":{},\"69\":{},\"75\":{},\"79\":{},\"85\":{},\"91\":{},\"96\":{},\"102\":{},\"107\":{},\"111\":{},\"118\":{},\"122\":{},\"142\":{},\"146\":{},\"150\":{},\"154\":{},\"158\":{},\"166\":{},\"169\":{},\"172\":{},\"176\":{},\"180\":{}},\"comment\":{}}],[\"active\",{\"_index\":74,\"name\":{\"161\":{}},\"comment\":{}}],[\"actor\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"actorparts_customeractor_fragment\",{\"_index\":68,\"name\":{\"140\":{}},\"comment\":{}}],[\"actorparts_deletedcustomeractor_fragment\",{\"_index\":69,\"name\":{\"144\":{}},\"comment\":{}}],[\"actorparts_machineuseractor_fragment\",{\"_index\":70,\"name\":{\"148\":{}},\"comment\":{}}],[\"actorparts_systemactor_fragment\",{\"_index\":71,\"name\":{\"152\":{}},\"comment\":{}}],[\"actorparts_useractor_fragment\",{\"_index\":72,\"name\":{\"156\":{}},\"comment\":{}}],[\"apikey\",{\"_index\":58,\"name\":{\"127\":{}},\"comment\":{}}],[\"assignedat\",{\"_index\":24,\"name\":{\"31\":{}},\"comment\":{}}],[\"assignedtouser\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"badrequesterror\",{\"_index\":108,\"name\":{\"233\":{}},\"comment\":{}}],[\"boolean\",{\"_index\":100,\"name\":{\"217\":{}},\"comment\":{}}],[\"code\",{\"_index\":50,\"name\":{\"114\":{},\"231\":{},\"235\":{},\"240\":{},\"244\":{},\"249\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"context\",{\"_index\":57,\"name\":{\"125\":{}},\"comment\":{}}],[\"createdat\",{\"_index\":27,\"name\":{\"37\":{},\"73\":{}},\"comment\":{}}],[\"createdby\",{\"_index\":28,\"name\":{\"41\":{},\"72\":{}},\"comment\":{}}],[\"createissue\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"createissueinput\",{\"_index\":65,\"name\":{\"135\":{}},\"comment\":{}}],[\"ctx\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"customer\",{\"_index\":12,\"name\":{\"12\":{},\"58\":{}},\"comment\":{}}],[\"customeractor\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"customergroupid\",{\"_index\":114,\"name\":{\"254\":{}},\"comment\":{}}],[\"customergroupidentifier\",{\"_index\":113,\"name\":{\"252\":{}},\"comment\":{}}],[\"customergroupidentifiers\",{\"_index\":96,\"name\":{\"202\":{}},\"comment\":{}}],[\"customergroupkey\",{\"_index\":115,\"name\":{\"255\":{}},\"comment\":{}}],[\"customerid\",{\"_index\":11,\"name\":{\"11\":{},\"50\":{},\"137\":{},\"143\":{},\"147\":{},\"197\":{}},\"comment\":{}}],[\"customerstatus\",{\"_index\":73,\"name\":{\"160\":{}},\"comment\":{}}],[\"data\",{\"_index\":104,\"name\":{\"221\":{},\"223\":{},\"227\":{}},\"comment\":{}}],[\"datetime\",{\"_index\":30,\"name\":{\"43\":{}},\"comment\":{}}],[\"defaultissuepriority\",{\"_index\":42,\"name\":{\"83\":{},\"100\":{}},\"comment\":{}}],[\"deletedat\",{\"_index\":43,\"name\":{\"88\":{}},\"comment\":{}}],[\"deletedcustomeractor\",{\"_index\":31,\"name\":{\"47\":{}},\"comment\":{}}],[\"email\",{\"_index\":18,\"name\":{\"20\":{},\"23\":{},\"203\":{},\"209\":{},\"258\":{}},\"comment\":{}}],[\"emailaddress\",{\"_index\":94,\"name\":{\"198\":{}},\"comment\":{}}],[\"emailaddressinput\",{\"_index\":116,\"name\":{\"256\":{}},\"comment\":{}}],[\"err\",{\"_index\":106,\"name\":{\"225\":{},\"251\":{}},\"comment\":{}}],[\"error\",{\"_index\":105,\"name\":{\"224\":{},\"228\":{}},\"comment\":{}}],[\"errordetails\",{\"_index\":111,\"name\":{\"246\":{}},\"comment\":{}}],[\"exact\",{\"_index\":60,\"name\":{\"129\":{}},\"comment\":{}}],[\"externalid\",{\"_index\":16,\"name\":{\"18\":{},\"199\":{},\"204\":{},\"210\":{}},\"comment\":{}}],[\"fields\",{\"_index\":51,\"name\":{\"115\":{}},\"comment\":{}}],[\"float\",{\"_index\":102,\"name\":{\"219\":{}},\"comment\":{}}],[\"forbidden\",{\"_index\":86,\"name\":{\"186\":{}},\"comment\":{}}],[\"forbiddenerror\",{\"_index\":107,\"name\":{\"229\":{}},\"comment\":{}}],[\"fullname\",{\"_index\":14,\"name\":{\"16\":{},\"205\":{},\"211\":{}},\"comment\":{}}],[\"getcustomerbyid\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"graphqlerrors\",{\"_index\":109,\"name\":{\"237\":{}},\"comment\":{}}],[\"id\",{\"_index\":13,\"name\":{\"15\":{},\"55\":{},\"61\":{},\"80\":{},\"97\":{},\"215\":{}},\"comment\":{}}],[\"identifier\",{\"_index\":62,\"name\":{\"132\":{}},\"comment\":{}}],[\"idle\",{\"_index\":75,\"name\":{\"162\":{}},\"comment\":{}}],[\"inputmaybe\",{\"_index\":103,\"name\":{\"220\":{}},\"comment\":{}}],[\"int\",{\"_index\":101,\"name\":{\"218\":{}},\"comment\":{}}],[\"internal\",{\"_index\":56,\"name\":{\"124\":{},\"187\":{}},\"comment\":{}}],[\"internalactor\",{\"_index\":32,\"name\":{\"51\":{}},\"comment\":{}}],[\"internalactorparts_customeractor_fragment\",{\"_index\":77,\"name\":{\"164\":{}},\"comment\":{}}],[\"internalactorparts_deletedcustomeractor_fragment\",{\"_index\":78,\"name\":{\"167\":{}},\"comment\":{}}],[\"internalactorparts_machineuseractor_fragment\",{\"_index\":79,\"name\":{\"170\":{}},\"comment\":{}}],[\"internalactorparts_systemactor_fragment\",{\"_index\":80,\"name\":{\"174\":{}},\"comment\":{}}],[\"internalactorparts_useractor_fragment\",{\"_index\":81,\"name\":{\"178\":{}},\"comment\":{}}],[\"internalservererror\",{\"_index\":110,\"name\":{\"238\":{}},\"comment\":{}}],[\"isarchived\",{\"_index\":41,\"name\":{\"82\":{},\"99\":{}},\"comment\":{}}],[\"iso8601\",{\"_index\":22,\"name\":{\"29\":{},\"35\":{},\"40\":{},\"46\":{},\"70\":{},\"76\":{}},\"comment\":{}}],[\"issue\",{\"_index\":33,\"name\":{\"52\":{}},\"comment\":{}}],[\"issuekey\",{\"_index\":34,\"name\":{\"56\":{}},\"comment\":{}}],[\"issuepriority\",{\"_index\":44,\"name\":{\"89\":{}},\"comment\":{}}],[\"issuestatus\",{\"_index\":82,\"name\":{\"182\":{}},\"comment\":{}}],[\"issuetype\",{\"_index\":39,\"name\":{\"77\":{},\"94\":{}},\"comment\":{}}],[\"issuetypeid\",{\"_index\":66,\"name\":{\"138\":{}},\"comment\":{}}],[\"isverified\",{\"_index\":19,\"name\":{\"24\":{},\"259\":{}},\"comment\":{}}],[\"label\",{\"_index\":36,\"name\":{\"65\":{},\"86\":{},\"92\":{},\"103\":{}},\"comment\":{}}],[\"lastidleat\",{\"_index\":26,\"name\":{\"36\":{}},\"comment\":{}}],[\"machineuseractor\",{\"_index\":45,\"name\":{\"105\":{}},\"comment\":{}}],[\"machineuserid\",{\"_index\":46,\"name\":{\"108\":{},\"151\":{},\"173\":{}},\"comment\":{}}],[\"markedasspamat\",{\"_index\":29,\"name\":{\"42\":{}},\"comment\":{}}],[\"maybe\",{\"_index\":119,\"name\":{\"266\":{}},\"comment\":{}}],[\"message\",{\"_index\":48,\"name\":{\"112\":{},\"232\":{},\"236\":{},\"241\":{},\"245\":{},\"250\":{}},\"comment\":{}}],[\"mutationerror\",{\"_index\":47,\"name\":{\"109\":{},\"242\":{}},\"comment\":{}}],[\"mutationerrortype\",{\"_index\":85,\"name\":{\"185\":{}},\"comment\":{}}],[\"mutationfielderrortype\",{\"_index\":88,\"name\":{\"189\":{}},\"comment\":{}}],[\"notfound\",{\"_index\":89,\"name\":{\"190\":{}},\"comment\":{}}],[\"oncreate\",{\"_index\":63,\"name\":{\"133\":{}},\"comment\":{}}],[\"onupdate\",{\"_index\":64,\"name\":{\"134\":{}},\"comment\":{}}],[\"open\",{\"_index\":83,\"name\":{\"183\":{}},\"comment\":{}}],[\"optionalstringinput\",{\"_index\":117,\"name\":{\"260\":{}},\"comment\":{}}],[\"plaingraphqlerror\",{\"_index\":120,\"name\":{\"267\":{},\"268\":{}},\"comment\":{}}],[\"plainsdkclient\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"plainsdkerror\",{\"_index\":92,\"name\":{\"194\":{}},\"comment\":{}}],[\"priority\",{\"_index\":35,\"name\":{\"62\":{}},\"comment\":{}}],[\"priorityvalue\",{\"_index\":67,\"name\":{\"139\":{}},\"comment\":{}}],[\"publicname\",{\"_index\":40,\"name\":{\"81\":{},\"98\":{}},\"comment\":{}}],[\"rawrequest\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"required\",{\"_index\":90,\"name\":{\"191\":{}},\"comment\":{}}],[\"resolved\",{\"_index\":84,\"name\":{\"184\":{}},\"comment\":{}}],[\"result\",{\"_index\":91,\"name\":{\"193\":{}},\"comment\":{}}],[\"scalars\",{\"_index\":98,\"name\":{\"213\":{}},\"comment\":{}}],[\"sdkresult\",{\"_index\":59,\"name\":{\"128\":{}},\"comment\":{}}],[\"shortname\",{\"_index\":15,\"name\":{\"17\":{},\"206\":{},\"212\":{}},\"comment\":{}}],[\"snoozed\",{\"_index\":76,\"name\":{\"163\":{}},\"comment\":{}}],[\"status\",{\"_index\":17,\"name\":{\"19\":{},\"57\":{}},\"comment\":{}}],[\"statuschangedat\",{\"_index\":21,\"name\":{\"26\":{}},\"comment\":{}}],[\"string\",{\"_index\":99,\"name\":{\"216\":{}},\"comment\":{}}],[\"stringinput\",{\"_index\":118,\"name\":{\"263\":{}},\"comment\":{}}],[\"systemactor\",{\"_index\":52,\"name\":{\"116\":{}},\"comment\":{}}],[\"systemid\",{\"_index\":53,\"name\":{\"119\":{},\"155\":{},\"177\":{}},\"comment\":{}}],[\"type\",{\"_index\":49,\"name\":{\"113\":{}},\"comment\":{}}],[\"unknownerror\",{\"_index\":112,\"name\":{\"247\":{}},\"comment\":{}}],[\"updatedat\",{\"_index\":25,\"name\":{\"32\":{},\"67\":{}},\"comment\":{}}],[\"updatedby\",{\"_index\":38,\"name\":{\"71\":{}},\"comment\":{}}],[\"upsertcustomer\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"upsertcustomeridentifierinput\",{\"_index\":93,\"name\":{\"195\":{}},\"comment\":{}}],[\"upsertcustomerinput\",{\"_index\":61,\"name\":{\"130\":{}},\"comment\":{}}],[\"upsertcustomeroncreateinput\",{\"_index\":95,\"name\":{\"200\":{}},\"comment\":{}}],[\"upsertcustomeronupdateinput\",{\"_index\":97,\"name\":{\"207\":{}},\"comment\":{}}],[\"useractor\",{\"_index\":54,\"name\":{\"120\":{}},\"comment\":{}}],[\"userid\",{\"_index\":55,\"name\":{\"123\":{},\"159\":{},\"181\":{}},\"comment\":{}}],[\"validation\",{\"_index\":87,\"name\":{\"188\":{},\"192\":{}},\"comment\":{}}],[\"value\",{\"_index\":37,\"name\":{\"66\":{},\"87\":{},\"93\":{},\"104\":{},\"262\":{},\"265\":{}},\"comment\":{}}],[\"verifiedat\",{\"_index\":20,\"name\":{\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 18b4f8f..0000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1367 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: var(--light-color-ts-type-alias); - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: inline-flex; - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/classes/PlainSDKClient.html b/docs/classes/PlainSDKClient.html deleted file mode 100644 index f7f8e30..0000000 --- a/docs/classes/PlainSDKClient.html +++ /dev/null @@ -1,378 +0,0 @@ -PlainSDKClient | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class PlainSDKClient

-
-

Hierarchy

-
    -
  • PlainSDKClient
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
#ctx -
-
-

Methods

-
createIssue -getCustomerById -rawRequest -upsertCustomer -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Private #ctx

-
#ctx: Context
-
-

Methods

-
-

createIssue

-
-
-

getCustomerById

-
-
-

rawRequest

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      args: {
          query: string;
          variables: Record<string, unknown>;
      }
      -
        -
      • -
        query: string
        • -
      • -
        variables: Record<string, unknown>
    -

    Returns SDKResult<unknown>

-
-

upsertCustomer

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ParseStatus.html b/docs/classes/_internal_.ParseStatus.html deleted file mode 100644 index c6b8634..0000000 --- a/docs/classes/_internal_.ParseStatus.html +++ /dev/null @@ -1,373 +0,0 @@ -ParseStatus | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ParseStatus

-
-

Hierarchy

-
    -
  • ParseStatus
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
value -
-
-

Methods

-
abort -dirty -mergeArray -mergeObjectAsync -mergeObjectSync -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

value

-
value: "valid" | "dirty" | "aborted"
-
-

Methods

-
-

abort

-
    - -
  • -

    Returns void

-
-

dirty

-
    - -
  • -

    Returns void

-
-

Static mergeArray

-
-
-

Static mergeObjectAsync

-
-
-

Static mergeObjectSync

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodArray-1.html b/docs/classes/_internal_.ZodArray-1.html deleted file mode 100644 index fd4e7cd..0000000 --- a/docs/classes/_internal_.ZodArray-1.html +++ /dev/null @@ -1,1158 +0,0 @@ -ZodArray | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodArray<T, Cardinality>

-
-

Type Parameters

-
-
-

Hierarchy

-
    -
  • ZodType<arrayOutputType<T, Cardinality>, ZodArrayDef<T>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]> -
      -
    • ZodArray
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -element -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -length -max -min -nonempty -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodArrayDef<T>
-
-

Readonly _input

-
_input: Cardinality extends "atleastone"
    ? [T["_input"], ...T["_input"][]]
    : T["_input"][]
-
-

Readonly _output

-
_output: arrayOutputType<T, Cardinality>
-
-

Readonly _type

-
_type: arrayOutputType<T, Cardinality>
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<Cardinality extends "atleastone"
    ? [T["_input"], ...T["_input"][]]
    : T["_input"][], arrayOutputType<T, Cardinality>>>)
-
-

Type declaration

-
    -
  • -
      -
    • (data, params?): Promise<SafeParseReturnType<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][], arrayOutputType<T, Cardinality>>>
      • -
    • -
      -

      Parameters

      -
      -

      Returns Promise<SafeParseReturnType<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][], arrayOutputType<T, Cardinality>>>

-
-

Static create

-
create: (<T_1>(schema, params?) => ZodArray<T_1, "many">)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(schema, params?): ZodArray<T_1, "many">
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        T_1 extends ZodType<any, any, any, T_1>

      -
      -

      Parameters

      -
      -

      Returns ZodArray<T_1, "many">

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

element

-
    -
  • get element(): T
    • -
  • -

    Returns T

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodArray<T, Cardinality>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodCatch<ZodArray<T, Cardinality>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => arrayOutputType<T, Cardinality>)
      -
        -
      • -
          -
        • (ctx): arrayOutputType<T, Cardinality>
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: Cardinality extends "atleastone"
                    ? [T["_input"], ...T["_input"][]]
                    : T["_input"][];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: Cardinality extends "atleastone"
                  ? [T["_input"], ...T["_input"][]]
                  : T["_input"][]
          -

          Returns arrayOutputType<T, Cardinality>

    -

    Returns ZodCatch<ZodArray<T, Cardinality>>

-
-

default

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: noUndefined<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][]>
    -

    Returns ZodDefault<ZodArray<T, Cardinality>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: (() => noUndefined<Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][]>)
      -
        -
      • -
          -
        • (): noUndefined<Cardinality extends "atleastone"
              ? [T["_input"], ...T["_input"][]]
              : T["_input"][]>
          • -
        • -

          Returns noUndefined<Cardinality extends "atleastone"
              ? [T["_input"], ...T["_input"][]]
              : T["_input"][]>

    -

    Returns ZodDefault<ZodArray<T, Cardinality>>

-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodArray<T, Cardinality>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

length

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodArray<T, Cardinality>

-
-

max

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      maxLength: number
      • -
    • -
      Optional message: ErrMessage
    -

    Returns ZodArray<T, Cardinality>

-
-

min

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      minLength: number
      • -
    • -
      Optional message: ErrMessage
    -

    Returns ZodArray<T, Cardinality>

-
-

nonempty

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodArray<T, "atleastone">

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodArray<T, Cardinality>, T]>

-
-

parse

-
-
-

parseAsync

-
-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

-
-

safeParse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns SafeParseReturnType<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][], arrayOutputType<T, Cardinality>>

-
-

safeParseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<SafeParseReturnType<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][], arrayOutputType<T, Cardinality>>>

-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
    -

    Returns ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodArray<T, Cardinality>, NewOut, Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodBranded-1.html b/docs/classes/_internal_.ZodBranded-1.html deleted file mode 100644 index 48cc0ef..0000000 --- a/docs/classes/_internal_.ZodBranded-1.html +++ /dev/null @@ -1,1065 +0,0 @@ -ZodBranded | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodBranded<T, B>

-
-

Type Parameters

-
    -
  • -

    T extends ZodTypeAny

    • -
  • -

    B extends string | number | symbol

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -unwrap -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

      • -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
    -

    Returns ZodBranded<T, B>

-
-

Properties

-
-

Readonly _def

-
_def: ZodBrandedDef<T>
-
-

Readonly _input

-
_input: T["_input"]
-
-

Readonly _output

-
_output: T["_output"] & BRAND<B>
-
-

Readonly _type

-
_type: T["_output"] & BRAND<B>
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<T["_input"], T["_output"] & BRAND<B>>>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodBranded<T, B>, B>

-
-

catch

-
-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodBranded<T, B>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns T["_output"] & BRAND<B>

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T["_output"] & BRAND<B>>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"] & BRAND<B>
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"] & BRAND<B>
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodBranded<T, B>, T["_output"] & BRAND<B>, T["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodBranded<T, B>, T["_output"] & BRAND<B>, T["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodBranded<T, B>, NewOut, T["_input"]>

-
-

unwrap

-
    - -
  • -

    Returns T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodCatch-1.html b/docs/classes/_internal_.ZodCatch-1.html deleted file mode 100644 index b96b76b..0000000 --- a/docs/classes/_internal_.ZodCatch-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodCatch | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodCatch<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -removeCatch -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodCatchDef<T>
-
-

Readonly _input

-
_input: unknown
-
-

Readonly _output

-
_output: T["_output"]
-
-

Readonly _type

-
_type: T["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<unknown, T["_output"]>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(type, params) => ZodCatch<T_1>)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(type, params): ZodCatch<T_1>
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        T_1 extends ZodType<any, any, any, T_1>

      -
      -

      Parameters

      -
        -
      • -
        type: T_1
        • -
      • -
        params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            catch: T_1["_output"] | (() => T_1["_output"]);
        }
      -

      Returns ZodCatch<T_1>

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodCatch<T>, T["_output"], unknown>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodCatch<T>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: T["_output"]
    -

    Returns ZodCatch<ZodCatch<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => T["_output"])
      -
        -
      • -
          -
        • (ctx): T["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: unknown;
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: unknown
          -

          Returns T["_output"]

    -

    Returns ZodCatch<ZodCatch<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodCatch<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodCatch<T>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns T["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

-
-

removeCatch

-
    - -
  • -

    Returns T

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodCatch<T>, RefinedOutput, unknown>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodCatch<T>, T["_output"], unknown>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodCatch<T>, NewOut, unknown>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodDefault-1.html b/docs/classes/_internal_.ZodDefault-1.html deleted file mode 100644 index 135a64c..0000000 --- a/docs/classes/_internal_.ZodDefault-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodDefault | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodDefault<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -removeDefault -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodDefaultDef<T>
-
-

Readonly _input

-
_input: undefined | T["_input"]
-
-

Readonly _output

-
_output: noUndefined<T["_output"]>
-
-

Readonly _type

-
_type: noUndefined<T["_output"]>
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<undefined | T["_input"], noUndefined<T["_output"]>>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(type, params) => ZodDefault<T_1>)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(type, params): ZodDefault<T_1>
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        T_1 extends ZodType<any, any, any, T_1>

      -
      -

      Parameters

      -
        -
      • -
        type: T_1
        • -
      • -
        params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            default: T_1["_input"] | (() => noUndefined<T_1["_input"]>);
        }
      -

      Returns ZodDefault<T_1>

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodDefault<T>, B>

-
-

catch

-
-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodDefault<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
-
-

parseAsync

-
-
-

pipe

-
-
-

promise

-
-
-

refine

-
-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodDefault<T>, RefinedOutput, undefined | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodDefault<T>, noUndefined<T["_output"]>, undefined | T["_input"]>

-
-

removeDefault

-
    - -
  • -

    Returns T

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodDefault<T>, RefinedOutput, undefined | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
    -

    Returns ZodEffects<ZodDefault<T>, noUndefined<T["_output"]>, undefined | T["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodDefault<T>, NewOut, undefined | T["_input"]>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodEffects-1.html b/docs/classes/_internal_.ZodEffects-1.html deleted file mode 100644 index 21d0d0c..0000000 --- a/docs/classes/_internal_.ZodEffects-1.html +++ /dev/null @@ -1,1148 +0,0 @@ -ZodEffects | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodEffects<T, Output, Input>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -createWithPreprocess -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -innerType -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -sourceType -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodEffectsDef<T>
-
-

Readonly _input

-
_input: Input
-
-

Readonly _output

-
_output: Output
-
-

Readonly _type

-
_type: Output
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<I>(schema, effect, params?) => ZodEffects<I, I["_output"], input<I>>)
-
-

Type declaration

-
-
-

Static createWithPreprocess

-
createWithPreprocess: (<I>(preprocess, schema, params?) => ZodEffects<I, I["_output"], unknown>)
-
-

Type declaration

-
    -
  • -
      -
    • <I>(preprocess, schema, params?): ZodEffects<I, I["_output"], unknown>
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        I extends ZodType<any, any, any, I>

      -
      -

      Parameters

      -
        -
      • -
        preprocess: ((arg) => unknown)
        -
          -
        • -
            -
          • (arg): unknown
            • -
          • -
            -

            Parameters

            -
              -
            • -
              arg: unknown
            -

            Returns unknown

        • -
      • -
        schema: I
        • -
      • -
        Optional params: RawCreateParams
      -

      Returns ZodEffects<I, I["_output"], unknown>

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodEffects<T, Output, Input>, Output, Input>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodEffects<T, Output, Input>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: Output
    -

    Returns ZodCatch<ZodEffects<T, Output, Input>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => Output)
      -
        -
      • -
          -
        • (ctx): Output
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: Input
          -

          Returns Output

    -

    Returns ZodCatch<ZodEffects<T, Output, Input>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodEffects<T, Output, Input>

-
-

innerType

-
    - -
  • -

    Returns T

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodEffects<T, Output, Input>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Output

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<Output>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

sourceType

-
    - -
  • -

    Returns T

-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, Output, Input>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodEffects<T, Output, Input>, NewOut, Input>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodEnum-1.html b/docs/classes/_internal_.ZodEnum-1.html deleted file mode 100644 index dbcc8d4..0000000 --- a/docs/classes/_internal_.ZodEnum-1.html +++ /dev/null @@ -1,1177 +0,0 @@ -ZodEnum | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodEnum<T>

-
-

Type Parameters

-
    -
  • -

    T extends [string, ...string[]]

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
Enum -Values -description -enum -options -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -exclude -extract -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends [string, ...string[]]

    -
    -

    Parameters

    -
    -

    Returns ZodEnum<T>

-
-

Properties

-
-

Readonly _def

-
_def: ZodEnumDef<T>
-
-

Readonly _input

-
_input: T[number]
-
-

Readonly _output

-
_output: T[number]
-
-

Readonly _type

-
_type: T[number]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<T[number], T[number]>>)
-
-

Type declaration

-
-
-

Static create

-
create: {
    <U, T>(values, params?): ZodEnum<Writeable<T>>;
    <U, T>(values, params?): ZodEnum<T>;
}
-
-

Type declaration

-
    -
  • -
      -
    • <U, T>(values, params?): ZodEnum<Writeable<T>>
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        U extends string

        • -
      • -

        T extends readonly [U, U, T]

      -
      -

      Parameters

      -
      -

      Returns ZodEnum<Writeable<T>>

      • -
    • <U, T>(values, params?): ZodEnum<T>
      • -
    • -
      -

      Type Parameters

      -
        -
      • -

        U extends string

        • -
      • -

        T extends [U, ...U[]]

      -
      -

      Parameters

      -
      -

      Returns ZodEnum<T>

-
-

Accessors

-
-

Enum

-
    -
  • get Enum(): Values<T>
    • -
  • -

    Returns Values<T>

-
-

Values

-
    -
  • get Values(): Values<T>
    • -
  • -

    Returns Values<T>

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

enum

-
    -
  • get enum(): Values<T>
    • -
  • -

    Returns Values<T>

-
-

options

-
    -
  • get options(): T
    • -
  • -

    Returns T

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodEnum<T>, T[number], T[number]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodEnum<T>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: T[number]
    -

    Returns ZodCatch<ZodEnum<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => T[number])
      -
        -
      • -
          -
        • (ctx): T[number]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: T[number];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: T[number]
          -

          Returns T[number]

    -

    Returns ZodCatch<ZodEnum<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodEnum<T>

-
-

exclude

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      ToExclude extends readonly [T[number], T[number], ToExclude]

    -
    -

    Parameters

    -
      -
    • -
      values: ToExclude
    -

    Returns ZodEnum<typecast<Writeable<FilterEnum<T, ToExclude[number]>>, [string, ...string[]]>>

-
-

extract

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      ToExtract extends readonly [T[number], T[number], ToExtract]

    -
    -

    Parameters

    -
      -
    • -
      values: ToExtract
    -

    Returns ZodEnum<Writeable<ToExtract>>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodEnum<T>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns T[number]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T[number]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends string

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends string

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends string

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodEnum<T>, RefinedOutput, T[number]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodEnum<T>, T[number], T[number]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodEnum<T>, NewOut, T[number]>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodError.html b/docs/classes/_internal_.ZodError.html deleted file mode 100644 index af5667f..0000000 --- a/docs/classes/_internal_.ZodError.html +++ /dev/null @@ -1,589 +0,0 @@ -ZodError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodError<T>

-
-

Type Parameters

-
    -
  • -

    T = any

-
-

Hierarchy

-
    -
  • Error -
      -
    • ZodError
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
addIssue -addIssues -cause? -issues -name -stack? -create -prepareStackTrace? -stackTraceLimit -
-
-

Accessors

-
errors -formErrors -isEmpty -message -
-
-

Methods

-
flatten -format -toString -captureStackTrace -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T = any

    -
    -

    Parameters

    -
    -

    Returns ZodError<T>

-
-

Properties

-
-

addIssue

-
addIssue: ((sub) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (sub): void
      • -
    • -
      -

      Parameters

      -
      -

      Returns void

-
-

addIssues

-
addIssues: ((subs?) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (subs?): void
      • -
    • -
      -

      Parameters

      -
      -

      Returns void

-
-

Optional cause

-
cause?: unknown
-
-

issues

-
issues: ZodIssue[]
-
-

name

-
name: string
-
-

Optional stack

-
stack?: string
-
-

Static create

-
create: ((issues) => ZodError<any>)
-
-

Type declaration

-
-
-

Static Optional prepareStackTrace

-
prepareStackTrace?: ((err, stackTraces) => any)
-
-

Type declaration

-
-
-

Static stackTraceLimit

-
stackTraceLimit: number
-
-

Accessors

-
-

errors

-
    -
  • get errors(): ZodIssue[]
    • -
  • -

    Returns ZodIssue[]

-
-

formErrors

-
-
-

isEmpty

-
    -
  • get isEmpty(): boolean
    • -
  • -

    Returns boolean

-
-

message

-
    -
  • get message(): string
    • -
  • -

    Returns string

-
-

Methods

-
-

flatten

-
-
-

format

-
    - -
  • -

    Returns ZodFormattedError<T, string>

    • - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      mapper: ((issue) => U)
      -
        -
      • -
          -
        • (issue): U
          • -
        • -
          -

          Parameters

          -
          -

          Returns U

    -

    Returns ZodFormattedError<T, U>

-
-

toString

-
    - -
  • -

    Returns string

-
-

Static captureStackTrace

-
    - -
  • -

    Create .stack property on a target object

    -
    -
    -

    Parameters

    -
      -
    • -
      targetObject: object
      • -
    • -
      Optional constructorOpt: Function
    -

    Returns void

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodIntersection-1.html b/docs/classes/_internal_.ZodIntersection-1.html deleted file mode 100644 index 8ece211..0000000 --- a/docs/classes/_internal_.ZodIntersection-1.html +++ /dev/null @@ -1,1086 +0,0 @@ -ZodIntersection | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodIntersection<T, U>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodIntersectionDef<T, U>
-
-

Readonly _input

-
_input: T["_input"] & U["_input"]
-
-

Readonly _output

-
_output: T["_output"] & U["_output"]
-
-

Readonly _type

-
_type: T["_output"] & U["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<T["_input"] & U["_input"], T["_output"] & U["_output"]>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1, U_1>(left, right, params?) => ZodIntersection<T_1, U_1>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

-
-

and

-
-
-

array

-
-
-

brand

-
-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: T["_output"] & U["_output"]
    -

    Returns ZodCatch<ZodIntersection<T, U>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => T["_output"] & U["_output"])
      -
        -
      • -
          -
        • (ctx): T["_output"] & U["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: T["_input"] & U["_input"];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: T["_input"] & U["_input"]
          -

          Returns T["_output"] & U["_output"]

    -

    Returns ZodCatch<ZodIntersection<T, U>>

-
-

default

-
-
-

describe

-
-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns T["_output"] & U["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T["_output"] & U["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"] & U["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"] & U["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T["_output"] & U["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodIntersection<T, U>, RefinedOutput, T["_input"] & U["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodIntersection<T, U>, T["_output"] & U["_output"], T["_input"] & U["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodIntersection<T, U>, NewOut, T["_input"] & U["_input"]>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodNullable-1.html b/docs/classes/_internal_.ZodNullable-1.html deleted file mode 100644 index 11b0766..0000000 --- a/docs/classes/_internal_.ZodNullable-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodNullable | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodNullable<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -unwrap -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodNullableDef<T>
-
-

Readonly _input

-
_input: null | T["_input"]
-
-

Readonly _output

-
_output: null | T["_output"]
-
-

Readonly _type

-
_type: null | T["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<null | T["_input"], null | T["_output"]>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(type, params?) => ZodNullable<T_1>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

-
-

and

-
-
-

array

-
-
-

brand

-
-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: null | T["_output"]
    -

    Returns ZodCatch<ZodNullable<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => null | T["_output"])
      -
        -
      • -
          -
        • (ctx): null | T["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: null | T["_input"];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: null | T["_input"]
          -

          Returns null | T["_output"]

    -

    Returns ZodCatch<ZodNullable<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodNullable<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns null | T["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<null | T["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: null | T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: null | T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: null | T["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodNullable<T>, RefinedOutput, null | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodNullable<T>, NewOut, null | T["_input"]>

-
-

unwrap

-
    - -
  • -

    Returns T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodNumber-1.html b/docs/classes/_internal_.ZodNumber-1.html deleted file mode 100644 index 526daae..0000000 --- a/docs/classes/_internal_.ZodNumber-1.html +++ /dev/null @@ -1,1393 +0,0 @@ -ZodNumber | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodNumber

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -max -min -spa -step -create -
-
-

Accessors

-
description -isFinite -isInt -maxValue -minValue -
-
-

Methods

-
_addCheck -_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -finite -gt -gte -int -isNullable -isOptional -lt -lte -multipleOf -negative -nonnegative -nonpositive -nullable -nullish -optional -or -parse -parseAsync -pipe -positive -promise -refine -refinement -safe -safeParse -safeParseAsync -setLimit -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodNumberDef
-
-

Readonly _input

-
_input: number
-
-

Readonly _output

-
_output: number
-
-

Readonly _type

-
_type: number
-
-

max

-
max: ((value, message?) => ZodNumber)
-
-

Type declaration

-
-
-

min

-
min: ((value, message?) => ZodNumber)
-
-

Type declaration

-
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<number, number>>)
-
-

Type declaration

-
-
-

step

-
step: ((value, message?) => ZodNumber)
-
-

Type declaration

-
-
-

Static create

-
create: ((params?) => ZodNumber)
-
-

Type declaration

-
    -
  • -
      -
    • (params?): ZodNumber
      • -
    • -
      -

      Parameters

      -
        -
      • -
        Optional params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            coerce?: boolean;
        }
      -

      Returns ZodNumber

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

isFinite

-
    -
  • get isFinite(): boolean
    • -
  • -

    Returns boolean

-
-

isInt

-
    -
  • get isInt(): boolean
    • -
  • -

    Returns boolean

-
-

maxValue

-
    -
  • get maxValue(): null | number
    • -
  • -

    Returns null | number

-
-

minValue

-
    -
  • get minValue(): null | number
    • -
  • -

    Returns null | number

-
-

Methods

-
-

_addCheck

-
-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodNumber, B>

-
-

catch

-
-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodNumber

-
-

finite

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

gt

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

gte

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

int

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

lt

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

lte

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

multipleOf

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

negative

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

nonnegative

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

nonpositive

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns number

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<number>

-
-

pipe

-
-
-

positive

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

promise

-
-
-

refine

-
-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends number

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: number
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodNumber, RefinedOutput, number>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: number
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodNumber, number, number>

-
-

safe

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodNumber

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

Protected setLimit

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      kind: "min" | "max"
      • -
    • -
      value: number
      • -
    • -
      inclusive: boolean
      • -
    • -
      Optional message: string
    -

    Returns ZodNumber

-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends number

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodNumber, RefinedOutput, number>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodNumber, number, number>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodNumber, NewOut, number>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodObject-1.html b/docs/classes/_internal_.ZodObject-1.html deleted file mode 100644 index a177f09..0000000 --- a/docs/classes/_internal_.ZodObject-1.html +++ /dev/null @@ -1,1457 +0,0 @@ -ZodObject | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodObject<T, UnknownKeys, Catchall, Output, Input>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_cached -_def -_input -_output -_type -augment -nonstrict -spa -create -lazycreate -strictCreate -
-
-

Accessors

-
description -shape -
-
-

Methods

-
_getCached -_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -catchall -deepPartial -default -describe -extend -isNullable -isOptional -keyof -merge -nullable -nullish -omit -optional -or -parse -parseAsync -partial -passthrough -pick -pipe -promise -refine -refinement -required -safeParse -safeParseAsync -setKey -strict -strip -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Private _cached

-
_cached: any
-
-

Readonly _def

-
_def: ZodObjectDef<T, UnknownKeys, Catchall>
-
-

Readonly _input

-
_input: Input
-
-

Readonly _output

-
_output: Output
-
-

Readonly _type

-
_type: Output
-
-

augment

-
augment: (<Augmentation>(augmentation) => ZodObject<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, UnknownKeys, Catchall, objectOutputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>, objectInputType<{
    [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
}, Catchall, UnknownKeys>>)
-
-

Type declaration

-
    -
  • -
      -
    • <Augmentation>(augmentation): ZodObject<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, UnknownKeys, Catchall, objectOutputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>, objectInputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>>
      • -
    • -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
        -
      • -
        augmentation: Augmentation
      -

      Returns ZodObject<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, UnknownKeys, Catchall, objectOutputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>, objectInputType<{
          [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
      }, Catchall, UnknownKeys>>

-
-

nonstrict

-
nonstrict: (() => ZodObject<T, "passthrough", Catchall, objectOutputType<T, Catchall, "passthrough">, objectInputType<T, Catchall, "passthrough">>)
-
-

Type declaration

-
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • -
    • -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
      -

      Returns ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

-
-

Static lazycreate

-
lazycreate: (<T_1>(shape, params?) => ZodObject<T_1, "strip", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(shape, params?): ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • -
    • -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
        -
      • -
        shape: (() => T_1)
        -
          -
        • -
            -
          • (): T_1
            • -
          • -

            Returns T_1

        • -
      • -
        Optional params: RawCreateParams
      -

      Returns ZodObject<T_1, "strip", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

-
-

Static strictCreate

-
strictCreate: (<T_1>(shape, params?) => ZodObject<T_1, "strict", ZodTypeAny, {
    [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
        [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
            ? never
            : k
    }[keyof T_1]>[k_1]
}, {
    [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
}>)
-
-

Type declaration

-
    -
  • -
      -
    • <T_1>(shape, params?): ZodObject<T_1, "strict", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>
      • -
    • -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
      -

      Returns ZodObject<T_1, "strict", ZodTypeAny, {
          [k_1 in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T_1>, {
              [k in string | number | symbol]: undefined extends baseObjectOutputType<T_1>[k]
                  ? never
                  : k
          }[keyof T_1]>[k_1]
      }, {
          [k_2 in string | number | symbol]: baseObjectInputType<T_1>[k_2]
      }>

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

shape

-
    -
  • get shape(): T
    • -
  • -

    Returns T

-
-

Methods

-
-

_getCached

-
    -
  • _getCached(): {
        keys: string[];
        shape: T;
    }
    • -
  • -

    Returns {
        keys: string[];
        shape: T;
    }

    -
      -
    • -
      keys: string[]
      • -
    • -
      shape: T
-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

-
-

and

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      incoming: T
    -

    Returns ZodIntersection<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>

-
-

array

-
    - -
  • -

    Returns ZodArray<ZodObject<T, UnknownKeys, Catchall, Output, Input>, "many">

-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodObject<T, UnknownKeys, Catchall, Output, Input>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: Output
    -

    Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => Output)
      -
        -
      • -
          -
        • (ctx): Output
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: Input
          -

          Returns Output

    -

    Returns ZodCatch<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

-
-

catchall

-
-
-

deepPartial

-
    - -
  • -

    Returns DeepPartial<ZodObject<T, UnknownKeys, Catchall, Output, Input>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodObject<T, UnknownKeys, Catchall, Output, Input>

-
-

extend

-
    - -
  • -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      augmentation: Augmentation
    -

    Returns ZodObject<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Catchall, UnknownKeys>>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

keyof

-
-
-

merge

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Incoming extends ZodObject<any, any, any, {}, {}, Incoming>

      • -
    • -

      Augmentation extends any

    -
    -

    Parameters

    -
      -
    • -
      merging: Incoming
    -

    Returns ZodObject<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<{
        [k in string | number | symbol]: (Omit<T, keyof Augmentation> & Augmentation)[k]
    }, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>

-
-

nullable

-
-
-

nullish

-
-
-

omit

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Mask extends {
          [k in string | number | symbol]?: true
      }

    -
    -

    Parameters

    -
      -
    • -
      mask: Mask
    -

    Returns ZodObject<Omit<T, keyof Mask>, UnknownKeys, Catchall, objectOutputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>, objectInputType<Omit<T, keyof Mask>, Catchall, UnknownKeys>>

-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodObject<T, UnknownKeys, Catchall, Output, Input>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Output

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<Output>

-
-

partial

-
    - -
  • -

    Returns ZodObject<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: ZodOptional<T[k]>
    }, Catchall, UnknownKeys>>

    • - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Mask extends {
          [k in string | number | symbol]?: true
      }

    -
    -

    Parameters

    -
      -
    • -
      mask: Mask
    -

    Returns ZodObject<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? ZodOptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>>

-
-

passthrough

-
-
-

pick

-
-
-

pipe

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      target: T
    -

    Returns ZodPipeline<ZodObject<T, UnknownKeys, Catchall, Output, Input>, T>

-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

-
-

required

-
    - -
  • -

    Returns ZodObject<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: deoptional<T[k]>
    }, Catchall, UnknownKeys>>

    • - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Mask extends {
          [k in string | number | symbol]?: true
      }

    -
    -

    Parameters

    -
      -
    • -
      mask: Mask
    -

    Returns ZodObject<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, UnknownKeys, Catchall, objectOutputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>, objectInputType<{
        [k in string | number | symbol]: k extends keyof T
            ? {
                [k in string | number | symbol]: k extends keyof Mask
                    ? deoptional<T[k]>
                    : T[k]
            }[k]
            : never
    }, Catchall, UnknownKeys>>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

setKey

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Key extends string

      • -
    • -

      Schema extends ZodType<any, any, any, Schema>

    -
    -

    Parameters

    -
      -
    • -
      key: Key
      • -
    • -
      schema: Schema
    -

    Returns ZodObject<T & {
        [k in string]: Schema
    }, UnknownKeys, Catchall, objectOutputType<T & {
        [k in string]: Schema
    }, Catchall, UnknownKeys>, objectInputType<T & {
        [k in string]: Schema
    }, Catchall, UnknownKeys>>

-
-

strict

-
-
-

strip

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, Output, Input>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodObject<T, UnknownKeys, Catchall, Output, Input>, NewOut, Input>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodOptional-1.html b/docs/classes/_internal_.ZodOptional-1.html deleted file mode 100644 index a194a09..0000000 --- a/docs/classes/_internal_.ZodOptional-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodOptional | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodOptional<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -unwrap -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodOptionalDef<T>
-
-

Readonly _input

-
_input: undefined | T["_input"]
-
-

Readonly _output

-
_output: undefined | T["_output"]
-
-

Readonly _type

-
_type: undefined | T["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(type, params?) => ZodOptional<T_1>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

-
-

and

-
-
-

array

-
-
-

brand

-
-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: undefined | T["_output"]
    -

    Returns ZodCatch<ZodOptional<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => undefined | T["_output"])
      -
        -
      • -
          -
        • (ctx): undefined | T["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: undefined | T["_input"];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: undefined | T["_input"]
          -

          Returns undefined | T["_output"]

    -

    Returns ZodCatch<ZodOptional<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodOptional<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns undefined | T["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<undefined | T["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: undefined | T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: undefined | T["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: undefined | T["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>

-
-

unwrap

-
    - -
  • -

    Returns T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodPipeline-1.html b/docs/classes/_internal_.ZodPipeline-1.html deleted file mode 100644 index 3c35664..0000000 --- a/docs/classes/_internal_.ZodPipeline-1.html +++ /dev/null @@ -1,1079 +0,0 @@ -ZodPipeline | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodPipeline<A, B>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -create -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodPipelineDef<A, B>
-
-

Readonly _input

-
_input: A["_input"]
-
-

Readonly _output

-
_output: B["_output"]
-
-

Readonly _type

-
_type: B["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<A["_input"], B["_output"]>>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodPipeline<A, B>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: B["_output"]
    -

    Returns ZodCatch<ZodPipeline<A, B>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => B["_output"])
      -
        -
      • -
          -
        • (ctx): B["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: A["_input"];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: A["_input"]
          -

          Returns B["_output"]

    -

    Returns ZodCatch<ZodPipeline<A, B>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodPipeline<A, B>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns B["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<B["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: B["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: B["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: B["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodPipeline<A, B>, NewOut, A["_input"]>

-
-

Static create

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      A extends ZodType<any, any, any, A>

      • -
    • -

      B extends ZodType<any, any, any, B>

    -
    -

    Parameters

    -
      -
    • -
      a: A
      • -
    • -
      b: B
    -

    Returns ZodPipeline<A, B>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodPromise-1.html b/docs/classes/_internal_.ZodPromise-1.html deleted file mode 100644 index 4bff6a4..0000000 --- a/docs/classes/_internal_.ZodPromise-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodPromise | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodPromise<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -unwrap -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodPromiseDef<T>
-
-

Readonly _input

-
_input: Promise<T["_input"]>
-
-

Readonly _output

-
_output: Promise<T["_output"]>
-
-

Readonly _type

-
_type: Promise<T["_output"]>
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<Promise<T["_input"]>, Promise<T["_output"]>>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(schema, params?) => ZodPromise<T_1>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodPromise<T>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: Promise<T["_output"]>
    -

    Returns ZodCatch<ZodPromise<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => Promise<T["_output"]>)
      -
        -
      • -
          -
        • (ctx): Promise<T["_output"]>
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: Promise<T["_input"]>;
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: Promise<T["_input"]>
          -

          Returns Promise<T["_output"]>

    -

    Returns ZodCatch<ZodPromise<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodPromise<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T["_output"]>

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<Promise<T["_output"]>>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Promise<T["_output"]>
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Promise<T["_output"]>
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Promise<T["_output"]>
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends Promise<T["_output"], RefinedOutput>

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodPromise<T>, RefinedOutput, Promise<T["_input"]>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodPromise<T>, Promise<T["_output"]>, Promise<T["_input"]>>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodPromise<T>, NewOut, Promise<T["_input"]>>

-
-

unwrap

-
    - -
  • -

    Returns T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodString-1.html b/docs/classes/_internal_.ZodString-1.html deleted file mode 100644 index 1232ca6..0000000 --- a/docs/classes/_internal_.ZodString-1.html +++ /dev/null @@ -1,1534 +0,0 @@ -ZodString | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodString

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_regex -_type -nonempty -spa -toLowerCase -toUpperCase -trim -create -
-
-

Accessors

-
description -isCUID -isCUID2 -isDatetime -isEmail -isEmoji -isIP -isULID -isURL -isUUID -maxLength -minLength -
-
-

Methods

-
_addCheck -_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -cuid -cuid2 -datetime -default -describe -email -emoji -endsWith -includes -ip -isNullable -isOptional -length -max -min -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -regex -safeParse -safeParseAsync -startsWith -superRefine -transform -ulid -url -uuid -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodStringDef
-
-

Readonly _input

-
_input: string
-
-

Readonly _output

-
_output: string
-
-

Protected _regex

-
_regex: ((regex, validation, message?) => ZodEffects<ZodString, string, string>)
-
-

Type declaration

-
-
-

Readonly _type

-
_type: string
-
-

nonempty

-
nonempty: ((message?) => ZodString)
-
-

Type declaration

-
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<string, string>>)
-
-

Type declaration

-
-
-

toLowerCase

-
toLowerCase: (() => ZodString)
-
-

Type declaration

-
-
-

toUpperCase

-
toUpperCase: (() => ZodString)
-
-

Type declaration

-
-
-

trim

-
trim: (() => ZodString)
-
-

Type declaration

-
-
-

Static create

-
create: ((params?) => ZodString)
-
-

Type declaration

-
    -
  • -
      -
    • (params?): ZodString
      • -
    • -
      -

      Parameters

      -
        -
      • -
        Optional params: {
            description?: string;
            errorMap?: ZodErrorMap;
            invalid_type_error?: string;
            required_error?: string;
        } & {
            coerce?: true;
        }
      -

      Returns ZodString

-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

isCUID

-
    -
  • get isCUID(): boolean
    • -
  • -

    Returns boolean

-
-

isCUID2

-
    -
  • get isCUID2(): boolean
    • -
  • -

    Returns boolean

-
-

isDatetime

-
    -
  • get isDatetime(): boolean
    • -
  • -

    Returns boolean

-
-

isEmail

-
    -
  • get isEmail(): boolean
    • -
  • -

    Returns boolean

-
-

isEmoji

-
    -
  • get isEmoji(): boolean
    • -
  • -

    Returns boolean

-
-

isIP

-
    -
  • get isIP(): boolean
    • -
  • -

    Returns boolean

-
-

isULID

-
    -
  • get isULID(): boolean
    • -
  • -

    Returns boolean

-
-

isURL

-
    -
  • get isURL(): boolean
    • -
  • -

    Returns boolean

-
-

isUUID

-
    -
  • get isUUID(): boolean
    • -
  • -

    Returns boolean

-
-

maxLength

-
    -
  • get maxLength(): null | number
    • -
  • -

    Returns null | number

-
-

minLength

-
    -
  • get minLength(): null | number
    • -
  • -

    Returns null | number

-
-

Methods

-
-

_addCheck

-
-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodString, B>

-
-

catch

-
-
-

cuid

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

cuid2

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

datetime

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional options: string | {
          message?: string;
          offset?: boolean;
          precision?: null | number;
      }
    -

    Returns ZodString

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodString

-
-

email

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

emoji

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

endsWith

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

includes

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      value: string
      • -
    • -
      Optional options: {
          message?: string;
          position?: number;
      }
      -
        -
      • -
        Optional message?: string
        • -
      • -
        Optional position?: number
    -

    Returns ZodString

-
-

ip

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional options: string | {
          message?: string;
          version?: "v4" | "v6";
      }
    -

    Returns ZodString

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

length

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

max

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      maxLength: number
      • -
    • -
      Optional message: ErrMessage
    -

    Returns ZodString

-
-

min

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      minLength: number
      • -
    • -
      Optional message: ErrMessage
    -

    Returns ZodString

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<string>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends string

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: string
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodString, RefinedOutput, string>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: string
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodString, string, string>

-
-

regex

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

startsWith

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends string

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodString, RefinedOutput, string>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodString, string, string>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodString, NewOut, string>

-
-

ulid

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

url

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-

uuid

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns ZodString

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodTuple-1.html b/docs/classes/_internal_.ZodTuple-1.html deleted file mode 100644 index 1cd7811..0000000 --- a/docs/classes/_internal_.ZodTuple-1.html +++ /dev/null @@ -1,1112 +0,0 @@ -ZodTuple | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodTuple<T, Rest>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -items -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -rest -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodTupleDef<T, Rest>
-
-

Readonly _input

-
_input: InputTypeOfTupleWithRest<T, Rest>
-
-

Readonly _output

-
_output: OutputTypeOfTupleWithRest<T, Rest>
-
-

Readonly _type

-
_type: OutputTypeOfTupleWithRest<T, Rest>
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(schemas, params?) => ZodTuple<T_1, null>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

items

-
    -
  • get items(): T
    • -
  • -

    Returns T

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodTuple<T, Rest>, B>

-
-

catch

-
-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodTuple<T, Rest>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodTuple<T, Rest>, T]>

-
-

parse

-
-
-

parseAsync

-
-
-

pipe

-
-
-

promise

-
-
-

refine

-
-
-

refinement

-
-
-

rest

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Rest extends ZodType<any, any, any, Rest>

    -
    -

    Parameters

    -
      -
    • -
      rest: Rest
    -

    Returns ZodTuple<T, Rest>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
-
-

transform

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodType.html b/docs/classes/_internal_.ZodType.html deleted file mode 100644 index f1aa566..0000000 --- a/docs/classes/_internal_.ZodType.html +++ /dev/null @@ -1,1033 +0,0 @@ -ZodType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodType<Output, Def, Input>Abstract

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -
-
-

Accessors

-
description -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      def: Def
    -

    Returns ZodType<Output, Def, Input>

-
-

Properties

-
-

Readonly _def

-
_def: Def
-
-

Readonly _input

-
_input: Input
-
-

Readonly _output

-
_output: Output
-
-

Readonly _type

-
_type: Output
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

Abstract _parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

-
-

and

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      incoming: T
    -

    Returns ZodIntersection<ZodType<Output, Def, Input>, T>

-
-

array

-
    - -
  • -

    Returns ZodArray<ZodType<Output, Def, Input>, "many">

-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodType<Output, Def, Input>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: Output
    -

    Returns ZodCatch<ZodType<Output, Def, Input>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => Output)
      -
        -
      • -
          -
        • (ctx): Output
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: Input;
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: Input
          -

          Returns Output

    -

    Returns ZodCatch<ZodType<Output, Def, Input>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodType<Output, Def, Input>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodType<Output, Def, Input>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Output

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<Output>

-
-

pipe

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      target: T
    -

    Returns ZodPipeline<ZodType<Output, Def, Input>, T>

-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | ((arg) => Partial<Omit<ZodCustomIssue, "code">>) | Partial<Omit<ZodCustomIssue, "code">>
    -

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: Output
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/_internal_.ZodUnion-1.html b/docs/classes/_internal_.ZodUnion-1.html deleted file mode 100644 index 80b2c3b..0000000 --- a/docs/classes/_internal_.ZodUnion-1.html +++ /dev/null @@ -1,1088 +0,0 @@ -ZodUnion | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Class ZodUnion<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
_def -_input -_output -_type -spa -create -
-
-

Accessors

-
description -options -
-
-

Methods

-
_getOrReturnCtx -_getType -_parse -_parseAsync -_parseSync -_processInputParams -_refinement -and -array -brand -catch -default -describe -isNullable -isOptional -nullable -nullish -optional -or -parse -parseAsync -pipe -promise -refine -refinement -safeParse -safeParseAsync -superRefine -transform -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly _def

-
_def: ZodUnionDef<T>
-
-

Readonly _input

-
_input: T[number]["_input"]
-
-

Readonly _output

-
_output: T[number]["_output"]
-
-

Readonly _type

-
_type: T[number]["_output"]
-
-

spa

-
spa: ((data, params?) => Promise<SafeParseReturnType<T[number]["_input"], T[number]["_output"]>>)
-
-

Type declaration

-
-
-

Static create

-
create: (<T_1>(types, params?) => ZodUnion<T_1>)
-
-

Type declaration

-
-
-

Accessors

-
-

description

-
    -
  • get description(): undefined | string
    • -
  • -

    Returns undefined | string

-
-

options

-
    -
  • get options(): T
    • -
  • -

    Returns T

-
-

Methods

-
-

_getOrReturnCtx

-
-
-

_getType

-
    -
  • _getType(input): string
    • -
  • -
    -

    Parameters

    -
    -

    Returns string

-
-

_parse

-
-
-

_parseAsync

-
-
-

_parseSync

-
-
-

_processInputParams

-
-
-

_refinement

-
    -
  • _refinement(refinement): ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>
    • -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => any)
      -
        -
      • -
          -
        • (arg, ctx): any
          • -
        • -
          -

          Parameters

          -
          -

          Returns any

    -

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

-
-

and

-
-
-

array

-
-
-

brand

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      B extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      Optional brand: B
    -

    Returns ZodBranded<ZodUnion<T>, B>

-
-

catch

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      def: T[number]["_output"]
    -

    Returns ZodCatch<ZodUnion<T>>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      def: ((ctx) => T[number]["_output"])
      -
        -
      • -
          -
        • (ctx): T[number]["_output"]
          • -
        • -
          -

          Parameters

          -
            -
          • -
            ctx: {
                error: ZodError<any>;
                input: T[number]["_input"];
            }
            -
              -
            • -
              error: ZodError<any>
              • -
            • -
              input: T[number]["_input"]
          -

          Returns T[number]["_output"]

    -

    Returns ZodCatch<ZodUnion<T>>

-
-

default

-
-
-

describe

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      description: string
    -

    Returns ZodUnion<T>

-
-

isNullable

-
    - -
  • -

    Returns boolean

-
-

isOptional

-
    - -
  • -

    Returns boolean

-
-

nullable

-
-
-

nullish

-
-
-

optional

-
-
-

or

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends ZodType<any, any, any, T>

    -
    -

    Parameters

    -
      -
    • -
      option: T
    -

    Returns ZodUnion<[ZodUnion<T>, T]>

-
-

parse

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns T[number]["_output"]

-
-

parseAsync

-
    - -
  • -
    -

    Parameters

    -
    -

    Returns Promise<T[number]["_output"]>

-
-

pipe

-
-
-

promise

-
-
-

refine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
    -

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • - -
  • -
    -

    Parameters

    -
    -

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

-
-

refinement

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]["_output"]
          -

          Returns arg is RefinedOutput

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      check: ((arg) => boolean)
      -
        -
      • -
          -
        • (arg): boolean
          • -
        • -
          -

          Parameters

          -
            -
          • -
            arg: T[number]["_output"]
          -

          Returns boolean

      • -
    • -
      refinementData: IssueData | ((arg, ctx) => IssueData)
    -

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

-
-

safeParse

-
-
-

safeParseAsync

-
-
-

superRefine

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      RefinedOutput extends any

    -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => arg is RefinedOutput)
      -
        -
      • -
          -
        • (arg, ctx): arg is RefinedOutput
          • -
        • -
          -

          Parameters

          -
          -

          Returns arg is RefinedOutput

    -

    Returns ZodEffects<ZodUnion<T>, RefinedOutput, T[number]["_input"]>

    • - -
  • -
    -

    Parameters

    -
      -
    • -
      refinement: ((arg, ctx) => void)
      -
        -
      • -
          -
        • (arg, ctx): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns ZodEffects<ZodUnion<T>, T[number]["_output"], T[number]["_input"]>

-
-

transform

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      NewOut

    -
    -

    Parameters

    -
      -
    • -
      transform: ((arg, ctx) => NewOut | Promise<NewOut>)
      -
        -
      • -
          -
        • (arg, ctx): NewOut | Promise<NewOut>
          • -
        • -
          -

          Parameters

          -
          -

          Returns NewOut | Promise<NewOut>

    -

    Returns ZodEffects<ZodUnion<T>, NewOut, T[number]["_input"]>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/_internal_.CustomerStatus.html b/docs/enums/_internal_.CustomerStatus.html deleted file mode 100644 index 97f38b2..0000000 --- a/docs/enums/_internal_.CustomerStatus.html +++ /dev/null @@ -1,303 +0,0 @@ -CustomerStatus | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Enumeration CustomerStatus

-
-

The core customer life cycle.

-
-
-
-
- -
-
-

Enumeration Members

-
Active -Idle -Snoozed -
-
-

Enumeration Members

-
-

Active

-
Active: "ACTIVE"
-

The customer is currently either waiting for help or being helped, depending on if they're assigned to a user or not.

-
-
-

Idle

-
Idle: "IDLE"
-

The default status of a customer when they don't have any open issues. Any activity on their timeline will move them into ACTIVE.

-
-
-

Snoozed

-
Snoozed: "SNOOZED"
-

Indicates that a user is waiting for a customer to get back. Any activity on their timeline will move them into ACTIVE.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/_internal_.IssueStatus.html b/docs/enums/_internal_.IssueStatus.html deleted file mode 100644 index 4d7cc11..0000000 --- a/docs/enums/_internal_.IssueStatus.html +++ /dev/null @@ -1,287 +0,0 @@ -IssueStatus | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Enumeration IssueStatus

-
-
-
- -
-
-

Enumeration Members

-
Open -Resolved -
-
-

Enumeration Members

-
-

Open

-
Open: "OPEN"
-
-

Resolved

-
Resolved: "RESOLVED"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/_internal_.MutationErrorType.html b/docs/enums/_internal_.MutationErrorType.html deleted file mode 100644 index 0133f80..0000000 --- a/docs/enums/_internal_.MutationErrorType.html +++ /dev/null @@ -1,303 +0,0 @@ -MutationErrorType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Enumeration MutationErrorType

-
-

An enum for why the mutation failed overall.

-
-
-
-
- -
-
-

Enumeration Members

-
Forbidden -Internal -Validation -
-
-

Enumeration Members

-
-

Forbidden

-
Forbidden: "FORBIDDEN"
-

The user is not authorized to do this mutation. See message for details on which permissions are missing.

-
-
-

Internal

-
Internal: "INTERNAL"
-

An unknown internal server error occurred. Retry the mutation and if it persists, please email help@plain.com

-
-
-

Validation

-
Validation: "VALIDATION"
-

Input validation failed, see the fields for details on why the input was invalid.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/_internal_.MutationFieldErrorType.html b/docs/enums/_internal_.MutationFieldErrorType.html deleted file mode 100644 index a5e848c..0000000 --- a/docs/enums/_internal_.MutationFieldErrorType.html +++ /dev/null @@ -1,303 +0,0 @@ -MutationFieldErrorType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Enumeration MutationFieldErrorType

-
-

An enum specific to each field, explaining why validation failed.

-
-
-
-
- -
-
-

Enumeration Members

-
NotFound -Required -Validation -
-
-

Enumeration Members

-
-

NotFound

-
NotFound: "NOT_FOUND"
-

The input field referenced an entity that wasn't found.

-
-
-

Required

-
Required: "REQUIRED"
-

The field is required to be provided. String inputs may be trimmed and checked for emptiness.

-
-
-

Validation

-
Validation: "VALIDATION"
-

The field was provided, but didn't pass the requirements of the field. See message for details on why.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/_internal_.DIRTY-1.html b/docs/functions/_internal_.DIRTY-1.html deleted file mode 100644 index 128f375..0000000 --- a/docs/functions/_internal_.DIRTY-1.html +++ /dev/null @@ -1,274 +0,0 @@ -DIRTY | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Function DIRTY

-
-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      value: T
    -

    Returns DIRTY<T>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/_internal_.OK-1.html b/docs/functions/_internal_.OK-1.html deleted file mode 100644 index 0f30438..0000000 --- a/docs/functions/_internal_.OK-1.html +++ /dev/null @@ -1,274 +0,0 @@ -OK | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Function OK

-
-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      value: T
    -

    Returns OK<T>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 7ae3234..0000000 --- a/docs/index.html +++ /dev/null @@ -1,272 +0,0 @@ -@team-plain/typescript-sdk
-
- -
-
-
-
-

@team-plain/typescript-sdk

-

@team-plain/typescript-sdk

This is the typescript/node SDK for Plain.com's Core GraphQL API. It makes it easy to make common API calls in just a few lines of code.

-

If you run into any issues please open an issue or get in touch with us at help@plain.com.

-

Basic example

import { PlainSDKClient } from "@team-plain/typescript-sdk"

const client = new PlainSDKClient({
  apiKey: 'plainApiKey__tmRD_xF5qiMH0657LkbLCC1maN4hLsBIbyOgjqEP4w'
})

const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' });

if (result.error) {
  console.log(result.error);        
} else {
  console.log(result.data.fullName);
}
-
-

Creating an API key

You can find out how to make an API key in our documentation: https://docs.plain.com/core-api/authentication

-

Error handling

Calling methods on the client will not throw an error. This is so that we can have typed errors and make everything a bit more predic

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.CallSite.html b/docs/interfaces/_internal_.CallSite.html deleted file mode 100644 index b0345a0..0000000 --- a/docs/interfaces/_internal_.CallSite.html +++ /dev/null @@ -1,440 +0,0 @@ -CallSite | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface CallSite

-
-

Hierarchy

-
    -
  • CallSite
-
-
-
- -
-
-

Methods

-
getColumnNumber -getEvalOrigin -getFileName -getFunction -getFunctionName -getLineNumber -getMethodName -getThis -getTypeName -isConstructor -isEval -isNative -isToplevel -
-
-

Methods

-
-

getColumnNumber

-
    - -
  • -

    Current column number [if this function was defined in a script]

    -
    -

    Returns null | number

-
-

getEvalOrigin

-
    - -
  • -

    A call site object representing the location where eval was called -[if this function was created using a call to eval]

    -
    -

    Returns undefined | string

-
-

getFileName

-
    - -
  • -

    Name of the script [if this function was defined in a script]

    -
    -

    Returns undefined | string

-
-

getFunction

-
    - -
  • -

    Current function

    -
    -

    Returns undefined | Function

-
-

getFunctionName

-
    - -
  • -

    Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context.

    -
    -

    Returns null | string

-
-

getLineNumber

-
    - -
  • -

    Current line number [if this function was defined in a script]

    -
    -

    Returns null | number

-
-

getMethodName

-
    - -
  • -

    Name of the property [of "this" or one of its prototypes] that holds -the current function

    -
    -

    Returns null | string

-
-

getThis

-
    - -
  • -

    Value of "this"

    -
    -

    Returns unknown

-
-

getTypeName

-
    - -
  • -

    Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property.

    -
    -

    Returns null | string

-
-

isConstructor

-
    - -
  • -

    Is this a constructor call?

    -
    -

    Returns boolean

-
-

isEval

-
    - -
  • -

    Does this call take place in code defined by a call to eval?

    -
    -

    Returns boolean

-
-

isNative

-
    - -
  • -

    Is this call in native V8 code?

    -
    -

    Returns boolean

-
-

isToplevel

-
    - -
  • -

    Is this a toplevel invocation, that is, is "this" the global object?

    -
    -

    Returns boolean

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ParseContext.html b/docs/interfaces/_internal_.ParseContext.html deleted file mode 100644 index 462183b..0000000 --- a/docs/interfaces/_internal_.ParseContext.html +++ /dev/null @@ -1,328 +0,0 @@ -ParseContext | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ParseContext

-
-

Hierarchy

-
    -
  • ParseContext
-
-
-
- -
-
-

Properties

-
common -data -parent -parsedType -path -schemaErrorMap? -
-
-

Properties

-
-

Readonly common

-
common: {
    async: boolean;
    contextualErrorMap?: ZodErrorMap;
    issues: ZodIssue[];
}
-
-

Type declaration

-
    -
  • -
    Readonly async: boolean
    • -
  • -
    Optional Readonly contextualErrorMap?: ZodErrorMap
    • -
  • -
    Readonly issues: ZodIssue[]
-
-

Readonly data

-
data: any
-
-

Readonly parent

-
parent: null | ParseContext
-
-

Readonly parsedType

-
parsedType: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
-
-

Readonly path

-
path: ParsePath
-
-

Optional Readonly schemaErrorMap

-
schemaErrorMap?: ZodErrorMap
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodArrayDef.html b/docs/interfaces/_internal_.ZodArrayDef.html deleted file mode 100644 index 5c563d3..0000000 --- a/docs/interfaces/_internal_.ZodArrayDef.html +++ /dev/null @@ -1,335 +0,0 @@ -ZodArrayDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodArrayDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -exactLength -maxLength -minLength -type -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

exactLength

-
exactLength: null | {
    message?: string;
    value: number;
}
-
-

maxLength

-
maxLength: null | {
    message?: string;
    value: number;
}
-
-

minLength

-
minLength: null | {
    message?: string;
    value: number;
}
-
-

type

-
type: T
-
-

typeName

-
typeName: ZodArray
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodBrandedDef.html b/docs/interfaces/_internal_.ZodBrandedDef.html deleted file mode 100644 index b3db3d0..0000000 --- a/docs/interfaces/_internal_.ZodBrandedDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodBrandedDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodBrandedDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -type -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

type

-
type: T
-
-

typeName

-
typeName: ZodBranded
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodCatchDef.html b/docs/interfaces/_internal_.ZodCatchDef.html deleted file mode 100644 index 8564ea0..0000000 --- a/docs/interfaces/_internal_.ZodCatchDef.html +++ /dev/null @@ -1,339 +0,0 @@ -ZodCatchDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodCatchDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
catchValue -description? -errorMap? -innerType -typeName -
-
-

Properties

-
-

catchValue

-
catchValue: ((ctx) => T["_input"])
-
-

Type declaration

-
    -
  • -
      -
    • (ctx): T["_input"]
      • -
    • -
      -

      Parameters

      -
        -
      • -
        ctx: {
            error: ZodError<any>;
            input: unknown;
        }
        -
          -
        • -
          error: ZodError<any>
          • -
        • -
          input: unknown
      -

      Returns T["_input"]

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

innerType

-
innerType: T
-
-

typeName

-
typeName: ZodCatch
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodCustomIssue.html b/docs/interfaces/_internal_.ZodCustomIssue.html deleted file mode 100644 index ecc7136..0000000 --- a/docs/interfaces/_internal_.ZodCustomIssue.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodCustomIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodCustomIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -params? -path -
-
-

Properties

-
-

code

-
code: "custom"
-
-

Optional message

-
message?: string
-
-

Optional params

-
params?: {
    [k: string]: any;
}
-
-

Type declaration

-
    -
  • -
    [k: string]: any
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodDefaultDef.html b/docs/interfaces/_internal_.ZodDefaultDef.html deleted file mode 100644 index aabfb3c..0000000 --- a/docs/interfaces/_internal_.ZodDefaultDef.html +++ /dev/null @@ -1,329 +0,0 @@ -ZodDefaultDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodDefaultDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
defaultValue -description? -errorMap? -innerType -typeName -
-
-

Properties

-
-

defaultValue

-
defaultValue: (() => noUndefined<T["_input"]>)
-
-

Type declaration

-
-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

innerType

-
innerType: T
-
-

typeName

-
typeName: ZodDefault
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodEffectsDef.html b/docs/interfaces/_internal_.ZodEffectsDef.html deleted file mode 100644 index 1746a2c..0000000 --- a/docs/interfaces/_internal_.ZodEffectsDef.html +++ /dev/null @@ -1,321 +0,0 @@ -ZodEffectsDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodEffectsDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -effect -errorMap? -schema -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

effect

-
effect: Effect<any>
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

schema

-
schema: T
-
-

typeName

-
typeName: ZodEffects
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodEnumDef.html b/docs/interfaces/_internal_.ZodEnumDef.html deleted file mode 100644 index 6282696..0000000 --- a/docs/interfaces/_internal_.ZodEnumDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodEnumDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodEnumDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -typeName -values -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

typeName

-
typeName: ZodEnum
-
-

values

-
values: T
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodIntersectionDef.html b/docs/interfaces/_internal_.ZodIntersectionDef.html deleted file mode 100644 index 265d119..0000000 --- a/docs/interfaces/_internal_.ZodIntersectionDef.html +++ /dev/null @@ -1,323 +0,0 @@ -ZodIntersectionDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodIntersectionDef<T, U>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -left -right -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

left

-
left: T
-
-

right

-
right: U
-
-

typeName

-
typeName: ZodIntersection
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html b/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html deleted file mode 100644 index 6e77dfd..0000000 --- a/docs/interfaces/_internal_.ZodInvalidArgumentsIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodInvalidArgumentsIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidArgumentsIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
argumentsError -code -message? -path -
-
-

Properties

-
-

argumentsError

-
argumentsError: ZodError<any>
-
-

code

-
code: "invalid_arguments"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidDateIssue.html b/docs/interfaces/_internal_.ZodInvalidDateIssue.html deleted file mode 100644 index 93d97af..0000000 --- a/docs/interfaces/_internal_.ZodInvalidDateIssue.html +++ /dev/null @@ -1,302 +0,0 @@ -ZodInvalidDateIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidDateIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -
-
-

Properties

-
-

code

-
code: "invalid_date"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html b/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html deleted file mode 100644 index d8bc7b2..0000000 --- a/docs/interfaces/_internal_.ZodInvalidEnumValueIssue.html +++ /dev/null @@ -1,316 +0,0 @@ -ZodInvalidEnumValueIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidEnumValueIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -options -path -received -
-
-

Properties

-
-

code

-
code: "invalid_enum_value"
-
-

Optional message

-
message?: string
-
-

options

-
options: (string | number)[]
-
-

path

-
path: (string | number)[]
-
-

received

-
received: string | number
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html b/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html deleted file mode 100644 index 11a39cd..0000000 --- a/docs/interfaces/_internal_.ZodInvalidIntersectionTypesIssue.html +++ /dev/null @@ -1,302 +0,0 @@ -ZodInvalidIntersectionTypesIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidIntersectionTypesIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -
-
-

Properties

-
-

code

-
code: "invalid_intersection_types"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html b/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html deleted file mode 100644 index e00f93d..0000000 --- a/docs/interfaces/_internal_.ZodInvalidLiteralIssue.html +++ /dev/null @@ -1,316 +0,0 @@ -ZodInvalidLiteralIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidLiteralIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -expected -message? -path -received -
-
-

Properties

-
-

code

-
code: "invalid_literal"
-
-

expected

-
expected: unknown
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

received

-
received: unknown
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html b/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html deleted file mode 100644 index 399c056..0000000 --- a/docs/interfaces/_internal_.ZodInvalidReturnTypeIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodInvalidReturnTypeIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidReturnTypeIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -returnTypeError -
-
-

Properties

-
-

code

-
code: "invalid_return_type"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

returnTypeError

-
returnTypeError: ZodError<any>
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidStringIssue.html b/docs/interfaces/_internal_.ZodInvalidStringIssue.html deleted file mode 100644 index ce27fda..0000000 --- a/docs/interfaces/_internal_.ZodInvalidStringIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodInvalidStringIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidStringIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -validation -
-
-

Properties

-
-

code

-
code: "invalid_string"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

validation

-
validation: StringValidation
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidTypeIssue.html b/docs/interfaces/_internal_.ZodInvalidTypeIssue.html deleted file mode 100644 index 04b736a..0000000 --- a/docs/interfaces/_internal_.ZodInvalidTypeIssue.html +++ /dev/null @@ -1,316 +0,0 @@ -ZodInvalidTypeIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidTypeIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -expected -message? -path -received -
-
-

Properties

-
-

code

-
code: "invalid_type"
-
-

expected

-
expected: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

received

-
received: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "map" | "nan" | "integer" | "float" | "date" | "null" | "array" | "unknown" | "promise" | "void" | "never" | "set"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html b/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html deleted file mode 100644 index 4b4d46a..0000000 --- a/docs/interfaces/_internal_.ZodInvalidUnionDiscriminatorIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodInvalidUnionDiscriminatorIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidUnionDiscriminatorIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -options -path -
-
-

Properties

-
-

code

-
code: "invalid_union_discriminator"
-
-

Optional message

-
message?: string
-
-

options

-
options: Primitive[]
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodInvalidUnionIssue.html b/docs/interfaces/_internal_.ZodInvalidUnionIssue.html deleted file mode 100644 index e4e28dc..0000000 --- a/docs/interfaces/_internal_.ZodInvalidUnionIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodInvalidUnionIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodInvalidUnionIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -unionErrors -
-
-

Properties

-
-

code

-
code: "invalid_union"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

unionErrors

-
unionErrors: ZodError<any>[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNotFiniteIssue.html b/docs/interfaces/_internal_.ZodNotFiniteIssue.html deleted file mode 100644 index cf9f3ed..0000000 --- a/docs/interfaces/_internal_.ZodNotFiniteIssue.html +++ /dev/null @@ -1,302 +0,0 @@ -ZodNotFiniteIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodNotFiniteIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -path -
-
-

Properties

-
-

code

-
code: "not_finite"
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html b/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html deleted file mode 100644 index 00a4084..0000000 --- a/docs/interfaces/_internal_.ZodNotMultipleOfIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodNotMultipleOfIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodNotMultipleOfIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -message? -multipleOf -path -
-
-

Properties

-
-

code

-
code: "not_multiple_of"
-
-

Optional message

-
message?: string
-
-

multipleOf

-
multipleOf: number | bigint
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNullableDef.html b/docs/interfaces/_internal_.ZodNullableDef.html deleted file mode 100644 index 8360d26..0000000 --- a/docs/interfaces/_internal_.ZodNullableDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodNullableDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodNullableDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -innerType -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

innerType

-
innerType: T
-
-

typeName

-
typeName: ZodNullable
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodNumberDef.html b/docs/interfaces/_internal_.ZodNumberDef.html deleted file mode 100644 index 9058d15..0000000 --- a/docs/interfaces/_internal_.ZodNumberDef.html +++ /dev/null @@ -1,316 +0,0 @@ -ZodNumberDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodNumberDef

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
checks -coerce -description? -errorMap? -typeName -
-
-

Properties

-
-

checks

-
checks: ZodNumberCheck[]
-
-

coerce

-
coerce: boolean
-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

typeName

-
typeName: ZodNumber
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodObjectDef.html b/docs/interfaces/_internal_.ZodObjectDef.html deleted file mode 100644 index 3b522bc..0000000 --- a/docs/interfaces/_internal_.ZodObjectDef.html +++ /dev/null @@ -1,340 +0,0 @@ -ZodObjectDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodObjectDef<T, UnknownKeys, Catchall>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
catchall -description? -errorMap? -shape -typeName -unknownKeys -
-
-

Properties

-
-

catchall

-
catchall: Catchall
-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

shape

-
shape: (() => T)
-
-

Type declaration

-
    -
  • -
      -
    • (): T
      • -
    • -

      Returns T

-
-

typeName

-
typeName: ZodObject
-
-

unknownKeys

-
unknownKeys: UnknownKeys
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodOptionalDef.html b/docs/interfaces/_internal_.ZodOptionalDef.html deleted file mode 100644 index 13568b0..0000000 --- a/docs/interfaces/_internal_.ZodOptionalDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodOptionalDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodOptionalDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -innerType -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

innerType

-
innerType: T
-
-

typeName

-
typeName: ZodOptional
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodPipelineDef.html b/docs/interfaces/_internal_.ZodPipelineDef.html deleted file mode 100644 index 7132840..0000000 --- a/docs/interfaces/_internal_.ZodPipelineDef.html +++ /dev/null @@ -1,323 +0,0 @@ -ZodPipelineDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodPipelineDef<A, B>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -in -out -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

in

-
in: A
-
-

out

-
out: B
-
-

typeName

-
typeName: ZodPipeline
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodPromiseDef.html b/docs/interfaces/_internal_.ZodPromiseDef.html deleted file mode 100644 index 7cb6929..0000000 --- a/docs/interfaces/_internal_.ZodPromiseDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodPromiseDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodPromiseDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -type -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

type

-
type: T
-
-

typeName

-
typeName: ZodPromise
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodStringDef.html b/docs/interfaces/_internal_.ZodStringDef.html deleted file mode 100644 index 3c97382..0000000 --- a/docs/interfaces/_internal_.ZodStringDef.html +++ /dev/null @@ -1,316 +0,0 @@ -ZodStringDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodStringDef

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
checks -coerce -description? -errorMap? -typeName -
-
-

Properties

-
-

checks

-
checks: ZodStringCheck[]
-
-

coerce

-
coerce: boolean
-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

typeName

-
typeName: ZodString
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTooBigIssue.html b/docs/interfaces/_internal_.ZodTooBigIssue.html deleted file mode 100644 index 667700b..0000000 --- a/docs/interfaces/_internal_.ZodTooBigIssue.html +++ /dev/null @@ -1,330 +0,0 @@ -ZodTooBigIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodTooBigIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -exact? -inclusive -maximum -message? -path -type -
-
-

Properties

-
-

code

-
code: "too_big"
-
-

Optional exact

-
exact?: boolean
-
-

inclusive

-
inclusive: boolean
-
-

maximum

-
maximum: number | bigint
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-

type

-
type: "string" | "number" | "bigint" | "date" | "array" | "set"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTooSmallIssue.html b/docs/interfaces/_internal_.ZodTooSmallIssue.html deleted file mode 100644 index 8510637..0000000 --- a/docs/interfaces/_internal_.ZodTooSmallIssue.html +++ /dev/null @@ -1,330 +0,0 @@ -ZodTooSmallIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodTooSmallIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -exact? -inclusive -message? -minimum -path -type -
-
-

Properties

-
-

code

-
code: "too_small"
-
-

Optional exact

-
exact?: boolean
-
-

inclusive

-
inclusive: boolean
-
-

Optional message

-
message?: string
-
-

minimum

-
minimum: number | bigint
-
-

path

-
path: (string | number)[]
-
-

type

-
type: "string" | "number" | "bigint" | "date" | "array" | "set"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTupleDef.html b/docs/interfaces/_internal_.ZodTupleDef.html deleted file mode 100644 index 191507d..0000000 --- a/docs/interfaces/_internal_.ZodTupleDef.html +++ /dev/null @@ -1,323 +0,0 @@ -ZodTupleDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodTupleDef<T, Rest>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -items -rest -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

items

-
items: T
-
-

rest

-
rest: Rest
-
-

typeName

-
typeName: ZodTuple
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodTypeDef.html b/docs/interfaces/_internal_.ZodTypeDef.html deleted file mode 100644 index 96c05b9..0000000 --- a/docs/interfaces/_internal_.ZodTypeDef.html +++ /dev/null @@ -1,308 +0,0 @@ -ZodTypeDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodTypeDef

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodUnionDef.html b/docs/interfaces/_internal_.ZodUnionDef.html deleted file mode 100644 index f0cc9b2..0000000 --- a/docs/interfaces/_internal_.ZodUnionDef.html +++ /dev/null @@ -1,314 +0,0 @@ -ZodUnionDef | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodUnionDef<T>

-
-

Type Parameters

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
description? -errorMap? -options -typeName -
-
-

Properties

-
-

Optional description

-
description?: string
-
-

Optional errorMap

-
errorMap?: ZodErrorMap
-
-

options

-
options: T
-
-

typeName

-
typeName: ZodUnion
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html b/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html deleted file mode 100644 index a0f1dc1..0000000 --- a/docs/interfaces/_internal_.ZodUnrecognizedKeysIssue.html +++ /dev/null @@ -1,309 +0,0 @@ -ZodUnrecognizedKeysIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Interface ZodUnrecognizedKeysIssue

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
code -keys -message? -path -
-
-

Properties

-
-

code

-
code: "unrecognized_keys"
-
-

keys

-
keys: string[]
-
-

Optional message

-
message?: string
-
-

path

-
path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html deleted file mode 100644 index 9052077..0000000 --- a/docs/modules.html +++ /dev/null @@ -1,280 +0,0 @@ -@team-plain/typescript-sdk
-
- -
-
-
-
-

@team-plain/typescript-sdk

-
-
-

Index

-
-

Modules

-
<internal> -
-
-

Classes

-
PlainSDKClient -
-
-

Type Aliases

-
Actor -Customer -CustomerActor -DateTime -DeletedCustomerActor -InternalActor -Issue -IssuePriority -IssueType -MachineUserActor -MutationError -SystemActor -UserActor -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/_internal_.html b/docs/modules/_internal_.html deleted file mode 100644 index 4a84f74..0000000 --- a/docs/modules/_internal_.html +++ /dev/null @@ -1,584 +0,0 @@ -<internal> | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Module <internal>

-
-
-
- -
-
-

Enumerations

-
CustomerStatus -IssueStatus -MutationErrorType -MutationFieldErrorType -
-
-

Enumeration Members

-
ZodArray -ZodBranded -ZodCatch -ZodDefault -ZodEffects -ZodEnum -ZodIntersection -ZodNullable -ZodNumber -ZodObject -ZodOptional -ZodPipeline -ZodPromise -ZodString -ZodTuple -ZodUnion -
-
-

Classes

-
ParseStatus -ZodArray -ZodBranded -ZodCatch -ZodDefault -ZodEffects -ZodEnum -ZodError -ZodIntersection -ZodNullable -ZodNumber -ZodObject -ZodOptional -ZodPipeline -ZodPromise -ZodString -ZodTuple -ZodType -ZodUnion -
-
-

Interfaces

-
CallSite -ParseContext -ZodArrayDef -ZodBrandedDef -ZodCatchDef -ZodCustomIssue -ZodDefaultDef -ZodEffectsDef -ZodEnumDef -ZodIntersectionDef -ZodInvalidArgumentsIssue -ZodInvalidDateIssue -ZodInvalidEnumValueIssue -ZodInvalidIntersectionTypesIssue -ZodInvalidLiteralIssue -ZodInvalidReturnTypeIssue -ZodInvalidStringIssue -ZodInvalidTypeIssue -ZodInvalidUnionDiscriminatorIssue -ZodInvalidUnionIssue -ZodNotFiniteIssue -ZodNotMultipleOfIssue -ZodNullableDef -ZodNumberDef -ZodObjectDef -ZodOptionalDef -ZodPipelineDef -ZodPromiseDef -ZodStringDef -ZodTooBigIssue -ZodTooSmallIssue -ZodTupleDef -ZodTypeDef -ZodUnionDef -ZodUnrecognizedKeysIssue -
-
-

Type Aliases

-
ActorParts_CustomerActor_Fragment -ActorParts_DeletedCustomerActor_Fragment -ActorParts_MachineUserActor_Fragment -ActorParts_SystemActor_Fragment -ActorParts_UserActor_Fragment -ArrayCardinality -AssertArray -AsyncParseReturnType -BRAND -BadRequestError -CastToStringTuple -CatchallInput -CatchallOutput -Context -CreateIssueInput -CustomerGroupIdentifier -DIRTY -Data -DeepPartial -Effect -EmailAddressInput -EnumValues -Err -ErrMessage -ErrorMapCtx -Exact -Exclude -Extract -FilterEnum -ForbiddenError -GetUnionLast -INVALID -InputMaybe -InputTypeOfTuple -InputTypeOfTupleWithRest -InternalActorParts_CustomerActor_Fragment -InternalActorParts_DeletedCustomerActor_Fragment -InternalActorParts_MachineUserActor_Fragment -InternalActorParts_SystemActor_Fragment -InternalActorParts_UserActor_Fragment -InternalServerError -IpVersion -IssueData -Maybe -MutationError -NonNullable -OK -Omit -Omit -OmitKeys -OptionalStringInput -OutputTypeOfTuple -OutputTypeOfTupleWithRest -ParseInput -ParseParams -ParsePath -ParsePathComponent -ParseReturnType -Partial -PassthroughType -Pick -PlainGraphQLError -PlainSDKError -PreprocessEffect -Primitive -RawCreateParams -Readonly -Record -RefinementCtx -RefinementEffect -Required -Result -SDKResult -SafeParseError -SafeParseReturnType -SafeParseSuccess -Scalars -StringInput -StringValidation -SyncParseReturnType -TransformEffect -TypeOf -UnionToIntersectionFn -UnionToTuple -UnknownError -UnknownKeysParam -UpsertCustomerIdentifierInput -UpsertCustomerInput -UpsertCustomerOnCreateInput -UpsertCustomerOnUpdateInput -Values -Writeable -ZodErrorMap -ZodFormattedError -ZodIssue -ZodIssueBase -ZodIssueOptionalMessage -ZodNumberCheck -ZodRawShape -ZodStringCheck -ZodTupleItems -ZodTypeAny -ZodUnionOptions -addQuestionMarks -allKeys -arrayOutputType -baseObjectInputType -baseObjectOutputType -deoptional -flatten -identity -input -noUndefined -objectInputType -objectOutputType -output -recursiveZodFormattedError -requiredKeys -stripPath -typeToFlattenedError -typecast -
-
-

Variables

-
BRAND -INVALID -PlainGraphQLError -
-
-

Functions

-
DIRTY -OK -
-
-

Enumeration Members

-
-

ZodArray

-
ZodArray: "ZodArray"
-
-

ZodBranded

-
ZodBranded: "ZodBranded"
-
-

ZodCatch

-
ZodCatch: "ZodCatch"
-
-

ZodDefault

-
ZodDefault: "ZodDefault"
-
-

ZodEffects

-
ZodEffects: "ZodEffects"
-
-

ZodEnum

-
ZodEnum: "ZodEnum"
-
-

ZodIntersection

-
ZodIntersection: "ZodIntersection"
-
-

ZodNullable

-
ZodNullable: "ZodNullable"
-
-

ZodNumber

-
ZodNumber: "ZodNumber"
-
-

ZodObject

-
ZodObject: "ZodObject"
-
-

ZodOptional

-
ZodOptional: "ZodOptional"
-
-

ZodPipeline

-
ZodPipeline: "ZodPipeline"
-
-

ZodPromise

-
ZodPromise: "ZodPromise"
-
-

ZodString

-
ZodString: "ZodString"
-
-

ZodTuple

-
ZodTuple: "ZodTuple"
-
-

ZodUnion

-
ZodUnion: "ZodUnion"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/Actor.html b/docs/types/Actor.html deleted file mode 100644 index 7a7cb23..0000000 --- a/docs/types/Actor.html +++ /dev/null @@ -1,259 +0,0 @@ -Actor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Actor

-
Actor: ActorParts_CustomerActor_Fragment | ActorParts_DeletedCustomerActor_Fragment | ActorParts_MachineUserActor_Fragment | ActorParts_SystemActor_Fragment | ActorParts_UserActor_Fragment
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/Customer.html b/docs/types/Customer.html deleted file mode 100644 index a1d3b30..0000000 --- a/docs/types/Customer.html +++ /dev/null @@ -1,316 +0,0 @@ -Customer | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Customer

-
Customer: {
    __typename: "Customer";
    assignedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    assignedToUser: {
        __typename: "UserActor";
        userId: string;
    } | null;
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    createdBy: {
        __typename?: "CustomerActor";
    } | {
        __typename?: "DeletedCustomerActor";
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
    email: {
        __typename?: "EmailAddress";
        email: string;
        isVerified: boolean;
        verifiedAt: {
            __typename: "DateTime";
            iso8601: string;
        } | null;
    };
    externalId: string | null;
    fullName: string;
    id: string;
    lastIdleAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    markedAsSpamAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    shortName: string | null;
    status: CustomerStatus;
    statusChangedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
}
-
-

Type declaration

-
    -
  • -
    __typename: "Customer"
    • -
  • -
    assignedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • -
  • -
    assignedToUser: {
        __typename: "UserActor";
        userId: string;
    } | null
    • -
  • -
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    -
      -
    • -
      __typename: "DateTime"
      • -
    • -
      iso8601: string
    • -
  • -
    createdBy: {
        __typename?: "CustomerActor";
    } | {
        __typename?: "DeletedCustomerActor";
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
    • -
  • -
    email: {
        __typename?: "EmailAddress";
        email: string;
        isVerified: boolean;
        verifiedAt: {
            __typename: "DateTime";
            iso8601: string;
        } | null;
    }
    -
      -
    • -
      Optional __typename?: "EmailAddress"
      • -
    • -
      email: string
      • -
    • -
      isVerified: boolean
      • -
    • -
      verifiedAt: {
          __typename: "DateTime";
          iso8601: string;
      } | null
    • -
  • -
    externalId: string | null
    • -
  • -
    fullName: string
    • -
  • -
    id: string
    • -
  • -
    lastIdleAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • -
  • -
    markedAsSpamAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • -
  • -
    shortName: string | null
    • -
  • -
    status: CustomerStatus
    • -
  • -
    statusChangedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    -
      -
    • -
      __typename: "DateTime"
      • -
    • -
      iso8601: string
    • -
  • -
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    -
      -
    • -
      __typename: "DateTime"
      • -
    • -
      iso8601: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/CustomerActor.html b/docs/types/CustomerActor.html deleted file mode 100644 index 1be9657..0000000 --- a/docs/types/CustomerActor.html +++ /dev/null @@ -1,266 +0,0 @@ -CustomerActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CustomerActor

-
CustomerActor: {
    __typename: "CustomerActor";
    customerId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "CustomerActor"
    • -
  • -
    customerId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/DateTime.html b/docs/types/DateTime.html deleted file mode 100644 index 9498e62..0000000 --- a/docs/types/DateTime.html +++ /dev/null @@ -1,266 +0,0 @@ -DateTime | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias DateTime

-
DateTime: {
    __typename: "DateTime";
    iso8601: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "DateTime"
    • -
  • -
    iso8601: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/DeletedCustomerActor.html b/docs/types/DeletedCustomerActor.html deleted file mode 100644 index 3b10a68..0000000 --- a/docs/types/DeletedCustomerActor.html +++ /dev/null @@ -1,266 +0,0 @@ -DeletedCustomerActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias DeletedCustomerActor

-
DeletedCustomerActor: {
    __typename: "DeletedCustomerActor";
    customerId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "DeletedCustomerActor"
    • -
  • -
    customerId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/InternalActor.html b/docs/types/InternalActor.html deleted file mode 100644 index 01fe8ac..0000000 --- a/docs/types/InternalActor.html +++ /dev/null @@ -1,259 +0,0 @@ -InternalActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActor

-
InternalActor: InternalActorParts_CustomerActor_Fragment | InternalActorParts_DeletedCustomerActor_Fragment | InternalActorParts_MachineUserActor_Fragment | InternalActorParts_SystemActor_Fragment | InternalActorParts_UserActor_Fragment
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/Issue.html b/docs/types/Issue.html deleted file mode 100644 index 16e9cda..0000000 --- a/docs/types/Issue.html +++ /dev/null @@ -1,326 +0,0 @@ -Issue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Issue

-
Issue: {
    __typename: "Issue";
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    createdBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
    customer: {
        __typename?: "Customer";
        id: string;
    };
    deletedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null;
    id: string;
    issueKey: string;
    issueType: {
        __typename: "IssueType";
        defaultIssuePriority: {
            __typename: "IssuePriority";
            label: string;
            value: number;
        };
        id: string;
        isArchived: boolean;
        publicName: string;
    };
    priority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    };
    status: IssueStatus;
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    };
    updatedBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    };
}
-
-

Type declaration

-
    -
  • -
    __typename: "Issue"
    • -
  • -
    createdAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    -
      -
    • -
      __typename: "DateTime"
      • -
    • -
      iso8601: string
    • -
  • -
    createdBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
    • -
  • -
    customer: {
        __typename?: "Customer";
        id: string;
    }
    -
      -
    • -
      Optional __typename?: "Customer"
      • -
    • -
      id: string
    • -
  • -
    deletedAt: {
        __typename: "DateTime";
        iso8601: string;
    } | null
    • -
  • -
    id: string
    • -
  • -
    issueKey: string
    • -
  • -
    issueType: {
        __typename: "IssueType";
        defaultIssuePriority: {
            __typename: "IssuePriority";
            label: string;
            value: number;
        };
        id: string;
        isArchived: boolean;
        publicName: string;
    }
    -
      -
    • -
      __typename: "IssueType"
      • -
    • -
      defaultIssuePriority: {
          __typename: "IssuePriority";
          label: string;
          value: number;
      }
      -
        -
      • -
        __typename: "IssuePriority"
        • -
      • -
        label: string
        • -
      • -
        value: number
      • -
    • -
      id: string
      • -
    • -
      isArchived: boolean
      • -
    • -
      publicName: string
    • -
  • -
    priority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    }
    -
      -
    • -
      __typename: "IssuePriority"
      • -
    • -
      label: string
      • -
    • -
      value: number
    • -
  • -
    status: IssueStatus
    • -
  • -
    updatedAt: {
        __typename: "DateTime";
        iso8601: string;
    }
    -
      -
    • -
      __typename: "DateTime"
      • -
    • -
      iso8601: string
    • -
  • -
    updatedBy: {
        __typename: "CustomerActor";
        customerId: string;
    } | {
        __typename: "DeletedCustomerActor";
        customerId: string;
    } | {
        __typename: "MachineUserActor";
        machineUserId: string;
    } | {
        __typename: "SystemActor";
        systemId: string;
    } | {
        __typename: "UserActor";
        userId: string;
    }
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/IssuePriority.html b/docs/types/IssuePriority.html deleted file mode 100644 index b5bdf3f..0000000 --- a/docs/types/IssuePriority.html +++ /dev/null @@ -1,268 +0,0 @@ -IssuePriority | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias IssuePriority

-
IssuePriority: {
    __typename: "IssuePriority";
    label: string;
    value: number;
}
-
-

Type declaration

-
    -
  • -
    __typename: "IssuePriority"
    • -
  • -
    label: string
    • -
  • -
    value: number
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/IssueType.html b/docs/types/IssueType.html deleted file mode 100644 index 3002336..0000000 --- a/docs/types/IssueType.html +++ /dev/null @@ -1,279 +0,0 @@ -IssueType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias IssueType

-
IssueType: {
    __typename: "IssueType";
    defaultIssuePriority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    };
    id: string;
    isArchived: boolean;
    publicName: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "IssueType"
    • -
  • -
    defaultIssuePriority: {
        __typename: "IssuePriority";
        label: string;
        value: number;
    }
    -
      -
    • -
      __typename: "IssuePriority"
      • -
    • -
      label: string
      • -
    • -
      value: number
    • -
  • -
    id: string
    • -
  • -
    isArchived: boolean
    • -
  • -
    publicName: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/MachineUserActor.html b/docs/types/MachineUserActor.html deleted file mode 100644 index 638b520..0000000 --- a/docs/types/MachineUserActor.html +++ /dev/null @@ -1,266 +0,0 @@ -MachineUserActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias MachineUserActor

-
MachineUserActor: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "MachineUserActor"
    • -
  • -
    machineUserId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/MutationError.html b/docs/types/MutationError.html deleted file mode 100644 index 8f54ea2..0000000 --- a/docs/types/MutationError.html +++ /dev/null @@ -1,272 +0,0 @@ -MutationError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias MutationError

-
MutationError: {
    __typename: "MutationError";
    code: string;
    fields: {
        __typename?: "MutationFieldError";
        field: string;
        message: string;
        type: MutationFieldErrorType;
    }[];
    message: string;
    type: MutationErrorType;
}
-
-

Type declaration

-
    -
  • -
    __typename: "MutationError"
    • -
  • -
    code: string
    • -
  • -
    fields: {
        __typename?: "MutationFieldError";
        field: string;
        message: string;
        type: MutationFieldErrorType;
    }[]
    • -
  • -
    message: string
    • -
  • -
    type: MutationErrorType
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/SystemActor.html b/docs/types/SystemActor.html deleted file mode 100644 index 60a1a7e..0000000 --- a/docs/types/SystemActor.html +++ /dev/null @@ -1,266 +0,0 @@ -SystemActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SystemActor

-
SystemActor: {
    __typename: "SystemActor";
    systemId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "SystemActor"
    • -
  • -
    systemId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/UserActor.html b/docs/types/UserActor.html deleted file mode 100644 index 8296b17..0000000 --- a/docs/types/UserActor.html +++ /dev/null @@ -1,266 +0,0 @@ -UserActor | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UserActor

-
UserActor: {
    __typename: "UserActor";
    userId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "UserActor"
    • -
  • -
    userId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html b/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html deleted file mode 100644 index b63f48d..0000000 --- a/docs/types/_internal_.ActorParts_CustomerActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -ActorParts_CustomerActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ActorParts_CustomerActor_Fragment

-
ActorParts_CustomerActor_Fragment: {
    __typename: "CustomerActor";
    customerId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "CustomerActor"
    • -
  • -
    customerId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html b/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html deleted file mode 100644 index ee3c789..0000000 --- a/docs/types/_internal_.ActorParts_DeletedCustomerActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -ActorParts_DeletedCustomerActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ActorParts_DeletedCustomerActor_Fragment

-
ActorParts_DeletedCustomerActor_Fragment: {
    __typename: "DeletedCustomerActor";
    customerId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "DeletedCustomerActor"
    • -
  • -
    customerId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html b/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html deleted file mode 100644 index 0d95f86..0000000 --- a/docs/types/_internal_.ActorParts_MachineUserActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -ActorParts_MachineUserActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ActorParts_MachineUserActor_Fragment

-
ActorParts_MachineUserActor_Fragment: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "MachineUserActor"
    • -
  • -
    machineUserId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_SystemActor_Fragment.html b/docs/types/_internal_.ActorParts_SystemActor_Fragment.html deleted file mode 100644 index 1ccd703..0000000 --- a/docs/types/_internal_.ActorParts_SystemActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -ActorParts_SystemActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ActorParts_SystemActor_Fragment

-
ActorParts_SystemActor_Fragment: {
    __typename: "SystemActor";
    systemId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "SystemActor"
    • -
  • -
    systemId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ActorParts_UserActor_Fragment.html b/docs/types/_internal_.ActorParts_UserActor_Fragment.html deleted file mode 100644 index 86cdf2b..0000000 --- a/docs/types/_internal_.ActorParts_UserActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -ActorParts_UserActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ActorParts_UserActor_Fragment

-
ActorParts_UserActor_Fragment: {
    __typename: "UserActor";
    userId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "UserActor"
    • -
  • -
    userId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ArrayCardinality.html b/docs/types/_internal_.ArrayCardinality.html deleted file mode 100644 index 7c866b6..0000000 --- a/docs/types/_internal_.ArrayCardinality.html +++ /dev/null @@ -1,260 +0,0 @@ -ArrayCardinality | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ArrayCardinality

-
ArrayCardinality: "many" | "atleastone"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.AssertArray.html b/docs/types/_internal_.AssertArray.html deleted file mode 100644 index 86d5dc2..0000000 --- a/docs/types/_internal_.AssertArray.html +++ /dev/null @@ -1,265 +0,0 @@ -AssertArray | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias AssertArray<T>

-
AssertArray<T>: T extends any[]
    ? T
    : never
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.AsyncParseReturnType.html b/docs/types/_internal_.AsyncParseReturnType.html deleted file mode 100644 index 38bcaaf..0000000 --- a/docs/types/_internal_.AsyncParseReturnType.html +++ /dev/null @@ -1,265 +0,0 @@ -AsyncParseReturnType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias AsyncParseReturnType<T>

-
AsyncParseReturnType<T>: Promise<SyncParseReturnType<T>>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.BRAND.html b/docs/types/_internal_.BRAND.html deleted file mode 100644 index 184eccf..0000000 --- a/docs/types/_internal_.BRAND.html +++ /dev/null @@ -1,271 +0,0 @@ -BRAND | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias BRAND<T>

-
BRAND<T>: {
    [BRAND]: {
        [k in T]: true
    };
}
-
-

Type Parameters

-
    -
  • -

    T extends string | number | symbol

-
-

Type declaration

-
    -
  • -
    [BRAND]: {
        [k in T]: true
    }
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.BadRequestError.html b/docs/types/_internal_.BadRequestError.html deleted file mode 100644 index 8c270f5..0000000 --- a/docs/types/_internal_.BadRequestError.html +++ /dev/null @@ -1,269 +0,0 @@ -BadRequestError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias BadRequestError

-
BadRequestError: {
    code: "bad_request";
    graphqlErrors: PlainGraphQLError[];
    message: string;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.CastToStringTuple.html b/docs/types/_internal_.CastToStringTuple.html deleted file mode 100644 index 0c09085..0000000 --- a/docs/types/_internal_.CastToStringTuple.html +++ /dev/null @@ -1,265 +0,0 @@ -CastToStringTuple | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CastToStringTuple<T>

-
CastToStringTuple<T>: T extends [string, ...string[]]
    ? T
    : never
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.CatchallInput.html b/docs/types/_internal_.CatchallInput.html deleted file mode 100644 index d790271..0000000 --- a/docs/types/_internal_.CatchallInput.html +++ /dev/null @@ -1,265 +0,0 @@ -CatchallInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CatchallInput<T>

-
CatchallInput<T>: ZodTypeAny extends T
    ? unknown
    : {
        [k: string]: T["_input"];
    }
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.CatchallOutput.html b/docs/types/_internal_.CatchallOutput.html deleted file mode 100644 index bd7147d..0000000 --- a/docs/types/_internal_.CatchallOutput.html +++ /dev/null @@ -1,265 +0,0 @@ -CatchallOutput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CatchallOutput<T>

-
CatchallOutput<T>: ZodTypeAny extends T
    ? unknown
    : {
        [k: string]: T["_output"];
    }
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Context.html b/docs/types/_internal_.Context.html deleted file mode 100644 index 9d330df..0000000 --- a/docs/types/_internal_.Context.html +++ /dev/null @@ -1,265 +0,0 @@ -Context | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Context

-
Context: {
    apiKey: string;
}
-
-

Type declaration

-
    -
  • -
    apiKey: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.CreateIssueInput.html b/docs/types/_internal_.CreateIssueInput.html deleted file mode 100644 index 0045cef..0000000 --- a/docs/types/_internal_.CreateIssueInput.html +++ /dev/null @@ -1,272 +0,0 @@ -CreateIssueInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CreateIssueInput

-
CreateIssueInput: {
    customerId: Scalars["ID"];
    issueTypeId: Scalars["ID"];
    priorityValue: InputMaybe<Scalars["Int"]>;
}
-
-

Type declaration

-
    -
  • -
    customerId: Scalars["ID"]
    • -
  • -
    issueTypeId: Scalars["ID"]
    • -
  • -
    priorityValue: InputMaybe<Scalars["Int"]>
    -

    The priority value for this issue. Overrides the issue's issue type's default priority value.

    -

    Valid values are 0, 1, 2 and 3.

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.CustomerGroupIdentifier.html b/docs/types/_internal_.CustomerGroupIdentifier.html deleted file mode 100644 index f765197..0000000 --- a/docs/types/_internal_.CustomerGroupIdentifier.html +++ /dev/null @@ -1,267 +0,0 @@ -CustomerGroupIdentifier | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias CustomerGroupIdentifier

-
CustomerGroupIdentifier: {
    customerGroupId: InputMaybe<Scalars["ID"]>;
    customerGroupKey: InputMaybe<Scalars["String"]>;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.DIRTY.html b/docs/types/_internal_.DIRTY.html deleted file mode 100644 index be76f0f..0000000 --- a/docs/types/_internal_.DIRTY.html +++ /dev/null @@ -1,273 +0,0 @@ -DIRTY | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias DIRTY<T>

-
DIRTY<T>: {
    status: "dirty";
    value: T;
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    status: "dirty"
    • -
  • -
    value: T
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Data.html b/docs/types/_internal_.Data.html deleted file mode 100644 index a083ce3..0000000 --- a/docs/types/_internal_.Data.html +++ /dev/null @@ -1,272 +0,0 @@ -Data | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Data<T>

-
Data<T>: {
    data: T;
    error?: never;
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    data: T
    • -
  • -
    Optional error?: never
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.DeepPartial.html b/docs/types/_internal_.DeepPartial.html deleted file mode 100644 index 8e96817..0000000 --- a/docs/types/_internal_.DeepPartial.html +++ /dev/null @@ -1,265 +0,0 @@ -DeepPartial | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias DeepPartial<T>

-
DeepPartial<T>: T extends ZodObject<ZodRawShape>
    ? ZodObject<{
        [k in keyof T["shape"]]: ZodOptional<DeepPartial<T["shape"][k]>>
    }, T["_def"]["unknownKeys"], T["_def"]["catchall"]>
    : T extends ZodArray<infer Type, infer Card>
        ? ZodArray<DeepPartial<Type>, Card>
        : T extends ZodOptional<infer Type>
            ? ZodOptional<DeepPartial<Type>>
            : T extends ZodNullable<infer Type>
                ? ZodNullable<DeepPartial<Type>>
                : T extends ZodTuple<infer Items>
                    ? {
                            [k in keyof Items]: Items[k] extends ZodTypeAny
                                ? DeepPartial<Items[k]>
                                : never
                        } extends infer PI
                        ? PI extends ZodTupleItems
                            ? ZodTuple<PI>
                            : never
                        : never
                    : T
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Effect.html b/docs/types/_internal_.Effect.html deleted file mode 100644 index 97e35d3..0000000 --- a/docs/types/_internal_.Effect.html +++ /dev/null @@ -1,265 +0,0 @@ -Effect | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Effect<T>

-
Effect<T>: RefinementEffect<T> | TransformEffect<T> | PreprocessEffect<T>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.EmailAddressInput.html b/docs/types/_internal_.EmailAddressInput.html deleted file mode 100644 index 4fa0312..0000000 --- a/docs/types/_internal_.EmailAddressInput.html +++ /dev/null @@ -1,267 +0,0 @@ -EmailAddressInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias EmailAddressInput

-
EmailAddressInput: {
    email: Scalars["String"];
    isVerified: Scalars["Boolean"];
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.EnumValues.html b/docs/types/_internal_.EnumValues.html deleted file mode 100644 index c89db25..0000000 --- a/docs/types/_internal_.EnumValues.html +++ /dev/null @@ -1,260 +0,0 @@ -EnumValues | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias EnumValues

-
EnumValues: [string, ...string[]]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Err.html b/docs/types/_internal_.Err.html deleted file mode 100644 index 02d9b28..0000000 --- a/docs/types/_internal_.Err.html +++ /dev/null @@ -1,272 +0,0 @@ -Err | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Err<U>

-
Err<U>: {
    data?: never;
    error: U;
}
-
-

Type Parameters

-
    -
  • -

    U

-
-

Type declaration

-
    -
  • -
    Optional data?: never
    • -
  • -
    error: U
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ErrMessage.html b/docs/types/_internal_.ErrMessage.html deleted file mode 100644 index ea38f86..0000000 --- a/docs/types/_internal_.ErrMessage.html +++ /dev/null @@ -1,260 +0,0 @@ -ErrMessage | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ErrMessage

-
ErrMessage: string | {
    message?: string;
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ErrorMapCtx.html b/docs/types/_internal_.ErrorMapCtx.html deleted file mode 100644 index b32b91c..0000000 --- a/docs/types/_internal_.ErrorMapCtx.html +++ /dev/null @@ -1,267 +0,0 @@ -ErrorMapCtx | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ErrorMapCtx

-
ErrorMapCtx: {
    data: any;
    defaultError: string;
}
-
-

Type declaration

-
    -
  • -
    data: any
    • -
  • -
    defaultError: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Exact.html b/docs/types/_internal_.Exact.html deleted file mode 100644 index ac98539..0000000 --- a/docs/types/_internal_.Exact.html +++ /dev/null @@ -1,265 +0,0 @@ -Exact | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Exact<T>

-
Exact<T>: {
    [K in keyof T]: T[K]
}
-
-

Type Parameters

-
    -
  • -

    T extends {
        [key: string]: unknown;
    }

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Exclude.html b/docs/types/_internal_.Exclude.html deleted file mode 100644 index f50c050..0000000 --- a/docs/types/_internal_.Exclude.html +++ /dev/null @@ -1,269 +0,0 @@ -Exclude | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Exclude<T, U>

-
Exclude<T, U>: T extends U
    ? never
    : T
-

Exclude from T those types that are assignable to U

-
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    U

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Extract.html b/docs/types/_internal_.Extract.html deleted file mode 100644 index fd31c82..0000000 --- a/docs/types/_internal_.Extract.html +++ /dev/null @@ -1,269 +0,0 @@ -Extract | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Extract<T, U>

-
Extract<T, U>: T extends U
    ? T
    : never
-

Extract from T those types that are assignable to U

-
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    U

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.FilterEnum.html b/docs/types/_internal_.FilterEnum.html deleted file mode 100644 index e2edf92..0000000 --- a/docs/types/_internal_.FilterEnum.html +++ /dev/null @@ -1,267 +0,0 @@ -FilterEnum | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias FilterEnum<Values, ToExclude>

-
FilterEnum<Values, ToExclude>: Values extends []
    ? []
    : Values extends [infer Head, ...(infer Rest)]
        ? Head extends ToExclude
            ? FilterEnum<Rest, ToExclude>
            : [Head, ...FilterEnum<Rest, ToExclude>]
        : never
-
-

Type Parameters

-
    -
  • -

    Values

    • -
  • -

    ToExclude

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ForbiddenError.html b/docs/types/_internal_.ForbiddenError.html deleted file mode 100644 index 8d844db..0000000 --- a/docs/types/_internal_.ForbiddenError.html +++ /dev/null @@ -1,267 +0,0 @@ -ForbiddenError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ForbiddenError

-
ForbiddenError: {
    code: "forbidden";
    message: string;
}
-
-

Type declaration

-
    -
  • -
    code: "forbidden"
    • -
  • -
    message: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.GetUnionLast.html b/docs/types/_internal_.GetUnionLast.html deleted file mode 100644 index 42e4fe4..0000000 --- a/docs/types/_internal_.GetUnionLast.html +++ /dev/null @@ -1,265 +0,0 @@ -GetUnionLast | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias GetUnionLast<T>

-
GetUnionLast<T>: UnionToIntersectionFn<T> extends (() => infer Last)
    ? Last
    : never
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.INVALID.html b/docs/types/_internal_.INVALID.html deleted file mode 100644 index e47d168..0000000 --- a/docs/types/_internal_.INVALID.html +++ /dev/null @@ -1,266 +0,0 @@ -INVALID | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias INVALID

-
INVALID: {
    status: "aborted";
}
-
-

Type declaration

-
    -
  • -
    status: "aborted"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InputMaybe.html b/docs/types/_internal_.InputMaybe.html deleted file mode 100644 index 3361339..0000000 --- a/docs/types/_internal_.InputMaybe.html +++ /dev/null @@ -1,265 +0,0 @@ -InputMaybe | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InputMaybe<T>

-
InputMaybe<T>: Maybe<T>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InputTypeOfTuple.html b/docs/types/_internal_.InputTypeOfTuple.html deleted file mode 100644 index b2dbfb9..0000000 --- a/docs/types/_internal_.InputTypeOfTuple.html +++ /dev/null @@ -1,265 +0,0 @@ -InputTypeOfTuple | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InputTypeOfTuple<T>

-
InputTypeOfTuple<T>: AssertArray<{
    [k in keyof T]: T[k] extends ZodType<any, any>
        ? T[k]["_input"]
        : never
}>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InputTypeOfTupleWithRest.html b/docs/types/_internal_.InputTypeOfTupleWithRest.html deleted file mode 100644 index 990cef6..0000000 --- a/docs/types/_internal_.InputTypeOfTupleWithRest.html +++ /dev/null @@ -1,267 +0,0 @@ -InputTypeOfTupleWithRest | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InputTypeOfTupleWithRest<T, Rest>

-
InputTypeOfTupleWithRest<T, Rest>: Rest extends ZodTypeAny
    ? [...InputTypeOfTuple<T>, ...Rest["_input"][]]
    : InputTypeOfTuple<T>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html b/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html deleted file mode 100644 index e8f2bcf..0000000 --- a/docs/types/_internal_.InternalActorParts_CustomerActor_Fragment.html +++ /dev/null @@ -1,265 +0,0 @@ -InternalActorParts_CustomerActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActorParts_CustomerActor_Fragment

-
InternalActorParts_CustomerActor_Fragment: {
    __typename?: "CustomerActor";
}
-
-

Type declaration

-
    -
  • -
    Optional __typename?: "CustomerActor"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html b/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html deleted file mode 100644 index 32d101a..0000000 --- a/docs/types/_internal_.InternalActorParts_DeletedCustomerActor_Fragment.html +++ /dev/null @@ -1,265 +0,0 @@ -InternalActorParts_DeletedCustomerActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActorParts_DeletedCustomerActor_Fragment

-
InternalActorParts_DeletedCustomerActor_Fragment: {
    __typename?: "DeletedCustomerActor";
}
-
-

Type declaration

-
    -
  • -
    Optional __typename?: "DeletedCustomerActor"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html b/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html deleted file mode 100644 index b31c47a..0000000 --- a/docs/types/_internal_.InternalActorParts_MachineUserActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -InternalActorParts_MachineUserActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActorParts_MachineUserActor_Fragment

-
InternalActorParts_MachineUserActor_Fragment: {
    __typename: "MachineUserActor";
    machineUserId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "MachineUserActor"
    • -
  • -
    machineUserId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html b/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html deleted file mode 100644 index caf7fe0..0000000 --- a/docs/types/_internal_.InternalActorParts_SystemActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -InternalActorParts_SystemActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActorParts_SystemActor_Fragment

-
InternalActorParts_SystemActor_Fragment: {
    __typename: "SystemActor";
    systemId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "SystemActor"
    • -
  • -
    systemId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html b/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html deleted file mode 100644 index 8b103e7..0000000 --- a/docs/types/_internal_.InternalActorParts_UserActor_Fragment.html +++ /dev/null @@ -1,267 +0,0 @@ -InternalActorParts_UserActor_Fragment | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalActorParts_UserActor_Fragment

-
InternalActorParts_UserActor_Fragment: {
    __typename: "UserActor";
    userId: string;
}
-
-

Type declaration

-
    -
  • -
    __typename: "UserActor"
    • -
  • -
    userId: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.InternalServerError.html b/docs/types/_internal_.InternalServerError.html deleted file mode 100644 index 2a60d15..0000000 --- a/docs/types/_internal_.InternalServerError.html +++ /dev/null @@ -1,267 +0,0 @@ -InternalServerError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias InternalServerError

-
InternalServerError: {
    code: "internal_server_error";
    message: string;
}
-
-

Type declaration

-
    -
  • -
    code: "internal_server_error"
    • -
  • -
    message: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.IpVersion.html b/docs/types/_internal_.IpVersion.html deleted file mode 100644 index c42f0d3..0000000 --- a/docs/types/_internal_.IpVersion.html +++ /dev/null @@ -1,260 +0,0 @@ -IpVersion | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias IpVersion

-
IpVersion: "v4" | "v6"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.IssueData.html b/docs/types/_internal_.IssueData.html deleted file mode 100644 index 902b523..0000000 --- a/docs/types/_internal_.IssueData.html +++ /dev/null @@ -1,260 +0,0 @@ -IssueData | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias IssueData

-
IssueData: stripPath<ZodIssueOptionalMessage> & {
    fatal?: boolean;
    path?: (string | number)[];
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Maybe.html b/docs/types/_internal_.Maybe.html deleted file mode 100644 index 650d67e..0000000 --- a/docs/types/_internal_.Maybe.html +++ /dev/null @@ -1,265 +0,0 @@ -Maybe | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Maybe<T>

-
Maybe<T>: T | null
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.MutationError.html b/docs/types/_internal_.MutationError.html deleted file mode 100644 index 56f99f2..0000000 --- a/docs/types/_internal_.MutationError.html +++ /dev/null @@ -1,269 +0,0 @@ -MutationError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias MutationError

-
MutationError: {
    code: "mutation_error";
    errorDetails: MutationError;
    message: string;
}
-
-

Type declaration

-
    -
  • -
    code: "mutation_error"
    • -
  • -
    errorDetails: MutationError
    • -
  • -
    message: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.NonNullable.html b/docs/types/_internal_.NonNullable.html deleted file mode 100644 index 3241724..0000000 --- a/docs/types/_internal_.NonNullable.html +++ /dev/null @@ -1,267 +0,0 @@ -NonNullable | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias NonNullable<T>

-
NonNullable<T>: T & {}
-

Exclude null and undefined from T

-
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.OK.html b/docs/types/_internal_.OK.html deleted file mode 100644 index 7b28601..0000000 --- a/docs/types/_internal_.OK.html +++ /dev/null @@ -1,273 +0,0 @@ -OK | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias OK<T>

-
OK<T>: {
    status: "valid";
    value: T;
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    status: "valid"
    • -
  • -
    value: T
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Omit-1.html b/docs/types/_internal_.Omit-1.html deleted file mode 100644 index 140fe0e..0000000 --- a/docs/types/_internal_.Omit-1.html +++ /dev/null @@ -1,267 +0,0 @@ -Omit | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Omit<T, K>

-
Omit<T, K>: Pick<T, Exclude<keyof T, K>>
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    K extends keyof T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Omit.html b/docs/types/_internal_.Omit.html deleted file mode 100644 index 05081a8..0000000 --- a/docs/types/_internal_.Omit.html +++ /dev/null @@ -1,269 +0,0 @@ -Omit | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Omit<T, K>

-
Omit<T, K>: Pick<T, Exclude<keyof T, K>>
-

Construct a type with the properties of T except for those in type K.

-
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    K extends keyof any

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.OmitKeys.html b/docs/types/_internal_.OmitKeys.html deleted file mode 100644 index 4e4f05b..0000000 --- a/docs/types/_internal_.OmitKeys.html +++ /dev/null @@ -1,267 +0,0 @@ -OmitKeys | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias OmitKeys<T, K>

-
OmitKeys<T, K>: Pick<T, Exclude<keyof T, K>>
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    K extends string

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.OptionalStringInput.html b/docs/types/_internal_.OptionalStringInput.html deleted file mode 100644 index 0375987..0000000 --- a/docs/types/_internal_.OptionalStringInput.html +++ /dev/null @@ -1,265 +0,0 @@ -OptionalStringInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias OptionalStringInput

-
OptionalStringInput: {
    value: InputMaybe<Scalars["String"]>;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.OutputTypeOfTuple.html b/docs/types/_internal_.OutputTypeOfTuple.html deleted file mode 100644 index ba97012..0000000 --- a/docs/types/_internal_.OutputTypeOfTuple.html +++ /dev/null @@ -1,265 +0,0 @@ -OutputTypeOfTuple | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias OutputTypeOfTuple<T>

-
OutputTypeOfTuple<T>: AssertArray<{
    [k in keyof T]: T[k] extends ZodType<any, any>
        ? T[k]["_output"]
        : never
}>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.OutputTypeOfTupleWithRest.html b/docs/types/_internal_.OutputTypeOfTupleWithRest.html deleted file mode 100644 index 2f9e4f9..0000000 --- a/docs/types/_internal_.OutputTypeOfTupleWithRest.html +++ /dev/null @@ -1,267 +0,0 @@ -OutputTypeOfTupleWithRest | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias OutputTypeOfTupleWithRest<T, Rest>

-
OutputTypeOfTupleWithRest<T, Rest>: Rest extends ZodTypeAny
    ? [...OutputTypeOfTuple<T>, ...Rest["_output"][]]
    : OutputTypeOfTuple<T>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ParseInput.html b/docs/types/_internal_.ParseInput.html deleted file mode 100644 index 1ea45fe..0000000 --- a/docs/types/_internal_.ParseInput.html +++ /dev/null @@ -1,269 +0,0 @@ -ParseInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ParseInput

-
ParseInput: {
    data: any;
    parent: ParseContext;
    path: (string | number)[];
}
-
-

Type declaration

-
    -
  • -
    data: any
    • -
  • -
    parent: ParseContext
    • -
  • -
    path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ParseParams.html b/docs/types/_internal_.ParseParams.html deleted file mode 100644 index c8e7463..0000000 --- a/docs/types/_internal_.ParseParams.html +++ /dev/null @@ -1,269 +0,0 @@ -ParseParams | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ParseParams

-
ParseParams: {
    async: boolean;
    errorMap: ZodErrorMap;
    path: (string | number)[];
}
-
-

Type declaration

-
    -
  • -
    async: boolean
    • -
  • -
    errorMap: ZodErrorMap
    • -
  • -
    path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ParsePath.html b/docs/types/_internal_.ParsePath.html deleted file mode 100644 index 0153a37..0000000 --- a/docs/types/_internal_.ParsePath.html +++ /dev/null @@ -1,260 +0,0 @@ -ParsePath | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ParsePath

-
ParsePath: ParsePathComponent[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ParsePathComponent.html b/docs/types/_internal_.ParsePathComponent.html deleted file mode 100644 index b39a286..0000000 --- a/docs/types/_internal_.ParsePathComponent.html +++ /dev/null @@ -1,260 +0,0 @@ -ParsePathComponent | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ParsePathComponent

-
ParsePathComponent: string | number
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ParseReturnType.html b/docs/types/_internal_.ParseReturnType.html deleted file mode 100644 index d924a08..0000000 --- a/docs/types/_internal_.ParseReturnType.html +++ /dev/null @@ -1,265 +0,0 @@ -ParseReturnType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ParseReturnType<T>

-
ParseReturnType<T>: SyncParseReturnType<T> | AsyncParseReturnType<T>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Partial.html b/docs/types/_internal_.Partial.html deleted file mode 100644 index 66dabf8..0000000 --- a/docs/types/_internal_.Partial.html +++ /dev/null @@ -1,267 +0,0 @@ -Partial | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Partial<T>

-
Partial<T>: {
    [P in keyof T]?: T[P]
}
-

Make all properties in T optional

-
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.PassthroughType.html b/docs/types/_internal_.PassthroughType.html deleted file mode 100644 index af81918..0000000 --- a/docs/types/_internal_.PassthroughType.html +++ /dev/null @@ -1,265 +0,0 @@ -PassthroughType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias PassthroughType<T>

-
PassthroughType<T>: T extends "passthrough"
    ? {
        [k: string]: unknown;
    }
    : unknown
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Pick.html b/docs/types/_internal_.Pick.html deleted file mode 100644 index cc4d3ef..0000000 --- a/docs/types/_internal_.Pick.html +++ /dev/null @@ -1,269 +0,0 @@ -Pick | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Pick<T, K>

-
Pick<T, K>: {
    [P in K]: T[P]
}
-

From T, pick a set of properties whose keys are in the union K

-
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    K extends keyof T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.PlainGraphQLError.html b/docs/types/_internal_.PlainGraphQLError.html deleted file mode 100644 index d9792c0..0000000 --- a/docs/types/_internal_.PlainGraphQLError.html +++ /dev/null @@ -1,261 +0,0 @@ -PlainGraphQLError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias PlainGraphQLError

-
PlainGraphQLError: TypeOf<typeof PlainGraphQLError>
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.PlainSDKError.html b/docs/types/_internal_.PlainSDKError.html deleted file mode 100644 index 6ff32c5..0000000 --- a/docs/types/_internal_.PlainSDKError.html +++ /dev/null @@ -1,260 +0,0 @@ -PlainSDKError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias PlainSDKError

-
PlainSDKError: ForbiddenError | BadRequestError | InternalServerError | MutationError | UnknownError
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.PreprocessEffect.html b/docs/types/_internal_.PreprocessEffect.html deleted file mode 100644 index 704765d..0000000 --- a/docs/types/_internal_.PreprocessEffect.html +++ /dev/null @@ -1,283 +0,0 @@ -PreprocessEffect | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias PreprocessEffect<T>

-
PreprocessEffect<T>: {
    transform: ((arg) => any);
    type: "preprocess";
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    transform: ((arg) => any)
    -
      -
    • -
        -
      • (arg): any
        • -
      • -
        -

        Parameters

        -
          -
        • -
          arg: T
        -

        Returns any

    • -
  • -
    type: "preprocess"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Primitive.html b/docs/types/_internal_.Primitive.html deleted file mode 100644 index c8e09ea..0000000 --- a/docs/types/_internal_.Primitive.html +++ /dev/null @@ -1,260 +0,0 @@ -Primitive | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Primitive

-
Primitive: string | number | symbol | bigint | boolean | null | undefined
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.RawCreateParams.html b/docs/types/_internal_.RawCreateParams.html deleted file mode 100644 index 946ba7d..0000000 --- a/docs/types/_internal_.RawCreateParams.html +++ /dev/null @@ -1,260 +0,0 @@ -RawCreateParams | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias RawCreateParams

-
RawCreateParams: {
    description?: string;
    errorMap?: ZodErrorMap;
    invalid_type_error?: string;
    required_error?: string;
} | undefined
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Readonly.html b/docs/types/_internal_.Readonly.html deleted file mode 100644 index 3c6221e..0000000 --- a/docs/types/_internal_.Readonly.html +++ /dev/null @@ -1,267 +0,0 @@ -Readonly | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Readonly<T>

-
Readonly<T>: {
    readonly [P in keyof T]: T[P]
}
-

Make all properties in T readonly

-
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Record.html b/docs/types/_internal_.Record.html deleted file mode 100644 index 8f161cf..0000000 --- a/docs/types/_internal_.Record.html +++ /dev/null @@ -1,269 +0,0 @@ -Record | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Record<K, T>

-
Record<K, T>: {
    [P in K]: T
}
-

Construct a type with a set of properties K of type T

-
-
-

Type Parameters

-
    -
  • -

    K extends keyof any

    • -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.RefinementCtx.html b/docs/types/_internal_.RefinementCtx.html deleted file mode 100644 index 3f08372..0000000 --- a/docs/types/_internal_.RefinementCtx.html +++ /dev/null @@ -1,278 +0,0 @@ -RefinementCtx | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias RefinementCtx

-
RefinementCtx: {
    addIssue: ((arg) => void);
    path: (string | number)[];
}
-
-

Type declaration

-
    -
  • -
    addIssue: ((arg) => void)
    -
      -
    • -
        -
      • (arg): void
        • -
      • -
        -

        Parameters

        -
        -

        Returns void

    • -
  • -
    path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.RefinementEffect.html b/docs/types/_internal_.RefinementEffect.html deleted file mode 100644 index 214d360..0000000 --- a/docs/types/_internal_.RefinementEffect.html +++ /dev/null @@ -1,285 +0,0 @@ -RefinementEffect | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias RefinementEffect<T>

-
RefinementEffect<T>: {
    refinement: ((arg, ctx) => any);
    type: "refinement";
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    refinement: ((arg, ctx) => any)
    -
      -
    • -
        -
      • (arg, ctx): any
        • -
      • -
        -

        Parameters

        -
        -

        Returns any

    • -
  • -
    type: "refinement"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Required.html b/docs/types/_internal_.Required.html deleted file mode 100644 index 157bba8..0000000 --- a/docs/types/_internal_.Required.html +++ /dev/null @@ -1,267 +0,0 @@ -Required | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Required<T>

-
Required<T>: {
    [P in keyof T]-?: T[P]
}
-

Make all properties in T required

-
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Result.html b/docs/types/_internal_.Result.html deleted file mode 100644 index 6e688db..0000000 --- a/docs/types/_internal_.Result.html +++ /dev/null @@ -1,267 +0,0 @@ -Result | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Result<T, U>

-
Result<T, U>: NonNullable<Data<T> | Err<U>>
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    U

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.SDKResult.html b/docs/types/_internal_.SDKResult.html deleted file mode 100644 index 4a87409..0000000 --- a/docs/types/_internal_.SDKResult.html +++ /dev/null @@ -1,265 +0,0 @@ -SDKResult | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SDKResult<T>

-
SDKResult<T>: Promise<Result<T, PlainSDKError>>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseError.html b/docs/types/_internal_.SafeParseError.html deleted file mode 100644 index d7c3f59..0000000 --- a/docs/types/_internal_.SafeParseError.html +++ /dev/null @@ -1,272 +0,0 @@ -SafeParseError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SafeParseError<Input>

-
SafeParseError<Input>: {
    error: ZodError<Input>;
    success: false;
}
-
-

Type Parameters

-
    -
  • -

    Input

-
-

Type declaration

-
    -
  • -
    error: ZodError<Input>
    • -
  • -
    success: false
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseReturnType.html b/docs/types/_internal_.SafeParseReturnType.html deleted file mode 100644 index cf9b110..0000000 --- a/docs/types/_internal_.SafeParseReturnType.html +++ /dev/null @@ -1,267 +0,0 @@ -SafeParseReturnType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SafeParseReturnType<Input, Output>

-
SafeParseReturnType<Input, Output>: SafeParseSuccess<Output> | SafeParseError<Input>
-
-

Type Parameters

-
    -
  • -

    Input

    • -
  • -

    Output

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.SafeParseSuccess.html b/docs/types/_internal_.SafeParseSuccess.html deleted file mode 100644 index ee36d4f..0000000 --- a/docs/types/_internal_.SafeParseSuccess.html +++ /dev/null @@ -1,272 +0,0 @@ -SafeParseSuccess | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SafeParseSuccess<Output>

-
SafeParseSuccess<Output>: {
    data: Output;
    success: true;
}
-
-

Type Parameters

-
    -
  • -

    Output

-
-

Type declaration

-
    -
  • -
    data: Output
    • -
  • -
    success: true
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Scalars.html b/docs/types/_internal_.Scalars.html deleted file mode 100644 index 1594d5a..0000000 --- a/docs/types/_internal_.Scalars.html +++ /dev/null @@ -1,275 +0,0 @@ -Scalars | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Scalars

-
Scalars: {
    Boolean: boolean;
    Float: number;
    ID: string;
    Int: number;
    String: string;
}
-

All built-in and custom scalars, mapped to their actual values

-
-
-

Type declaration

-
    -
  • -
    Boolean: boolean
    • -
  • -
    Float: number
    • -
  • -
    ID: string
    • -
  • -
    Int: number
    • -
  • -
    String: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.StringInput.html b/docs/types/_internal_.StringInput.html deleted file mode 100644 index 3fd6b96..0000000 --- a/docs/types/_internal_.StringInput.html +++ /dev/null @@ -1,265 +0,0 @@ -StringInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias StringInput

-
StringInput: {
    value: Scalars["String"];
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.StringValidation.html b/docs/types/_internal_.StringValidation.html deleted file mode 100644 index f891dea..0000000 --- a/docs/types/_internal_.StringValidation.html +++ /dev/null @@ -1,260 +0,0 @@ -StringValidation | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias StringValidation

-
StringValidation: "email" | "url" | "emoji" | "uuid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "ip" | {
    includes: string;
    position?: number;
} | {
    startsWith: string;
} | {
    endsWith: string;
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.SyncParseReturnType.html b/docs/types/_internal_.SyncParseReturnType.html deleted file mode 100644 index 2cd7e2b..0000000 --- a/docs/types/_internal_.SyncParseReturnType.html +++ /dev/null @@ -1,265 +0,0 @@ -SyncParseReturnType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias SyncParseReturnType<T>

-
SyncParseReturnType<T>: OK<T> | DIRTY<T> | INVALID
-
-

Type Parameters

-
    -
  • -

    T = any

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.TransformEffect.html b/docs/types/_internal_.TransformEffect.html deleted file mode 100644 index d19efb8..0000000 --- a/docs/types/_internal_.TransformEffect.html +++ /dev/null @@ -1,285 +0,0 @@ -TransformEffect | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias TransformEffect<T>

-
TransformEffect<T>: {
    transform: ((arg, ctx) => any);
    type: "transform";
}
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
    transform: ((arg, ctx) => any)
    -
      -
    • -
        -
      • (arg, ctx): any
        • -
      • -
        -

        Parameters

        -
        -

        Returns any

    • -
  • -
    type: "transform"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.TypeOf.html b/docs/types/_internal_.TypeOf.html deleted file mode 100644 index 4565855..0000000 --- a/docs/types/_internal_.TypeOf.html +++ /dev/null @@ -1,265 +0,0 @@ -TypeOf | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias TypeOf<T>

-
TypeOf<T>: T["_output"]
-
-

Type Parameters

-
    -
  • -

    T extends ZodType<any, any, any>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UnionToIntersectionFn.html b/docs/types/_internal_.UnionToIntersectionFn.html deleted file mode 100644 index ce7ea88..0000000 --- a/docs/types/_internal_.UnionToIntersectionFn.html +++ /dev/null @@ -1,265 +0,0 @@ -UnionToIntersectionFn | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UnionToIntersectionFn<T>

-
UnionToIntersectionFn<T>: (T extends unknown
        ? ((k) => void)
        : never) extends ((k) => void)
    ? Intersection
    : never
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UnionToTuple.html b/docs/types/_internal_.UnionToTuple.html deleted file mode 100644 index 686e1f8..0000000 --- a/docs/types/_internal_.UnionToTuple.html +++ /dev/null @@ -1,267 +0,0 @@ -UnionToTuple | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UnionToTuple<T, Tuple>

-
UnionToTuple<T, Tuple>: [T] extends [never]
    ? Tuple
    : UnionToTuple<Exclude<T, GetUnionLast<T>>, [GetUnionLast<T>, ...Tuple]>
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    Tuple extends unknown[] = []

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UnknownError.html b/docs/types/_internal_.UnknownError.html deleted file mode 100644 index 5771c5a..0000000 --- a/docs/types/_internal_.UnknownError.html +++ /dev/null @@ -1,269 +0,0 @@ -UnknownError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UnknownError

-
UnknownError: {
    code: "unknown";
    err?: unknown;
    message: string;
}
-
-

Type declaration

-
    -
  • -
    code: "unknown"
    • -
  • -
    Optional err?: unknown
    • -
  • -
    message: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UnknownKeysParam.html b/docs/types/_internal_.UnknownKeysParam.html deleted file mode 100644 index 2a016b9..0000000 --- a/docs/types/_internal_.UnknownKeysParam.html +++ /dev/null @@ -1,260 +0,0 @@ -UnknownKeysParam | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UnknownKeysParam

-
UnknownKeysParam: "passthrough" | "strict" | "strip"
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerIdentifierInput.html b/docs/types/_internal_.UpsertCustomerIdentifierInput.html deleted file mode 100644 index ad9aa88..0000000 --- a/docs/types/_internal_.UpsertCustomerIdentifierInput.html +++ /dev/null @@ -1,269 +0,0 @@ -UpsertCustomerIdentifierInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UpsertCustomerIdentifierInput

-
UpsertCustomerIdentifierInput: {
    customerId: InputMaybe<Scalars["ID"]>;
    emailAddress: InputMaybe<Scalars["String"]>;
    externalId: InputMaybe<Scalars["ID"]>;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerInput.html b/docs/types/_internal_.UpsertCustomerInput.html deleted file mode 100644 index c444786..0000000 --- a/docs/types/_internal_.UpsertCustomerInput.html +++ /dev/null @@ -1,269 +0,0 @@ -UpsertCustomerInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UpsertCustomerInput

-
UpsertCustomerInput: {
    identifier: UpsertCustomerIdentifierInput;
    onCreate: UpsertCustomerOnCreateInput;
    onUpdate: UpsertCustomerOnUpdateInput;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerOnCreateInput.html b/docs/types/_internal_.UpsertCustomerOnCreateInput.html deleted file mode 100644 index b98d69a..0000000 --- a/docs/types/_internal_.UpsertCustomerOnCreateInput.html +++ /dev/null @@ -1,273 +0,0 @@ -UpsertCustomerOnCreateInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UpsertCustomerOnCreateInput

-
UpsertCustomerOnCreateInput: {
    customerGroupIdentifiers: InputMaybe<CustomerGroupIdentifier[]>;
    email: EmailAddressInput;
    externalId: InputMaybe<Scalars["ID"]>;
    fullName: Scalars["String"];
    shortName: InputMaybe<Scalars["String"]>;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.UpsertCustomerOnUpdateInput.html b/docs/types/_internal_.UpsertCustomerOnUpdateInput.html deleted file mode 100644 index ac2a4df..0000000 --- a/docs/types/_internal_.UpsertCustomerOnUpdateInput.html +++ /dev/null @@ -1,271 +0,0 @@ -UpsertCustomerOnUpdateInput | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias UpsertCustomerOnUpdateInput

-
UpsertCustomerOnUpdateInput: {
    email: InputMaybe<EmailAddressInput>;
    externalId: InputMaybe<OptionalStringInput>;
    fullName: InputMaybe<StringInput>;
    shortName: InputMaybe<OptionalStringInput>;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Values.html b/docs/types/_internal_.Values.html deleted file mode 100644 index 65d1d56..0000000 --- a/docs/types/_internal_.Values.html +++ /dev/null @@ -1,265 +0,0 @@ -Values | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Values<T>

-
Values<T>: {
    [k in T[number]]: k
}
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.Writeable.html b/docs/types/_internal_.Writeable.html deleted file mode 100644 index eac05d9..0000000 --- a/docs/types/_internal_.Writeable.html +++ /dev/null @@ -1,265 +0,0 @@ -Writeable | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias Writeable<T>

-
Writeable<T>: {
    -readonly [P in keyof T]: T[P]
}
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodErrorMap.html b/docs/types/_internal_.ZodErrorMap.html deleted file mode 100644 index c031940..0000000 --- a/docs/types/_internal_.ZodErrorMap.html +++ /dev/null @@ -1,278 +0,0 @@ -ZodErrorMap | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodErrorMap

-
ZodErrorMap: ((issue, _ctx) => {
    message: string;
})
-
-

Type declaration

-
    -
  • -
      -
    • (issue, _ctx): {
          message: string;
      }
      • -
    • -
      -

      Parameters

      -
      -

      Returns {
          message: string;
      }

      -
        -
      • -
        message: string
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodFormattedError.html b/docs/types/_internal_.ZodFormattedError.html deleted file mode 100644 index baf55fe..0000000 --- a/docs/types/_internal_.ZodFormattedError.html +++ /dev/null @@ -1,267 +0,0 @@ -ZodFormattedError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodFormattedError<T, U>

-
ZodFormattedError<T, U>: {
    _errors: U[];
} & recursiveZodFormattedError<NonNullable<T>>
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    U = string

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssue.html b/docs/types/_internal_.ZodIssue.html deleted file mode 100644 index 461a459..0000000 --- a/docs/types/_internal_.ZodIssue.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodIssue | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodIssue

-
ZodIssue: ZodIssueOptionalMessage & {
    fatal?: boolean;
    message: string;
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssueBase.html b/docs/types/_internal_.ZodIssueBase.html deleted file mode 100644 index 28e7547..0000000 --- a/docs/types/_internal_.ZodIssueBase.html +++ /dev/null @@ -1,267 +0,0 @@ -ZodIssueBase | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodIssueBase

-
ZodIssueBase: {
    message?: string;
    path: (string | number)[];
}
-
-

Type declaration

-
    -
  • -
    Optional message?: string
    • -
  • -
    path: (string | number)[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodIssueOptionalMessage.html b/docs/types/_internal_.ZodIssueOptionalMessage.html deleted file mode 100644 index c96028e..0000000 --- a/docs/types/_internal_.ZodIssueOptionalMessage.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodIssueOptionalMessage | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodIssueOptionalMessage

-
ZodIssueOptionalMessage: ZodInvalidTypeIssue | ZodInvalidLiteralIssue | ZodUnrecognizedKeysIssue | ZodInvalidUnionIssue | ZodInvalidUnionDiscriminatorIssue | ZodInvalidEnumValueIssue | ZodInvalidArgumentsIssue | ZodInvalidReturnTypeIssue | ZodInvalidDateIssue | ZodInvalidStringIssue | ZodTooSmallIssue | ZodTooBigIssue | ZodInvalidIntersectionTypesIssue | ZodNotMultipleOfIssue | ZodNotFiniteIssue | ZodCustomIssue
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodNumberCheck.html b/docs/types/_internal_.ZodNumberCheck.html deleted file mode 100644 index 193f741..0000000 --- a/docs/types/_internal_.ZodNumberCheck.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodNumberCheck | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodNumberCheck

-
ZodNumberCheck: {
    inclusive: boolean;
    kind: "min";
    message?: string;
    value: number;
} | {
    inclusive: boolean;
    kind: "max";
    message?: string;
    value: number;
} | {
    kind: "int";
    message?: string;
} | {
    kind: "multipleOf";
    message?: string;
    value: number;
} | {
    kind: "finite";
    message?: string;
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodRawShape.html b/docs/types/_internal_.ZodRawShape.html deleted file mode 100644 index cf1ab80..0000000 --- a/docs/types/_internal_.ZodRawShape.html +++ /dev/null @@ -1,265 +0,0 @@ -ZodRawShape | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodRawShape

-
ZodRawShape: {
    [k: string]: ZodTypeAny;
}
-
-

Type declaration

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodStringCheck.html b/docs/types/_internal_.ZodStringCheck.html deleted file mode 100644 index 4e20e7f..0000000 --- a/docs/types/_internal_.ZodStringCheck.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodStringCheck | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodStringCheck

-
ZodStringCheck: {
    kind: "min";
    message?: string;
    value: number;
} | {
    kind: "max";
    message?: string;
    value: number;
} | {
    kind: "length";
    message?: string;
    value: number;
} | {
    kind: "email";
    message?: string;
} | {
    kind: "url";
    message?: string;
} | {
    kind: "emoji";
    message?: string;
} | {
    kind: "uuid";
    message?: string;
} | {
    kind: "cuid";
    message?: string;
} | {
    kind: "includes";
    message?: string;
    position?: number;
    value: string;
} | {
    kind: "cuid2";
    message?: string;
} | {
    kind: "ulid";
    message?: string;
} | {
    kind: "startsWith";
    message?: string;
    value: string;
} | {
    kind: "endsWith";
    message?: string;
    value: string;
} | {
    kind: "regex";
    message?: string;
    regex: RegExp;
} | {
    kind: "trim";
    message?: string;
} | {
    kind: "toLowerCase";
    message?: string;
} | {
    kind: "toUpperCase";
    message?: string;
} | {
    kind: "datetime";
    message?: string;
    offset: boolean;
    precision: number | null;
} | {
    kind: "ip";
    message?: string;
    version?: IpVersion;
}
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodTupleItems.html b/docs/types/_internal_.ZodTupleItems.html deleted file mode 100644 index 619ffe7..0000000 --- a/docs/types/_internal_.ZodTupleItems.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodTupleItems | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodTupleItems

-
ZodTupleItems: [ZodTypeAny, ...ZodTypeAny[]]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodTypeAny.html b/docs/types/_internal_.ZodTypeAny.html deleted file mode 100644 index 6be2e95..0000000 --- a/docs/types/_internal_.ZodTypeAny.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodTypeAny | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodTypeAny

-
ZodTypeAny: ZodType<any, any, any>
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.ZodUnionOptions.html b/docs/types/_internal_.ZodUnionOptions.html deleted file mode 100644 index 6a99d50..0000000 --- a/docs/types/_internal_.ZodUnionOptions.html +++ /dev/null @@ -1,260 +0,0 @@ -ZodUnionOptions | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias ZodUnionOptions

-
ZodUnionOptions: Readonly<[ZodTypeAny, ...ZodTypeAny[]]>
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.addQuestionMarks.html b/docs/types/_internal_.addQuestionMarks.html deleted file mode 100644 index 44e2a28..0000000 --- a/docs/types/_internal_.addQuestionMarks.html +++ /dev/null @@ -1,267 +0,0 @@ -addQuestionMarks | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias addQuestionMarks<T, R>

-
addQuestionMarks<T, R>: Pick<Required<T>, R> & Partial<T>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.allKeys.html b/docs/types/_internal_.allKeys.html deleted file mode 100644 index 89db901..0000000 --- a/docs/types/_internal_.allKeys.html +++ /dev/null @@ -1,265 +0,0 @@ -allKeys | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias allKeys<T>

-
allKeys<T>: T extends any
    ? keyof T
    : never
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.arrayOutputType.html b/docs/types/_internal_.arrayOutputType.html deleted file mode 100644 index b479bd4..0000000 --- a/docs/types/_internal_.arrayOutputType.html +++ /dev/null @@ -1,267 +0,0 @@ -arrayOutputType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias arrayOutputType<T, Cardinality>

-
arrayOutputType<T, Cardinality>: Cardinality extends "atleastone"
    ? [T["_output"], ...T["_output"][]]
    : T["_output"][]
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.baseObjectInputType.html b/docs/types/_internal_.baseObjectInputType.html deleted file mode 100644 index a155ff1..0000000 --- a/docs/types/_internal_.baseObjectInputType.html +++ /dev/null @@ -1,265 +0,0 @@ -baseObjectInputType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias baseObjectInputType<Shape>

-
baseObjectInputType<Shape>: addQuestionMarks<{
    [k in keyof Shape]: Shape[k]["_input"]
}>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.baseObjectOutputType.html b/docs/types/_internal_.baseObjectOutputType.html deleted file mode 100644 index 4aa4d8b..0000000 --- a/docs/types/_internal_.baseObjectOutputType.html +++ /dev/null @@ -1,265 +0,0 @@ -baseObjectOutputType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias baseObjectOutputType<Shape>

-
baseObjectOutputType<Shape>: {
    [k in keyof Shape]: Shape[k]["_output"]
}
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.deoptional.html b/docs/types/_internal_.deoptional.html deleted file mode 100644 index 5de4673..0000000 --- a/docs/types/_internal_.deoptional.html +++ /dev/null @@ -1,265 +0,0 @@ -deoptional | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias deoptional<T>

-
deoptional<T>: T extends ZodOptional<infer U>
    ? deoptional<U>
    : T extends ZodNullable<infer U>
        ? ZodNullable<deoptional<U>>
        : T
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.flatten.html b/docs/types/_internal_.flatten.html deleted file mode 100644 index ef87c87..0000000 --- a/docs/types/_internal_.flatten.html +++ /dev/null @@ -1,265 +0,0 @@ -flatten | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias flatten<T>

-
flatten<T>: identity<{
    [k in keyof T]: T[k]
}>
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.identity.html b/docs/types/_internal_.identity.html deleted file mode 100644 index 2a0a876..0000000 --- a/docs/types/_internal_.identity.html +++ /dev/null @@ -1,265 +0,0 @@ -identity | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias identity<T>

-
identity<T>: T
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.input.html b/docs/types/_internal_.input.html deleted file mode 100644 index 7e219d6..0000000 --- a/docs/types/_internal_.input.html +++ /dev/null @@ -1,265 +0,0 @@ -input | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias input<T>

-
input<T>: T["_input"]
-
-

Type Parameters

-
    -
  • -

    T extends ZodType<any, any, any>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.noUndefined.html b/docs/types/_internal_.noUndefined.html deleted file mode 100644 index 9725d24..0000000 --- a/docs/types/_internal_.noUndefined.html +++ /dev/null @@ -1,265 +0,0 @@ -noUndefined | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias noUndefined<T>

-
noUndefined<T>: T extends undefined
    ? never
    : T
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.objectInputType.html b/docs/types/_internal_.objectInputType.html deleted file mode 100644 index 23f7d30..0000000 --- a/docs/types/_internal_.objectInputType.html +++ /dev/null @@ -1,269 +0,0 @@ -objectInputType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias objectInputType<Shape, Catchall, UnknownKeys>

-
objectInputType<Shape, Catchall, UnknownKeys>: flatten<baseObjectInputType<Shape>> & CatchallInput<Catchall> & PassthroughType<UnknownKeys>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.objectOutputType.html b/docs/types/_internal_.objectOutputType.html deleted file mode 100644 index 91370b2..0000000 --- a/docs/types/_internal_.objectOutputType.html +++ /dev/null @@ -1,269 +0,0 @@ -objectOutputType | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias objectOutputType<Shape, Catchall, UnknownKeys>

-
objectOutputType<Shape, Catchall, UnknownKeys>: flatten<addQuestionMarks<baseObjectOutputType<Shape>>> & CatchallOutput<Catchall> & PassthroughType<UnknownKeys>
-
-

Type Parameters

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.output.html b/docs/types/_internal_.output.html deleted file mode 100644 index 0befaf7..0000000 --- a/docs/types/_internal_.output.html +++ /dev/null @@ -1,265 +0,0 @@ -output | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias output<T>

-
output<T>: T["_output"]
-
-

Type Parameters

-
    -
  • -

    T extends ZodType<any, any, any>

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.recursiveZodFormattedError.html b/docs/types/_internal_.recursiveZodFormattedError.html deleted file mode 100644 index 1541152..0000000 --- a/docs/types/_internal_.recursiveZodFormattedError.html +++ /dev/null @@ -1,265 +0,0 @@ -recursiveZodFormattedError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias recursiveZodFormattedError<T>

-
recursiveZodFormattedError<T>: T extends [any, ...any[]]
    ? {
        [K in keyof T]?: ZodFormattedError<T[K]>
    }
    : T extends any[]
        ? {
            [k: number]: ZodFormattedError<T[number]>;
        }
        : T extends object
            ? {
                [K in keyof T]?: ZodFormattedError<T[K]>
            }
            : unknown
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.requiredKeys.html b/docs/types/_internal_.requiredKeys.html deleted file mode 100644 index f118b66..0000000 --- a/docs/types/_internal_.requiredKeys.html +++ /dev/null @@ -1,265 +0,0 @@ -requiredKeys | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias requiredKeys<T>

-
requiredKeys<T>: {
    [k in keyof T]: undefined extends T[k]
        ? never
        : k
}[keyof T]
-
-

Type Parameters

-
    -
  • -

    T extends object

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.stripPath.html b/docs/types/_internal_.stripPath.html deleted file mode 100644 index 90d6ec3..0000000 --- a/docs/types/_internal_.stripPath.html +++ /dev/null @@ -1,265 +0,0 @@ -stripPath | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias stripPath<T>

-
stripPath<T>: T extends any
    ? OmitKeys<T, "path">
    : never
-
-

Type Parameters

-
    -
  • -

    T extends object

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.typeToFlattenedError.html b/docs/types/_internal_.typeToFlattenedError.html deleted file mode 100644 index a465a5c..0000000 --- a/docs/types/_internal_.typeToFlattenedError.html +++ /dev/null @@ -1,274 +0,0 @@ -typeToFlattenedError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias typeToFlattenedError<T, U>

-
typeToFlattenedError<T, U>: {
    fieldErrors: {
        [P in allKeys<T>]?: U[]
    };
    formErrors: U[];
}
-
-

Type Parameters

-
    -
  • -

    T

    • -
  • -

    U = string

-
-

Type declaration

-
    -
  • -
    fieldErrors: {
        [P in allKeys<T>]?: U[]
    }
    • -
  • -
    formErrors: U[]
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/_internal_.typecast.html b/docs/types/_internal_.typecast.html deleted file mode 100644 index 280abcc..0000000 --- a/docs/types/_internal_.typecast.html +++ /dev/null @@ -1,267 +0,0 @@ -typecast | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Type alias typecast<A, T>

-
typecast<A, T>: A extends T
    ? A
    : never
-
-

Type Parameters

-
    -
  • -

    A

    • -
  • -

    T

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/variables/_internal_.BRAND-1.html b/docs/variables/_internal_.BRAND-1.html deleted file mode 100644 index 70993b7..0000000 --- a/docs/variables/_internal_.BRAND-1.html +++ /dev/null @@ -1,261 +0,0 @@ -BRAND | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Variable BRANDConst

-
BRAND: unique symbol
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/variables/_internal_.INVALID-1.html b/docs/variables/_internal_.INVALID-1.html deleted file mode 100644 index bdd54df..0000000 --- a/docs/variables/_internal_.INVALID-1.html +++ /dev/null @@ -1,261 +0,0 @@ -INVALID | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Variable INVALID

-
INVALID: INVALID
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/variables/_internal_.PlainGraphQLError-1.html b/docs/variables/_internal_.PlainGraphQLError-1.html deleted file mode 100644 index f23f303..0000000 --- a/docs/variables/_internal_.PlainGraphQLError-1.html +++ /dev/null @@ -1,261 +0,0 @@ -PlainGraphQLError | @team-plain/typescript-sdk
-
- -
-
-
-
- -

Variable PlainGraphQLErrorConst

-
PlainGraphQLError: ZodObject<{
    extensions: ZodObject<{
        code: ZodString;
    }, "strip", ZodTypeAny, {
        code: string;
    }, {
        code: string;
    }>;
    locations: ZodArray<ZodObject<{
        column: ZodNumber;
        line: ZodNumber;
    }, "strip", ZodTypeAny, {
        column: number;
        line: number;
    }, {
        column: number;
        line: number;
    }>, "many">;
    message: ZodString;
    path: ZodArray<ZodUnion<[ZodString, ZodNumber]>, "many">;
}, "strip", ZodTypeAny, {
    extensions: { code: string; };
    locations: ({ line: number; column: number; })[];
    message: string;
    path: (string | number)[];
}, {
    extensions: { code: string; };
    locations: ({ line: number; column: number; })[];
    message: string;
    path: (string | number)[];
}> = ...
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/package.json b/package.json index 9b82380..cedd2be 100644 --- a/package.json +++ b/package.json @@ -7,9 +7,8 @@ "typings": "dist/index.d.ts", "scripts": { "build": "rm -rf dist && rollup -c", - "codegen": "npm run codegen:graphql && npm run codegen:docs", - "codegen:graphql": "graphql-codegen", - "codegen:docs": "typedoc --plugin typedoc-plugin-missing-exports src/index.ts", + "build:docs": "typedoc --plugin typedoc-plugin-missing-exports src/index.ts", + "codegen": "graphql-codegen", "typecheck": "tsc --noEmit", "lint": "eslint 'src/**/*.ts'", "test": "vitest", From 16831e471e2e7e73ea1e317b722472201ca5aaf4 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Sun, 14 May 2023 11:08:07 +0200 Subject: [PATCH 06/14] First pass at documentation --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++---------- src/client.ts | 17 +++++++++++++--- 2 files changed, 59 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 41e83d5..c3087f5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # @team-plain/typescript-sdk +[Changelog]('./CHANGELOG.md') + This is the typescript/node SDK for Plain.com's Core GraphQL API. It makes it easy to make common API calls in just a few lines of code. If you run into any issues please open an issue or get in touch with us at help@plain.com. @@ -22,31 +24,64 @@ if (result.error) { } ``` -## Creating an API key You can find out how to make an API key in our documentation: https://docs.plain.com/core-api/authentication +## Documentation + +Every method in the SDK corresponds to a graphql [query](./src/graphql/queries/) or [mutation](./src/graphql//mutations/). + +You can find the generated documentation here: + +**[Documentation](https://plain-typescript-sdk-docs.vercel.app/classes/PlainSDKClient.html)** + +If you would like to add a query or mutation please open an issue and we can add it for you. ## Error handling -Calling methods on the client will not throw an error. Instead calling any client method will return an object with either data or an error. +Every SDK method will return an object with either data or an error. **You wil either receive an error or data, never both.** Here is an example: -``` - +```ts function doThing() { const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' }); if (result.error) { - console.log(result.error); - return; - } - - console.log(result.data.fullName); + console.log(result.error); + } else { + console.log(result.data.fullName); + } } ``` -Errors are a union which \ No newline at end of file +An error can be **one of** + +### MutationError +[(view source)](./src/error.ts) +If you only handle one error when using the SDK, handle this one. This is an error returned by a mutation within Plain's API and contains lots of information of what went wrong. It is called 'MutationError' since it every mutation +error has a `errorDetails` field which contains the full error details. + +Here is an example error: +- **message**: an English technical description of the error. This error is usually meant to be read by a developer and not an end user. +- **type**: one of `VALIDATION`, `FORBIDDEN`, `INTERNAL`. See [MutationErrorType](https://docs.plain.com/core-api/reference/enums/mutation-error-type) for a description of each value. +- **code**: a unique error code for each type of error returned. This code can be used to provide a localized or user-friendly error message. You can find the list of error codes [in our docs](https://docs.plain.com/error-codes) . +- **fields**: an array containing all the fields that errored. Each field: + - **field**: the name of the input field the error is for + - **message**: an English technical description of the error. This error is usually meant to be read by a developer and not an end user. +type: one of `VALIDATION`, `REQUIRED`, `NOT_FOUND`. See [MutationFieldErrorType](https://docs.plain.com/core-api/reference/enums/mutation-field-error-type) for a description of each value. + +### BadRequestError +[(view source)](./src/error.ts) +Equivalent to a 400 response. If you are using typescript it's unlikely you will run into this since types will prevent this but if you are using javascript this likely means you are providing a wrong input/argument to a query or mutation. + +### ForbiddenError +[(view source)](./src/error.ts) +Equivalent to a 401 response. Normally means your API key is wrong or has insufficient permissions + +### InternalServerError +[(view source)](./src/error.ts) +Equivalent to a 500 response. If this happens something unexpected within Plain happened. + diff --git a/src/client.ts b/src/client.ts index 5107a4a..68c0378 100644 --- a/src/client.ts +++ b/src/client.ts @@ -41,12 +41,15 @@ function unwrapData( export class PlainSDKClient { #ctx: Context; - constructor(props: { apiKey: string }) { + constructor(options: { apiKey: string }) { this.#ctx = { - apiKey: props.apiKey, + apiKey: options.apiKey, }; } + /** + * If you need to do something custom you can use this method to do + */ async rawRequest(args: { query: string; variables: Record; @@ -58,7 +61,7 @@ export class PlainSDKClient { } /** - * Get a customer by id + * If the customer is not found this will return null. */ async getCustomerById(args: CustomerByIdQueryVariables): SDKResult { const res = await request(this.#ctx, { @@ -71,6 +74,10 @@ export class PlainSDKClient { return unwrapData(res, (q) => q.customer); } + /** + * Allows you to create or update a customer. If you need to get the customer id + * for a customer in Plain, this is typically your first step. + */ async upsertCustomer(input: UpsertCustomerInput): SDKResult { const res = await request(this.#ctx, { query: UpsertCustomerDocument, @@ -82,6 +89,10 @@ export class PlainSDKClient { return unwrapData(res, (q) => nonNullable(q.upsertCustomer.customer)); } + /** + * Create an issue for a customer. If you want you can override the default issue priority + * in your settings by specifying a priority manually here. + */ async createIssue(input: CreateIssueInput): SDKResult { const res = await request(this.#ctx, { query: CreateIssueDocument, From fa6a4d2c5aa5231da1336901036818c9b39c3016 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Sun, 14 May 2023 11:08:12 +0200 Subject: [PATCH 07/14] Make package public --- .changeset/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/config.json b/.changeset/config.json index 6d2119a..cee6df8 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -4,7 +4,7 @@ "commit": false, "fixed": [], "linked": [], - "access": "restricted", + "access": "public", "baseBranch": "main", "updateInternalDependencies": "patch", "ignore": [] From d8a8fa5ef9bf7749fba2e0c7c085ea26d17c2e84 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Sun, 14 May 2023 11:20:59 +0200 Subject: [PATCH 08/14] Add changeset --- .changeset/fast-badgers-jog.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/fast-badgers-jog.md diff --git a/.changeset/fast-badgers-jog.md b/.changeset/fast-badgers-jog.md new file mode 100644 index 0000000..e03ee13 --- /dev/null +++ b/.changeset/fast-badgers-jog.md @@ -0,0 +1,5 @@ +--- +'@team-plain/typescript-sdk': patch +--- + +First public release 🎉 From fa8d13b8e53e43d316a713cfdef0ca14ba6a6207 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Sun, 14 May 2023 11:26:58 +0200 Subject: [PATCH 09/14] Regenerate graphql types --- src/graphql/types.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/graphql/types.ts b/src/graphql/types.ts index 2629fb0..26e006f 100644 --- a/src/graphql/types.ts +++ b/src/graphql/types.ts @@ -2424,10 +2424,13 @@ export type Query = { myLinearInstallationInfo: UserLinearInstallationInfo; myLinearIntegration: Maybe; myLinearIntegrationToken: Maybe; + myMachineUser: Maybe; + myPermissions: Permissions; mySlackInstallationInfo: UserSlackInstallationInfo; mySlackIntegration: Maybe; myUser: Maybe; myUserAccount: Maybe; + myWorkspace: Maybe; myWorkspaceInvites: WorkspaceInviteConnection; myWorkspaces: WorkspaceConnection; permissions: Permissions; From d1b2243b7e065976d327aff808cf54dbacd31c9b Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 15 May 2023 15:39:52 +0200 Subject: [PATCH 10/14] Update README.md Co-authored-by: Jesus --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c3087f5..dc91b71 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ You can find out how to make an API key in our documentation: https://docs.plain ## Documentation -Every method in the SDK corresponds to a graphql [query](./src/graphql/queries/) or [mutation](./src/graphql//mutations/). +Every method in the SDK corresponds to a graphql [query](./src/graphql/queries/) or [mutation](./src/graphql/mutations/). You can find the generated documentation here: From bcb18a0ac6d75d00fd712c46c6afb9128dbb5656 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 15 May 2023 15:40:50 +0200 Subject: [PATCH 11/14] Update README.md Co-authored-by: Jesus --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dc91b71..d545501 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ If you would like to add a query or mutation please open an issue and we can add ## Error handling Every SDK method will return an object with either data or an error. -**You wil either receive an error or data, never both.** +**You will either receive an error or data, never both.** Here is an example: From 0c569a407e7281577cba4bf4fd065d524142bf0d Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 15 May 2023 15:42:11 +0200 Subject: [PATCH 12/14] Update README.md Co-authored-by: Jesus --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d545501..03bf0c8 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ An error can be **one of** ### MutationError [(view source)](./src/error.ts) -If you only handle one error when using the SDK, handle this one. This is an error returned by a mutation within Plain's API and contains lots of information of what went wrong. It is called 'MutationError' since it every mutation +If you only handle one error when using the SDK, handle this one. This is an error returned by a mutation within Plain's API and contains lots of information of what went wrong. It is called `MutationError` since every mutation error has a `errorDetails` field which contains the full error details. Here is an example error: From be82399bc8ca4c1a17ade4f6b3b55ba784c68add Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 15 May 2023 15:54:35 +0200 Subject: [PATCH 13/14] Documentation updates --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 03bf0c8..f165f95 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,10 @@ Every SDK method will return an object with either data or an error. Here is an example: ```ts +const client = new PlainSDKClient({ + apiKey: 'plainApiKey__tmRD_xF5qiMH0667LkbLCC1maN2hLsBIbyOgjqEP4w' +}) + function doThing() { const result = await client.getCustomerById({ customerId: 'c_01GHC4A88A9D49Q30AAWR3BN7P' }); @@ -57,14 +61,15 @@ function doThing() { } ``` -An error can be **one of** +An error can be **one of** the below: ### MutationError [(view source)](./src/error.ts) -If you only handle one error when using the SDK, handle this one. This is an error returned by a mutation within Plain's API and contains lots of information of what went wrong. It is called `MutationError` since every mutation -error has a `errorDetails` field which contains the full error details. +This is an error contains lots of information of what went wrong. It is called `MutationError` since it maps to the `MutationError` type in our GraphQL schema and is returned as part of every mutation in our API. + +You can view the full details of this error under `errorDetails`. -Here is an example error: +A mutation error will contain: - **message**: an English technical description of the error. This error is usually meant to be read by a developer and not an end user. - **type**: one of `VALIDATION`, `FORBIDDEN`, `INTERNAL`. See [MutationErrorType](https://docs.plain.com/core-api/reference/enums/mutation-error-type) for a description of each value. - **code**: a unique error code for each type of error returned. This code can be used to provide a localized or user-friendly error message. You can find the list of error codes [in our docs](https://docs.plain.com/error-codes) . From 0596aaded5add9f56455b5a2f17381befe1de702 Mon Sep 17 00:00:00 2001 From: Mathias Vagni Date: Mon, 15 May 2023 16:11:32 +0200 Subject: [PATCH 14/14] Improve handling of missing permissions. --- README.md | 6 ++--- src/request.ts | 11 +++++++- src/tests/error-handling.test.ts | 45 +++++++++++++++++++++++++++++++- 3 files changed, 57 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f165f95..e2733a9 100644 --- a/README.md +++ b/README.md @@ -65,11 +65,11 @@ An error can be **one of** the below: ### MutationError [(view source)](./src/error.ts) -This is an error contains lots of information of what went wrong. It is called `MutationError` since it maps to the `MutationError` type in our GraphQL schema and is returned as part of every mutation in our API. +This is the richest error type. It is called `MutationError` since it maps to the `MutationError` type in our GraphQL schema and is returned as part of every mutation in our API. You can view the full details of this error under `errorDetails`. -A mutation error will contain: +Every mutation error will contain: - **message**: an English technical description of the error. This error is usually meant to be read by a developer and not an end user. - **type**: one of `VALIDATION`, `FORBIDDEN`, `INTERNAL`. See [MutationErrorType](https://docs.plain.com/core-api/reference/enums/mutation-error-type) for a description of each value. - **code**: a unique error code for each type of error returned. This code can be used to provide a localized or user-friendly error message. You can find the list of error codes [in our docs](https://docs.plain.com/error-codes) . @@ -84,7 +84,7 @@ Equivalent to a 400 response. If you are using typescript it's unlikely you will ### ForbiddenError [(view source)](./src/error.ts) -Equivalent to a 401 response. Normally means your API key is wrong or has insufficient permissions +Equivalent to a 401 or 403 response. Normally means your API key doesn't exist or that you are trying to query something that you do not have permissions for. ### InternalServerError [(view source)](./src/error.ts) diff --git a/src/request.ts b/src/request.ts index 159d73e..436ad5f 100644 --- a/src/request.ts +++ b/src/request.ts @@ -40,6 +40,15 @@ export async function request( const mutationError = getMutationErrorFromResponse(res.data); if (mutationError) { + if (mutationError.code === 'forbidden') { + return { + error: { + type: 'forbidden', + message: mutationError.message, + }, + }; + } + return { error: { type: 'mutation_error', @@ -56,7 +65,7 @@ export async function request( if (axios.isAxiosError(err)) { // Case 1: We got a response back that was > 299 in status code if (err.response) { - if (err.response.status === 401) { + if (err.response.status === 401 || err.response.status === 403) { return { error: { type: 'forbidden', diff --git a/src/tests/error-handling.test.ts b/src/tests/error-handling.test.ts index c8da562..5f26c44 100644 --- a/src/tests/error-handling.test.ts +++ b/src/tests/error-handling.test.ts @@ -25,7 +25,7 @@ describe('error handling', () => { }); test('should return a forbidden error when API 401s', async () => { - const scope = interceptor.matchHeader('Authorization', 'Bearer 123').reply(401, 'forbidden'); + const scope = interceptor.matchHeader('Authorization', 'Bearer 123').reply(401, 'unauthorized'); const client = new PlainSDKClient({ apiKey: '123' }); @@ -38,4 +38,47 @@ describe('error handling', () => { scope.done(); }); + + test('should return a forbidden error when API 403s', async () => { + const scope = interceptor.matchHeader('Authorization', 'Bearer 123').reply(403, 'forbidden'); + + const client = new PlainSDKClient({ apiKey: '123' }); + + const result = await client.getCustomerById({ customerId: 'c_123' }); + + expect(result.error).toEqual({ + type: 'forbidden', + message: expect.stringContaining('Authentication failed'), + }); + + scope.done(); + }); + + test('should return a forbidden error when API responds with mutation error', async () => { + const scope = interceptor.matchHeader('Authorization', 'Bearer 123').reply(200, { + data: { + updateCustomerGroup: { + customerGroup: null, + error: { + __typename: 'MutationError', + message: 'Insufficient permissions, missing "customerGroup:edit".', + type: 'FORBIDDEN', + code: 'forbidden', + fields: [], + }, + }, + }, + }); + + const client = new PlainSDKClient({ apiKey: '123' }); + + const result = await client.getCustomerById({ customerId: 'c_123' }); + + expect(result.error).toEqual({ + type: 'forbidden', + message: 'Insufficient permissions, missing "customerGroup:edit".', + }); + + scope.done(); + }); });