├── examples └── typescript │ ├── .openapi-generator │ └── VERSION │ ├── .gitignore │ ├── .npmignore │ ├── tsconfig.esm.json │ ├── tsconfig.json │ ├── docs │ ├── RadioFieldAllOfChoices.md │ ├── CheckboxesFieldAllOfDef.md │ ├── SelectFieldAllOfChoices.md │ ├── AttachmentFieldAllOfAccept.md │ ├── PageDotNotationUpdateValue.md │ ├── RadioFieldAllOfDef.md │ ├── CheckboxesFieldAllOfChoices.md │ ├── SelectChoiceValue.md │ ├── PageUpdateRequestPosition.md │ ├── SelectFieldAllOfDef.md │ ├── Fieldset.md │ ├── AuthReset410Response.md │ ├── AuthLogout200Response.md │ ├── PageCreateRequestPosition.md │ ├── RadioFieldAllOfFollowing.md │ ├── StringFieldAllOfFollowingIgnore.md │ ├── RadioFieldAllOfFollowingIgnore.md │ ├── SelectFieldAllOfFollowing.md │ ├── SelectFieldAllOfFollowingIgnore.md │ ├── PageArchiveRequest.md │ ├── PagePublishRequest.md │ ├── PageRestoreRequest.md │ ├── BulkOperationRequest.md │ ├── CheckboxesFieldAllOfFollowing.md │ ├── ImageArchiveRequest.md │ ├── ImagePublishRequest.md │ ├── ImageRestoreRequest.md │ ├── PageLocalesResponse.md │ ├── CheckboxesFieldAllOfFollowingIgnore.md │ ├── SameHostnameResponse.md │ ├── StringFieldAllOfFollowing.md │ ├── FileTagArchiveRequest.md │ ├── FileTagPublishRequest.md │ ├── FileTagRestoreRequest.md │ ├── PageLocaleResult.md │ ├── PageLocalizeByIdRequest.md │ ├── UserUniqueUsernameRequest.md │ ├── AuthResetRequestRequest.md │ ├── InlineObject.md │ ├── PageArchive200Response.md │ ├── AuthLogin200Response.md │ ├── InlineObject1.md │ ├── InlineObject2.md │ ├── InlineObject3.md │ ├── InlineObject4.md │ ├── InlineObject5.md │ ├── DifferentHostnameResponse.md │ ├── I18nLocalePost200Response.md │ ├── AuthReset200Response.md │ ├── SubmittedDraftArchive200Response.md │ ├── SubmittedDraftRestore200Response.md │ ├── SubmittedDraftPublish200Response.md │ ├── SubmittedDraftLocalize200Response.md │ ├── AuthResetRequest200Response.md │ ├── FlatPageResponse.md │ ├── AuthResetRequest.md │ ├── PageGetLocalesById200Response.md │ ├── ImageTagPostRequest.md │ ├── NumericRangeOptions.md │ ├── PageMain.md │ ├── ImageTagRequest.md │ ├── FilePatchByIdRequest.md │ ├── PageLocalizeRequest.md │ ├── ImageLocalizeRequest.md │ ├── ImageAutocropRequest.md │ ├── ImageTagPatchByIdRequest.md │ ├── LocalesResponseValue.md │ ├── PaginatedResponse.md │ ├── RelationshipEntry.md │ ├── AttachmentCropRequest.md │ ├── BooleanFieldAllOfToggle.md │ ├── FileTagLocalizeRequest.md │ ├── DateBoundaryOptions.md │ ├── DateTimeBoundaryOptions.md │ ├── PageDeleteById400Response.md │ ├── SubmittedDraftGet200Response.md │ ├── UserUniqueUsername200Response.md │ ├── AreaWidgetGroup.md │ ├── PageGetLocalesById200ResponseResultsInner.md │ ├── FilePostRequest.md │ ├── BulkOperationResponse.md │ ├── ExistInLocaleRequest.md │ ├── PieceResponse.md │ ├── SelectChoice.md │ ├── ImageGet200Response.md │ ├── BooleanFieldAllOfToggleOneOf.md │ ├── GlobalPostRequestContactInfo.md │ ├── GlobalPostRequestSocialMedia.md │ ├── ImagePatchByIdRequest.md │ ├── UserList200Response.md │ ├── FileGet200Response.md │ ├── FileTagPostRequest.md │ ├── GlobalGet200Response.md │ ├── AuthLoginRequest.md │ ├── FileTagGet200Response.md │ ├── FileTagPutByIdRequest.md │ ├── ImageTagGet200Response.md │ ├── LocaleRequest.md │ ├── GlobalPostRequestSiteSettings.md │ ├── FileTagPatchByIdRequest.md │ ├── PageSeoFieldsOgImage.md │ ├── PageSeoFieldsOgImageAttachment.md │ ├── GlobalPatch.md │ ├── ImagePostRequest.md │ ├── ApiError.md │ ├── Error.md │ ├── AuthContext200Response.md │ ├── AuthContextPost200Response.md │ ├── PaginatedResponseData.md │ ├── PageMainItemsInner.md │ ├── FileAttachment.md │ ├── ExistInLocaleResponse.md │ ├── ImageAttachment.md │ ├── AttachmentCropRequestCrop.md │ ├── FileObjectAttachment.md │ ├── WidgetImport.md │ ├── Global.md │ ├── CreatePieceRequest.md │ ├── AuthWhoAmI200Response.md │ ├── ImageGetSrcById200Response.md │ ├── SubmittedDraftPatchByIdRequest.md │ ├── PageSummary.md │ ├── SubmittedDraftPutByIdRequest.md │ ├── FileTag.md │ ├── ImageTag.md │ ├── PageSeoFields.md │ ├── UserPatchByIdRequest.md │ ├── GlobalPostRequest.md │ ├── PageUpdateRequest.md │ ├── UiCondition.md │ ├── PagePatchByIdRequest.md │ ├── UserPutByIdRequest.md │ ├── SubmittedDraftPostRequest.md │ ├── Widget.md │ ├── AreaOptions.md │ ├── FieldPredicate.md │ ├── UserCreateRequest.md │ ├── PageCreateRequest.md │ ├── PagePutByIdRequest.md │ ├── OperatorObject.md │ ├── OembedField.md │ ├── Image.md │ ├── File.md │ ├── ColorField.md │ ├── FileObject.md │ ├── BaseField.md │ ├── ObjectField.md │ ├── TimeField.md │ ├── AreaField.md │ ├── BooleanField.md │ ├── IntegerField.md │ ├── AttachmentField.md │ ├── DateField.md │ ├── DateAndTimeField.md │ ├── FloatField.md │ ├── RangeField.md │ ├── UrlField.md │ ├── EmailField.md │ ├── User.md │ ├── RadioField.md │ ├── ArrayField.md │ ├── RelationshipReverseField.md │ ├── CheckboxesField.md │ ├── SelectField.md │ ├── PasswordField.md │ ├── SlugField.md │ ├── RelationshipField.md │ ├── Attachment.md │ ├── StringField.md │ ├── SubmittedDraft.md │ ├── FlatPageResponseResultsInner.md │ ├── PageTreeResponse.md │ ├── PageGet200Response.md │ └── Page.md │ ├── package.json │ ├── .openapi-generator-ignore │ ├── git_push.sh │ └── index.ts ├── CHANGELOG.md ├── spectral.yaml ├── openapitools.json ├── .gitignore ├── LICENSE.md ├── package.json └── scripts ├── serve-docs.js └── serve-example-docs.js /examples/typescript/.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 7.14.0 2 | -------------------------------------------------------------------------------- /examples/typescript/.gitignore: -------------------------------------------------------------------------------- 1 | wwwroot/*.js 2 | node_modules 3 | typings 4 | dist 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 1.0.0 (2025-11-25) 4 | 5 | ### Adds 6 | - initial release -------------------------------------------------------------------------------- /examples/typescript/.npmignore: -------------------------------------------------------------------------------- 1 | # empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm -------------------------------------------------------------------------------- /spectral.yaml: -------------------------------------------------------------------------------- 1 | # .spectral.yaml 2 | extends: "spectral:oas" 3 | rules: 4 | oas3-unused-component: off 5 | info-contact: off 6 | -------------------------------------------------------------------------------- /examples/typescript/tsconfig.esm.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.json", 3 | "compilerOptions": { 4 | "module": "esnext", 5 | "outDir": "dist/esm" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /openapitools.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", 3 | "spaces": 2, 4 | "generator-cli": { 5 | "version": "7.14.0" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /examples/typescript/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "declaration": true, 4 | "target": "ES6", 5 | "module": "commonjs", 6 | "noImplicitAny": true, 7 | "outDir": "dist", 8 | "rootDir": ".", 9 | "moduleResolution": "node", 10 | "typeRoots": [ 11 | "node_modules/@types" 12 | ] 13 | }, 14 | "exclude": [ 15 | "dist", 16 | "node_modules" 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/RadioFieldAllOfChoices.md: -------------------------------------------------------------------------------- 1 | # RadioFieldAllOfChoices 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { RadioFieldAllOfChoices } from 'apostrophecms-client'; 13 | 14 | const instance: RadioFieldAllOfChoices = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/CheckboxesFieldAllOfDef.md: -------------------------------------------------------------------------------- 1 | # CheckboxesFieldAllOfDef 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { CheckboxesFieldAllOfDef } from 'apostrophecms-client'; 13 | 14 | const instance: CheckboxesFieldAllOfDef = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectFieldAllOfChoices.md: -------------------------------------------------------------------------------- 1 | # SelectFieldAllOfChoices 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { SelectFieldAllOfChoices } from 'apostrophecms-client'; 13 | 14 | const instance: SelectFieldAllOfChoices = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/AttachmentFieldAllOfAccept.md: -------------------------------------------------------------------------------- 1 | # AttachmentFieldAllOfAccept 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { AttachmentFieldAllOfAccept } from 'apostrophecms-client'; 13 | 14 | const instance: AttachmentFieldAllOfAccept = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageDotNotationUpdateValue.md: -------------------------------------------------------------------------------- 1 | # PageDotNotationUpdateValue 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { PageDotNotationUpdateValue } from 'apostrophecms-client'; 13 | 14 | const instance: PageDotNotationUpdateValue = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/RadioFieldAllOfDef.md: -------------------------------------------------------------------------------- 1 | # RadioFieldAllOfDef 2 | 3 | Default selected value. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { RadioFieldAllOfDef } from 'apostrophecms-client'; 14 | 15 | const instance: RadioFieldAllOfDef = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/CheckboxesFieldAllOfChoices.md: -------------------------------------------------------------------------------- 1 | # CheckboxesFieldAllOfChoices 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | 9 | ## Example 10 | 11 | ```typescript 12 | import { CheckboxesFieldAllOfChoices } from 'apostrophecms-client'; 13 | 14 | const instance: CheckboxesFieldAllOfChoices = { 15 | }; 16 | ``` 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectChoiceValue.md: -------------------------------------------------------------------------------- 1 | # SelectChoiceValue 2 | 3 | The stored value for this choice. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SelectChoiceValue } from 'apostrophecms-client'; 14 | 15 | const instance: SelectChoiceValue = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageUpdateRequestPosition.md: -------------------------------------------------------------------------------- 1 | # PageUpdateRequestPosition 2 | 3 | New position (required if moving page) 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageUpdateRequestPosition } from 'apostrophecms-client'; 14 | 15 | const instance: PageUpdateRequestPosition = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectFieldAllOfDef.md: -------------------------------------------------------------------------------- 1 | # SelectFieldAllOfDef 2 | 3 | Default value. If `multiple: true`, this should be an array. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SelectFieldAllOfDef } from 'apostrophecms-client'; 14 | 15 | const instance: SelectFieldAllOfDef = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/Fieldset.md: -------------------------------------------------------------------------------- 1 | # Fieldset 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **add** | [**{ [key: string]: FieldDefinition; }**](FieldDefinition.md) | | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { Fieldset } from 'apostrophecms-client'; 14 | 15 | const instance: Fieldset = { 16 | add, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthReset410Response.md: -------------------------------------------------------------------------------- 1 | # AuthReset410Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { AuthReset410Response } from 'apostrophecms-client'; 14 | 15 | const instance: AuthReset410Response = { 16 | error, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthLogout200Response.md: -------------------------------------------------------------------------------- 1 | # AuthLogout200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { AuthLogout200Response } from 'apostrophecms-client'; 14 | 15 | const instance: AuthLogout200Response = { 16 | success, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageCreateRequestPosition.md: -------------------------------------------------------------------------------- 1 | # PageCreateRequestPosition 2 | 3 | Position relative to target (string values) or child index (number) 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageCreateRequestPosition } from 'apostrophecms-client'; 14 | 15 | const instance: PageCreateRequestPosition = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/RadioFieldAllOfFollowing.md: -------------------------------------------------------------------------------- 1 | # RadioFieldAllOfFollowing 2 | 3 | Populate dynamically based on other fields (supports `<` parent prefixes). 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { RadioFieldAllOfFollowing } from 'apostrophecms-client'; 14 | 15 | const instance: RadioFieldAllOfFollowing = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/StringFieldAllOfFollowingIgnore.md: -------------------------------------------------------------------------------- 1 | # StringFieldAllOfFollowingIgnore 2 | 3 | Controls which `following` values are ignored. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { StringFieldAllOfFollowingIgnore } from 'apostrophecms-client'; 14 | 15 | const instance: StringFieldAllOfFollowingIgnore = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/RadioFieldAllOfFollowingIgnore.md: -------------------------------------------------------------------------------- 1 | # RadioFieldAllOfFollowingIgnore 2 | 3 | Ignore some or all followed fields when generating values. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { RadioFieldAllOfFollowingIgnore } from 'apostrophecms-client'; 14 | 15 | const instance: RadioFieldAllOfFollowingIgnore = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectFieldAllOfFollowing.md: -------------------------------------------------------------------------------- 1 | # SelectFieldAllOfFollowing 2 | 3 | Populate dynamically based on other fields’ values (supports `<` parent prefixes). 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SelectFieldAllOfFollowing } from 'apostrophecms-client'; 14 | 15 | const instance: SelectFieldAllOfFollowing = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectFieldAllOfFollowingIgnore.md: -------------------------------------------------------------------------------- 1 | # SelectFieldAllOfFollowingIgnore 2 | 3 | Ignore some or all followed fields when generating values. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SelectFieldAllOfFollowingIgnore } from 'apostrophecms-client'; 14 | 15 | const instance: SelectFieldAllOfFollowingIgnore = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageArchiveRequest.md: -------------------------------------------------------------------------------- 1 | # PageArchiveRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of page IDs to archive | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageArchiveRequest } from 'apostrophecms-client'; 14 | 15 | const instance: PageArchiveRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/PagePublishRequest.md: -------------------------------------------------------------------------------- 1 | # PagePublishRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of page IDs to publish | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PagePublishRequest } from 'apostrophecms-client'; 14 | 15 | const instance: PagePublishRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageRestoreRequest.md: -------------------------------------------------------------------------------- 1 | # PageRestoreRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of page IDs to restore | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageRestoreRequest } from 'apostrophecms-client'; 14 | 15 | const instance: PageRestoreRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/BulkOperationRequest.md: -------------------------------------------------------------------------------- 1 | # BulkOperationRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of document IDs to operate on | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { BulkOperationRequest } from 'apostrophecms-client'; 14 | 15 | const instance: BulkOperationRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/CheckboxesFieldAllOfFollowing.md: -------------------------------------------------------------------------------- 1 | # CheckboxesFieldAllOfFollowing 2 | 3 | Populate dynamically based on other fields (supports `<` parent prefixes). 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { CheckboxesFieldAllOfFollowing } from 'apostrophecms-client'; 14 | 15 | const instance: CheckboxesFieldAllOfFollowing = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageArchiveRequest.md: -------------------------------------------------------------------------------- 1 | # ImageArchiveRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to archive | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { ImageArchiveRequest } from 'apostrophecms-client'; 14 | 15 | const instance: ImageArchiveRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImagePublishRequest.md: -------------------------------------------------------------------------------- 1 | # ImagePublishRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to publish | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { ImagePublishRequest } from 'apostrophecms-client'; 14 | 15 | const instance: ImagePublishRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageRestoreRequest.md: -------------------------------------------------------------------------------- 1 | # ImageRestoreRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to restore | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { ImageRestoreRequest } from 'apostrophecms-client'; 14 | 15 | const instance: ImageRestoreRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageLocalesResponse.md: -------------------------------------------------------------------------------- 1 | # PageLocalesResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | [**Array<PageLocaleResult>**](PageLocaleResult.md) | | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageLocalesResponse } from 'apostrophecms-client'; 14 | 15 | const instance: PageLocalesResponse = { 16 | results, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/CheckboxesFieldAllOfFollowingIgnore.md: -------------------------------------------------------------------------------- 1 | # CheckboxesFieldAllOfFollowingIgnore 2 | 3 | Ignore some or all followed fields when generating values. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { CheckboxesFieldAllOfFollowingIgnore } from 'apostrophecms-client'; 14 | 15 | const instance: CheckboxesFieldAllOfFollowingIgnore = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/SameHostnameResponse.md: -------------------------------------------------------------------------------- 1 | # SameHostnameResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **redirectTo** | **string** | Path to redirect to within same hostname | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SameHostnameResponse } from 'apostrophecms-client'; 14 | 15 | const instance: SameHostnameResponse = { 16 | redirectTo, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/StringFieldAllOfFollowing.md: -------------------------------------------------------------------------------- 1 | # StringFieldAllOfFollowing 2 | 3 | Field(s) to follow for automatic value generation. Supports `<` prefixes to access parent fields. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { StringFieldAllOfFollowing } from 'apostrophecms-client'; 14 | 15 | const instance: StringFieldAllOfFollowing = { 16 | }; 17 | ``` 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagArchiveRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagArchiveRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of file tag IDs to archive | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { FileTagArchiveRequest } from 'apostrophecms-client'; 14 | 15 | const instance: FileTagArchiveRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagPublishRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagPublishRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of file tag IDs to publish | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { FileTagPublishRequest } from 'apostrophecms-client'; 14 | 15 | const instance: FileTagPublishRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagRestoreRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagRestoreRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of file tag IDs to restore | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { FileTagRestoreRequest } from 'apostrophecms-client'; 14 | 15 | const instance: FileTagRestoreRequest = { 16 | _ids, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageLocaleResult.md: -------------------------------------------------------------------------------- 1 | # PageLocaleResult 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | | [default to undefined] 9 | **aposLocale** | **string** | | [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { PageLocaleResult } from 'apostrophecms-client'; 15 | 16 | const instance: PageLocaleResult = { 17 | _id, 18 | aposLocale, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageLocalizeByIdRequest.md: -------------------------------------------------------------------------------- 1 | # PageLocalizeByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **toLocale** | **string** | Target locale for localization | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageLocalizeByIdRequest } from 'apostrophecms-client'; 14 | 15 | const instance: PageLocalizeByIdRequest = { 16 | toLocale, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserUniqueUsernameRequest.md: -------------------------------------------------------------------------------- 1 | # UserUniqueUsernameRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **username** | **string** | Username to check for uniqueness | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { UserUniqueUsernameRequest } from 'apostrophecms-client'; 14 | 15 | const instance: UserUniqueUsernameRequest = { 16 | username, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthResetRequestRequest.md: -------------------------------------------------------------------------------- 1 | # AuthResetRequestRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **email** | **string** | Email address of the user requesting password reset | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { AuthResetRequestRequest } from 'apostrophecms-client'; 14 | 15 | const instance: AuthResetRequestRequest = { 16 | email, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject.md: -------------------------------------------------------------------------------- 1 | # InlineObject 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject = { 17 | error, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageArchive200Response.md: -------------------------------------------------------------------------------- 1 | # PageArchive200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **jobId** | **string** | ID of the background job processing the archive operation | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageArchive200Response } from 'apostrophecms-client'; 14 | 15 | const instance: PageArchive200Response = { 16 | jobId, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthLogin200Response.md: -------------------------------------------------------------------------------- 1 | # AuthLogin200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **token** | **string** | Bearer token (only present when session is false/omitted) | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { AuthLogin200Response } from 'apostrophecms-client'; 14 | 15 | const instance: AuthLogin200Response = { 16 | token, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject1.md: -------------------------------------------------------------------------------- 1 | # InlineObject1 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject1 } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject1 = { 17 | error, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject2.md: -------------------------------------------------------------------------------- 1 | # InlineObject2 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject2 } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject2 = { 17 | error, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject3.md: -------------------------------------------------------------------------------- 1 | # InlineObject3 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject3 } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject3 = { 17 | error, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject4.md: -------------------------------------------------------------------------------- 1 | # InlineObject4 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **error** | **string** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject4 } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject4 = { 17 | error, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/InlineObject5.md: -------------------------------------------------------------------------------- 1 | # InlineObject5 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { InlineObject5 } from 'apostrophecms-client'; 15 | 16 | const instance: InlineObject5 = { 17 | success, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/DifferentHostnameResponse.md: -------------------------------------------------------------------------------- 1 | # DifferentHostnameResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **redirectTo** | **string** | Full URL to redirect to with cross-domain session token | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { DifferentHostnameResponse } from 'apostrophecms-client'; 14 | 15 | const instance: DifferentHostnameResponse = { 16 | redirectTo, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/I18nLocalePost200Response.md: -------------------------------------------------------------------------------- 1 | # I18nLocalePost200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **redirectTo** | **string** | Full URL to redirect to with cross-domain session token | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { I18nLocalePost200Response } from 'apostrophecms-client'; 14 | 15 | const instance: I18nLocalePost200Response = { 16 | redirectTo, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthReset200Response.md: -------------------------------------------------------------------------------- 1 | # AuthReset200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { AuthReset200Response } from 'apostrophecms-client'; 15 | 16 | const instance: AuthReset200Response = { 17 | success, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftArchive200Response.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftArchive200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **archived** | [**Array<SubmittedDraft>**](SubmittedDraft.md) | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SubmittedDraftArchive200Response } from 'apostrophecms-client'; 14 | 15 | const instance: SubmittedDraftArchive200Response = { 16 | archived, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftRestore200Response.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftRestore200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **restored** | [**Array<SubmittedDraft>**](SubmittedDraft.md) | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SubmittedDraftRestore200Response } from 'apostrophecms-client'; 14 | 15 | const instance: SubmittedDraftRestore200Response = { 16 | restored, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftPublish200Response.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftPublish200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **published** | [**Array<SubmittedDraft>**](SubmittedDraft.md) | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SubmittedDraftPublish200Response } from 'apostrophecms-client'; 14 | 15 | const instance: SubmittedDraftPublish200Response = { 16 | published, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftLocalize200Response.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftLocalize200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **localized** | [**Array<SubmittedDraft>**](SubmittedDraft.md) | | [optional] [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { SubmittedDraftLocalize200Response } from 'apostrophecms-client'; 14 | 15 | const instance: SubmittedDraftLocalize200Response = { 16 | localized, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthResetRequest200Response.md: -------------------------------------------------------------------------------- 1 | # AuthResetRequest200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **message** | **string** | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { AuthResetRequest200Response } from 'apostrophecms-client'; 15 | 16 | const instance: AuthResetRequest200Response = { 17 | success, 18 | message, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/FlatPageResponse.md: -------------------------------------------------------------------------------- 1 | # FlatPageResponse 2 | 3 | Pages returned as flat array instead of tree structure 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **results** | [**Array<FlatPageResponseResultsInner>**](FlatPageResponseResultsInner.md) | | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { FlatPageResponse } from 'apostrophecms-client'; 15 | 16 | const instance: FlatPageResponse = { 17 | results, 18 | }; 19 | ``` 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthResetRequest.md: -------------------------------------------------------------------------------- 1 | # AuthResetRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **token** | **string** | Reset token from the password reset email | [default to undefined] 9 | **password** | **string** | New password for the user account | [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { AuthResetRequest } from 'apostrophecms-client'; 15 | 16 | const instance: AuthResetRequest = { 17 | token, 18 | password, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageGetLocalesById200Response.md: -------------------------------------------------------------------------------- 1 | # PageGetLocalesById200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | [**Array<PageGetLocalesById200ResponseResultsInner>**](PageGetLocalesById200ResponseResultsInner.md) | | [default to undefined] 9 | 10 | ## Example 11 | 12 | ```typescript 13 | import { PageGetLocalesById200Response } from 'apostrophecms-client'; 14 | 15 | const instance: PageGetLocalesById200Response = { 16 | results, 17 | }; 18 | ``` 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageTagPostRequest.md: -------------------------------------------------------------------------------- 1 | # ImageTagPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Tag name | [default to undefined] 9 | **slug** | **string** | URL-friendly identifier (auto-generated if not provided) | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { ImageTagPostRequest } from 'apostrophecms-client'; 15 | 16 | const instance: ImageTagPostRequest = { 17 | title, 18 | slug, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/NumericRangeOptions.md: -------------------------------------------------------------------------------- 1 | # NumericRangeOptions 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **min** | **number** | Minimum allowed value (inclusive). | [optional] [default to undefined] 9 | **max** | **number** | Maximum allowed value (inclusive) | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { NumericRangeOptions } from 'apostrophecms-client'; 15 | 16 | const instance: NumericRangeOptions = { 17 | min, 18 | max, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageMain.md: -------------------------------------------------------------------------------- 1 | # PageMain 2 | 3 | Main content area with rich content widgets 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **metaType** | **string** | | [optional] [default to undefined] 10 | **items** | [**Array<PageMainItemsInner>**](PageMainItemsInner.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { PageMain } from 'apostrophecms-client'; 16 | 17 | const instance: PageMain = { 18 | metaType, 19 | items, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageTagRequest.md: -------------------------------------------------------------------------------- 1 | # ImageTagRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to tag | [optional] [default to undefined] 9 | **tags** | **Array<string>** | Array of tags to add to the images | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { ImageTagRequest } from 'apostrophecms-client'; 15 | 16 | const instance: ImageTagRequest = { 17 | _ids, 18 | tags, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/FilePatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # FilePatchByIdRequest 2 | 3 | Only include fields to update 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **title** | **string** | File title | [optional] [default to undefined] 10 | **description** | **string** | File description | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FilePatchByIdRequest } from 'apostrophecms-client'; 16 | 17 | const instance: FilePatchByIdRequest = { 18 | title, 19 | description, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageLocalizeRequest.md: -------------------------------------------------------------------------------- 1 | # PageLocalizeRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of page IDs to localize | [optional] [default to undefined] 9 | **toLocale** | **string** | Target locale for localization | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { PageLocalizeRequest } from 'apostrophecms-client'; 15 | 16 | const instance: PageLocalizeRequest = { 17 | _ids, 18 | toLocale, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageLocalizeRequest.md: -------------------------------------------------------------------------------- 1 | # ImageLocalizeRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to localize | [optional] [default to undefined] 9 | **toLocale** | **string** | Target locale for localization | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { ImageLocalizeRequest } from 'apostrophecms-client'; 15 | 16 | const instance: ImageLocalizeRequest = { 17 | _ids, 18 | toLocale, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageAutocropRequest.md: -------------------------------------------------------------------------------- 1 | # ImageAutocropRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of image IDs to auto-crop | [optional] [default to undefined] 9 | **cropRatio** | **string** | Desired aspect ratio for cropping | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { ImageAutocropRequest } from 'apostrophecms-client'; 15 | 16 | const instance: ImageAutocropRequest = { 17 | _ids, 18 | cropRatio, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageTagPatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # ImageTagPatchByIdRequest 2 | 3 | Only include fields to update 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **title** | **string** | Tag name | [optional] [default to undefined] 10 | **slug** | **string** | URL-friendly identifier | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { ImageTagPatchByIdRequest } from 'apostrophecms-client'; 16 | 17 | const instance: ImageTagPatchByIdRequest = { 18 | title, 19 | slug, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/LocalesResponseValue.md: -------------------------------------------------------------------------------- 1 | # LocalesResponseValue 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **label** | **string** | Human-readable locale name | [optional] [default to undefined] 9 | **_edit** | **boolean** | Whether current user can edit content in this locale | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { LocalesResponseValue } from 'apostrophecms-client'; 15 | 16 | const instance: LocalesResponseValue = { 17 | label, 18 | _edit, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PaginatedResponse.md: -------------------------------------------------------------------------------- 1 | # PaginatedResponse 2 | 3 | Standard response format for list endpoints 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **success** | **boolean** | | [optional] [default to undefined] 10 | **data** | [**PaginatedResponseData**](PaginatedResponseData.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { PaginatedResponse } from 'apostrophecms-client'; 16 | 17 | const instance: PaginatedResponse = { 18 | success, 19 | data, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/RelationshipEntry.md: -------------------------------------------------------------------------------- 1 | # RelationshipEntry 2 | 3 | One relationship entry. Always includes the related document `_id`. If you declared per-relationship `fields`, those values are stored alongside `_id` here. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Id of the related document. | [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { RelationshipEntry } from 'apostrophecms-client'; 15 | 16 | const instance: RelationshipEntry = { 17 | _id, 18 | }; 19 | ``` 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | -------------------------------------------------------------------------------- /examples/typescript/docs/AttachmentCropRequest.md: -------------------------------------------------------------------------------- 1 | # AttachmentCropRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | The _id property of an existing image attachment document | [default to undefined] 9 | **crop** | [**AttachmentCropRequestCrop**](AttachmentCropRequestCrop.md) | | [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { AttachmentCropRequest } from 'apostrophecms-client'; 15 | 16 | const instance: AttachmentCropRequest = { 17 | _id, 18 | crop, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/BooleanFieldAllOfToggle.md: -------------------------------------------------------------------------------- 1 | # BooleanFieldAllOfToggle 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_true** | **string** | Label to display when value is true. | [optional] [default to undefined] 9 | **_false** | **string** | Label to display when value is false. | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { BooleanFieldAllOfToggle } from 'apostrophecms-client'; 15 | 16 | const instance: BooleanFieldAllOfToggle = { 17 | _true, 18 | _false, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagLocalizeRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagLocalizeRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_ids** | **Array<string>** | Array of file tag IDs to localize | [optional] [default to undefined] 9 | **toLocale** | **string** | Target locale for localization | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { FileTagLocalizeRequest } from 'apostrophecms-client'; 15 | 16 | const instance: FileTagLocalizeRequest = { 17 | _ids, 18 | toLocale, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/DateBoundaryOptions.md: -------------------------------------------------------------------------------- 1 | # DateBoundaryOptions 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **min** | **string** | Minimum allowed date (inclusive), ISO-8601 (YYYY-MM-DD). | [optional] [default to undefined] 9 | **max** | **string** | Maximum allowed date (inclusive), ISO-8601 (YYYY-MM-DD). | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { DateBoundaryOptions } from 'apostrophecms-client'; 15 | 16 | const instance: DateBoundaryOptions = { 17 | min, 18 | max, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/DateTimeBoundaryOptions.md: -------------------------------------------------------------------------------- 1 | # DateTimeBoundaryOptions 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **min** | **string** | Minimum allowed timestamp (inclusive), RFC 3339. | [optional] [default to undefined] 9 | **max** | **string** | Maximum allowed timestamp (inclusive), RFC 3339. | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { DateTimeBoundaryOptions } from 'apostrophecms-client'; 15 | 16 | const instance: DateTimeBoundaryOptions = { 17 | min, 18 | max, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageDeleteById400Response.md: -------------------------------------------------------------------------------- 1 | # PageDeleteById400Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **name** | **string** | | [optional] [default to undefined] 9 | **data** | **object** | | [optional] [default to undefined] 10 | **message** | **string** | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { PageDeleteById400Response } from 'apostrophecms-client'; 16 | 17 | const instance: PageDeleteById400Response = { 18 | name, 19 | data, 20 | message, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftGet200Response.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | [**Array<SubmittedDraft>**](SubmittedDraft.md) | | [optional] [default to undefined] 9 | **pages** | **number** | Total number of pages available | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { SubmittedDraftGet200Response } from 'apostrophecms-client'; 15 | 16 | const instance: SubmittedDraftGet200Response = { 17 | results, 18 | pages, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserUniqueUsername200Response.md: -------------------------------------------------------------------------------- 1 | # UserUniqueUsername200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **available** | **boolean** | Whether the username is available | [optional] [default to undefined] 9 | **username** | **string** | The username that was checked | [optional] [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { UserUniqueUsername200Response } from 'apostrophecms-client'; 15 | 16 | const instance: UserUniqueUsername200Response = { 17 | available, 18 | username, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/AreaWidgetGroup.md: -------------------------------------------------------------------------------- 1 | # AreaWidgetGroup 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **label** | **string** | | [default to undefined] 9 | **columns** | **number** | Number of widget previews per row (default 3). | [optional] [default to undefined] 10 | **widgets** | **{ [key: string]: object; }** | | [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { AreaWidgetGroup } from 'apostrophecms-client'; 16 | 17 | const instance: AreaWidgetGroup = { 18 | label, 19 | columns, 20 | widgets, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageGetLocalesById200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # PageGetLocalesById200ResponseResultsInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | Document ID with locale and mode | [default to undefined] 9 | **aposLocale** | **string** | Locale identifier with mode | [default to undefined] 10 | 11 | ## Example 12 | 13 | ```typescript 14 | import { PageGetLocalesById200ResponseResultsInner } from 'apostrophecms-client'; 15 | 16 | const instance: PageGetLocalesById200ResponseResultsInner = { 17 | _id, 18 | aposLocale, 19 | }; 20 | ``` 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | -------------------------------------------------------------------------------- /examples/typescript/docs/FilePostRequest.md: -------------------------------------------------------------------------------- 1 | # FilePostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | | [default to undefined] 9 | **attachment** | [**Attachment**](Attachment.md) | Attachment object from upload endpoint | [default to undefined] 10 | **description** | **string** | File description | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FilePostRequest } from 'apostrophecms-client'; 16 | 17 | const instance: FilePostRequest = { 18 | title, 19 | attachment, 20 | description, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/BulkOperationResponse.md: -------------------------------------------------------------------------------- 1 | # BulkOperationResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **modified** | **number** | Number of documents affected | [optional] [default to undefined] 10 | **errors** | **Array<string>** | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { BulkOperationResponse } from 'apostrophecms-client'; 16 | 17 | const instance: BulkOperationResponse = { 18 | success, 19 | modified, 20 | errors, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/ExistInLocaleRequest.md: -------------------------------------------------------------------------------- 1 | # ExistInLocaleRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **ids** | **Array<string>** | Array of document IDs to check | [default to undefined] 9 | **locale** | **string** | Locale to check documents in | [default to undefined] 10 | **mode** | **string** | Mode to check documents in | [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { ExistInLocaleRequest } from 'apostrophecms-client'; 16 | 17 | const instance: ExistInLocaleRequest = { 18 | ids, 19 | locale, 20 | mode, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/PieceResponse.md: -------------------------------------------------------------------------------- 1 | # PieceResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | Whether the request was successful | [optional] [default to undefined] 9 | **data** | **object** | The piece data | [optional] [default to undefined] 10 | **error** | **string** | Error message if success is false | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { PieceResponse } from 'apostrophecms-client'; 16 | 17 | const instance: PieceResponse = { 18 | success, 19 | data, 20 | error, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectChoice.md: -------------------------------------------------------------------------------- 1 | # SelectChoice 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **label** | **string** | Human-friendly label shown in UI. | [default to undefined] 9 | **value** | [**SelectChoiceValue**](SelectChoiceValue.md) | | [default to undefined] 10 | **disabled** | **boolean** | If true, show but disable this option. | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { SelectChoice } from 'apostrophecms-client'; 16 | 17 | const instance: SelectChoice = { 18 | label, 19 | value, 20 | disabled, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageGet200Response.md: -------------------------------------------------------------------------------- 1 | # ImageGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **data** | [**PaginatedResponseData**](PaginatedResponseData.md) | | [optional] [default to undefined] 10 | **results** | [**Array<Image>**](Image.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { ImageGet200Response } from 'apostrophecms-client'; 16 | 17 | const instance: ImageGet200Response = { 18 | success, 19 | data, 20 | results, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/BooleanFieldAllOfToggleOneOf.md: -------------------------------------------------------------------------------- 1 | # BooleanFieldAllOfToggleOneOf 2 | 3 | Configure custom labels for the toggle UI. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_true** | **string** | Label to display when value is true. | [optional] [default to undefined] 10 | **_false** | **string** | Label to display when value is false. | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { BooleanFieldAllOfToggleOneOf } from 'apostrophecms-client'; 16 | 17 | const instance: BooleanFieldAllOfToggleOneOf = { 18 | _true, 19 | _false, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalPostRequestContactInfo.md: -------------------------------------------------------------------------------- 1 | # GlobalPostRequestContactInfo 2 | 3 | Site-wide contact information 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **email** | **string** | | [optional] [default to undefined] 10 | **phone** | **string** | | [optional] [default to undefined] 11 | **address** | **string** | | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { GlobalPostRequestContactInfo } from 'apostrophecms-client'; 17 | 18 | const instance: GlobalPostRequestContactInfo = { 19 | email, 20 | phone, 21 | address, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalPostRequestSocialMedia.md: -------------------------------------------------------------------------------- 1 | # GlobalPostRequestSocialMedia 2 | 3 | Social media links 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **facebook** | **string** | | [optional] [default to undefined] 10 | **twitter** | **string** | | [optional] [default to undefined] 11 | **linkedin** | **string** | | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { GlobalPostRequestSocialMedia } from 'apostrophecms-client'; 17 | 18 | const instance: GlobalPostRequestSocialMedia = { 19 | facebook, 20 | twitter, 21 | linkedin, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImagePatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # ImagePatchByIdRequest 2 | 3 | Only include fields to update 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **title** | **string** | | [optional] [default to undefined] 10 | **alt** | **string** | Alt text for accessibility | [optional] [default to undefined] 11 | **credit** | **string** | Photo credit | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { ImagePatchByIdRequest } from 'apostrophecms-client'; 17 | 18 | const instance: ImagePatchByIdRequest = { 19 | title, 20 | alt, 21 | credit, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserList200Response.md: -------------------------------------------------------------------------------- 1 | # UserList200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | [**Array<User>**](User.md) | | [optional] [default to undefined] 9 | **pages** | **number** | Total number of pages | [optional] [default to undefined] 10 | **currentPage** | **number** | Current page number | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { UserList200Response } from 'apostrophecms-client'; 16 | 17 | const instance: UserList200Response = { 18 | results, 19 | pages, 20 | currentPage, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileGet200Response.md: -------------------------------------------------------------------------------- 1 | # FileGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **data** | [**PaginatedResponseData**](PaginatedResponseData.md) | | [optional] [default to undefined] 10 | **results** | [**Array<FileObject>**](FileObject.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FileGet200Response } from 'apostrophecms-client'; 16 | 17 | const instance: FileGet200Response = { 18 | success, 19 | data, 20 | results, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagPostRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | File tag name | [default to undefined] 9 | **description** | **string** | Optional description of the file tag | [optional] [default to undefined] 10 | **color** | **string** | Color code for visual organization | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FileTagPostRequest } from 'apostrophecms-client'; 16 | 17 | const instance: FileTagPostRequest = { 18 | title, 19 | description, 20 | color, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalGet200Response.md: -------------------------------------------------------------------------------- 1 | # GlobalGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **data** | [**PaginatedResponseData**](PaginatedResponseData.md) | | [optional] [default to undefined] 10 | **results** | [**Array<Global>**](Global.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { GlobalGet200Response } from 'apostrophecms-client'; 16 | 17 | const instance: GlobalGet200Response = { 18 | success, 19 | data, 20 | results, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthLoginRequest.md: -------------------------------------------------------------------------------- 1 | # AuthLoginRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **username** | **string** | User\'s login username | [default to undefined] 9 | **password** | **string** | User\'s password | [default to undefined] 10 | **session** | **boolean** | Set to true to receive session cookie instead of bearer token | [optional] [default to false] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { AuthLoginRequest } from 'apostrophecms-client'; 16 | 17 | const instance: AuthLoginRequest = { 18 | username, 19 | password, 20 | session, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagGet200Response.md: -------------------------------------------------------------------------------- 1 | # FileTagGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | [**Array<FileTag>**](FileTag.md) | | [optional] [default to undefined] 9 | **pages** | **number** | Total number of pages | [optional] [default to undefined] 10 | **currentPage** | **number** | Current page number | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FileTagGet200Response } from 'apostrophecms-client'; 16 | 17 | const instance: FileTagGet200Response = { 18 | results, 19 | pages, 20 | currentPage, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagPutByIdRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagPutByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | File tag name | [default to undefined] 9 | **description** | **string** | Optional description of the file tag | [optional] [default to undefined] 10 | **color** | **string** | Color code for visual organization | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FileTagPutByIdRequest } from 'apostrophecms-client'; 16 | 17 | const instance: FileTagPutByIdRequest = { 18 | title, 19 | description, 20 | color, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageTagGet200Response.md: -------------------------------------------------------------------------------- 1 | # ImageTagGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **success** | **boolean** | | [optional] [default to undefined] 9 | **data** | [**PaginatedResponseData**](PaginatedResponseData.md) | | [optional] [default to undefined] 10 | **results** | [**Array<ImageTag>**](ImageTag.md) | | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { ImageTagGet200Response } from 'apostrophecms-client'; 16 | 17 | const instance: ImageTagGet200Response = { 18 | success, 19 | data, 20 | results, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/LocaleRequest.md: -------------------------------------------------------------------------------- 1 | # LocaleRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **locale** | **string** | Target locale code | [default to undefined] 9 | **contextDocId** | **string** | Optional document ID for the path | [optional] [default to undefined] 10 | **clipboard** | **string** | Optional clipboard content for cross-domain situations | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { LocaleRequest } from 'apostrophecms-client'; 16 | 17 | const instance: LocaleRequest = { 18 | locale, 19 | contextDocId, 20 | clipboard, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalPostRequestSiteSettings.md: -------------------------------------------------------------------------------- 1 | # GlobalPostRequestSiteSettings 2 | 3 | Global site configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **siteName** | **string** | | [optional] [default to undefined] 10 | **tagline** | **string** | | [optional] [default to undefined] 11 | **maintenanceMode** | **boolean** | | [optional] [default to false] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { GlobalPostRequestSiteSettings } from 'apostrophecms-client'; 17 | 18 | const instance: GlobalPostRequestSiteSettings = { 19 | siteName, 20 | tagline, 21 | maintenanceMode, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTagPatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # FileTagPatchByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | File tag name | [optional] [default to undefined] 9 | **description** | **string** | Optional description of the file tag | [optional] [default to undefined] 10 | **color** | **string** | Color code for visual organization | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { FileTagPatchByIdRequest } from 'apostrophecms-client'; 16 | 17 | const instance: FileTagPatchByIdRequest = { 18 | title, 19 | description, 20 | color, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageSeoFieldsOgImage.md: -------------------------------------------------------------------------------- 1 | # PageSeoFieldsOgImage 2 | 3 | Open Graph image for social sharing 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **title** | **string** | | [optional] [default to undefined] 11 | **attachment** | [**PageSeoFieldsOgImageAttachment**](PageSeoFieldsOgImageAttachment.md) | | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { PageSeoFieldsOgImage } from 'apostrophecms-client'; 17 | 18 | const instance: PageSeoFieldsOgImage = { 19 | _id, 20 | title, 21 | attachment, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageSeoFieldsOgImageAttachment.md: -------------------------------------------------------------------------------- 1 | # PageSeoFieldsOgImageAttachment 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | | [optional] [default to undefined] 9 | **name** | **string** | | [optional] [default to undefined] 10 | **extension** | **string** | | [optional] [default to undefined] 11 | **_url** | **string** | | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { PageSeoFieldsOgImageAttachment } from 'apostrophecms-client'; 17 | 18 | const instance: PageSeoFieldsOgImageAttachment = { 19 | _id, 20 | name, 21 | extension, 22 | _url, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalPatch.md: -------------------------------------------------------------------------------- 1 | # GlobalPatch 2 | 3 | Allows for patching of costom user added fields. It blocks the modification of the title, slu, and type fields. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **title** | **string** | Default title field | [optional] [readonly] [default to undefined] 10 | **slug** | **string** | Default slug field | [optional] [readonly] [default to undefined] 11 | **type** | **string** | | [optional] [readonly] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { GlobalPatch } from 'apostrophecms-client'; 17 | 18 | const instance: GlobalPatch = { 19 | title, 20 | slug, 21 | type, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImagePostRequest.md: -------------------------------------------------------------------------------- 1 | # ImagePostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | | [default to undefined] 9 | **attachment** | [**Attachment**](Attachment.md) | Attachment object from upload endpoint | [default to undefined] 10 | **alt** | **string** | Alt text for accessibility | [optional] [default to undefined] 11 | **credit** | **string** | Photo credit | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { ImagePostRequest } from 'apostrophecms-client'; 17 | 18 | const instance: ImagePostRequest = { 19 | title, 20 | attachment, 21 | alt, 22 | credit, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "apostrophecms-client", 3 | "version": "1.0.0", 4 | "description": "OpenAPI client for apostrophecms-client", 5 | "author": "OpenAPI-Generator Contributors", 6 | "repository": { 7 | "type": "git", 8 | "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" 9 | }, 10 | "keywords": [ 11 | "axios", 12 | "typescript", 13 | "openapi-client", 14 | "openapi-generator", 15 | "apostrophecms-client" 16 | ], 17 | "license": "Unlicense", 18 | "main": "./dist/index.js", 19 | "typings": "./dist/index.d.ts", 20 | "module": "./dist/esm/index.js", 21 | "sideEffects": false, 22 | "scripts": { 23 | "build": "tsc && tsc -p tsconfig.esm.json", 24 | "prepare": "npm run build" 25 | }, 26 | "dependencies": { 27 | "axios": "^1.6.1" 28 | }, 29 | "devDependencies": { 30 | "@types/node": "12.11.5 - 12.20.42", 31 | "typescript": "^4.0 || ^5.0" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /examples/typescript/docs/ApiError.md: -------------------------------------------------------------------------------- 1 | # ApiError 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **number** | HTTP status code, e.g., 401 | [optional] [default to undefined] 9 | **code** | **string** | Application error code (optional) | [optional] [default to undefined] 10 | **message** | **string** | Human-readable error message | [default to undefined] 11 | **details** | **{ [key: string]: any; }** | Extra context about the error | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { ApiError } from 'apostrophecms-client'; 17 | 18 | const instance: ApiError = { 19 | status, 20 | code, 21 | message, 22 | details, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/docs/Error.md: -------------------------------------------------------------------------------- 1 | # ModelError 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **status** | **number** | HTTP status code, e.g., 401 | [optional] [default to undefined] 9 | **code** | **string** | Application error code (optional) | [optional] [default to undefined] 10 | **message** | **string** | Human-readable error message | [default to undefined] 11 | **details** | **{ [key: string]: any; }** | Extra context about the error | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { ModelError } from 'apostrophecms-client'; 17 | 18 | const instance: ModelError = { 19 | status, 20 | code, 21 | message, 22 | details, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # macOS 2 | .DS_Store 3 | .AppleDouble 4 | .LSOverride 5 | 6 | # Node.js 7 | node_modules/ 8 | npm-debug.log* 9 | yarn-debug.log* 10 | yarn-error.log* 11 | .npm 12 | .yarn-integrity 13 | 14 | # IDE and Editor files 15 | .vscode/ 16 | .idea/ 17 | *.swp 18 | *.swo 19 | *~ 20 | 21 | # Logs 22 | *.log 23 | logs/ 24 | 25 | # Runtime data 26 | pids/ 27 | *.pid 28 | *.seed 29 | *.pid.lock 30 | 31 | # Coverage directory used by tools like istanbul 32 | coverage/ 33 | .nyc_output/ 34 | 35 | # Dependency directories 36 | jspm_packages/ 37 | 38 | # Optional npm cache directory 39 | .npm 40 | 41 | # Optional eslint cache 42 | .eslintcache 43 | 44 | # Output of 'npm pack' 45 | *.tgz 46 | 47 | # Yarn Integrity file 48 | .yarn-integrity 49 | 50 | # dotenv environment variables file 51 | .env 52 | .env.test 53 | .env.production 54 | .env.local 55 | 56 | # Temporary folders 57 | tmp/ 58 | temp/ 59 | 60 | # OS generated files 61 | Thumbs.db 62 | ehthumbs.db 63 | Desktop.ini -------------------------------------------------------------------------------- /examples/typescript/docs/AuthContext200Response.md: -------------------------------------------------------------------------------- 1 | # AuthContext200Response 2 | 3 | Additional context based on configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **localLogin** | **boolean** | Whether local login is enabled | [optional] [default to undefined] 10 | **passwordReset** | **boolean** | Whether password reset is enabled | [optional] [default to undefined] 11 | **loginUrl** | **string** | The configured login URL | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { AuthContext200Response } from 'apostrophecms-client'; 17 | 18 | const instance: AuthContext200Response = { 19 | localLogin, 20 | passwordReset, 21 | loginUrl, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthContextPost200Response.md: -------------------------------------------------------------------------------- 1 | # AuthContextPost200Response 2 | 3 | Additional context based on configuration\" 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **localLogin** | **boolean** | Whether local login is enabled | [optional] [default to undefined] 10 | **passwordReset** | **boolean** | Whether password reset is enabled | [optional] [default to undefined] 11 | **loginUrl** | **string** | The configured login URL | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { AuthContextPost200Response } from 'apostrophecms-client'; 17 | 18 | const instance: AuthContextPost200Response = { 19 | localLogin, 20 | passwordReset, 21 | loginUrl, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/PaginatedResponseData.md: -------------------------------------------------------------------------------- 1 | # PaginatedResponseData 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **results** | **Array<object>** | | [optional] [default to undefined] 9 | **pages** | **number** | Total number of pages | [optional] [default to undefined] 10 | **currentPage** | **number** | Current page number (1-based) | [optional] [default to undefined] 11 | **total** | **number** | Total number of items across all pages | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { PaginatedResponseData } from 'apostrophecms-client'; 17 | 18 | const instance: PaginatedResponseData = { 19 | results, 20 | pages, 21 | currentPage, 22 | total, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageMainItemsInner.md: -------------------------------------------------------------------------------- 1 | # PageMainItemsInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **metaType** | **string** | | [optional] [default to undefined] 9 | **type** | **string** | | [optional] [default to undefined] 10 | **aposPlaceholder** | **boolean** | | [optional] [default to false] 11 | **content** | **string** | Widget content (varies by widget type) | [optional] [default to undefined] 12 | **_id** | **string** | | [optional] [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { PageMainItemsInner } from 'apostrophecms-client'; 18 | 19 | const instance: PageMainItemsInner = { 20 | metaType, 21 | type, 22 | aposPlaceholder, 23 | content, 24 | _id, 25 | }; 26 | ``` 27 | 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileAttachment.md: -------------------------------------------------------------------------------- 1 | # FileAttachment 2 | 3 | File attachment information 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **name** | **string** | | [optional] [default to undefined] 11 | **extension** | **string** | | [optional] [default to undefined] 12 | **length** | **number** | File size in bytes | [optional] [default to undefined] 13 | **url** | **string** | Public URL to access the file | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { FileAttachment } from 'apostrophecms-client'; 19 | 20 | const instance: FileAttachment = { 21 | _id, 22 | name, 23 | extension, 24 | length, 25 | url, 26 | }; 27 | ``` 28 | 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | -------------------------------------------------------------------------------- /examples/typescript/docs/ExistInLocaleResponse.md: -------------------------------------------------------------------------------- 1 | # ExistInLocaleResponse 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **originalLocaleIds** | **Array<string>** | Array of document IDs in the original locale and mode | [optional] [default to undefined] 9 | **newLocaleIds** | **Array<string>** | Array of document IDs in the new locale | [optional] [default to undefined] 10 | **aposDocIds** | **Array<string>** | Array of aposDocId values for the documents | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { ExistInLocaleResponse } from 'apostrophecms-client'; 16 | 17 | const instance: ExistInLocaleResponse = { 18 | originalLocaleIds, 19 | newLocaleIds, 20 | aposDocIds, 21 | }; 22 | ``` 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageAttachment.md: -------------------------------------------------------------------------------- 1 | # ImageAttachment 2 | 3 | File attachment information 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **name** | **string** | | [optional] [default to undefined] 11 | **extension** | **string** | | [optional] [default to undefined] 12 | **length** | **number** | File size in bytes | [optional] [default to undefined] 13 | **url** | **string** | Public URL to access the image | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { ImageAttachment } from 'apostrophecms-client'; 19 | 20 | const instance: ImageAttachment = { 21 | _id, 22 | name, 23 | extension, 24 | length, 25 | url, 26 | }; 27 | ``` 28 | 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | -------------------------------------------------------------------------------- /examples/typescript/docs/AttachmentCropRequestCrop.md: -------------------------------------------------------------------------------- 1 | # AttachmentCropRequestCrop 2 | 3 | Crop coordinates and dimensions 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **top** | **number** | Top coordinate of the crop area (pixels) | [default to undefined] 10 | **left** | **number** | Left coordinate of the crop area (pixels) | [default to undefined] 11 | **width** | **number** | Width of the crop area (pixels) | [default to undefined] 12 | **height** | **number** | Height of the crop area (pixels) | [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { AttachmentCropRequestCrop } from 'apostrophecms-client'; 18 | 19 | const instance: AttachmentCropRequestCrop = { 20 | top, 21 | left, 22 | width, 23 | height, 24 | }; 25 | ``` 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileObjectAttachment.md: -------------------------------------------------------------------------------- 1 | # FileObjectAttachment 2 | 3 | File attachment information 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **name** | **string** | | [optional] [default to undefined] 11 | **extension** | **string** | | [optional] [default to undefined] 12 | **length** | **number** | File size in bytes | [optional] [default to undefined] 13 | **url** | **string** | Public URL to access the file | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { FileObjectAttachment } from 'apostrophecms-client'; 19 | 20 | const instance: FileObjectAttachment = { 21 | _id, 22 | name, 23 | extension, 24 | length, 25 | url, 26 | }; 27 | ``` 28 | 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | -------------------------------------------------------------------------------- /examples/typescript/docs/WidgetImport.md: -------------------------------------------------------------------------------- 1 | # WidgetImport 2 | 3 | Import configuration for external content (used during creation/update) 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **baseUrl** | **string** | Base URL for resolving relative image URLs | [optional] [default to undefined] 10 | **html** | **string** | HTML content to import (images will be automatically imported) | [optional] [default to undefined] 11 | **imageTags** | **Array<string>** | Array of existing @apostrophecms/image-tag piece _ids to apply to imported images | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { WidgetImport } from 'apostrophecms-client'; 17 | 18 | const instance: WidgetImport = { 19 | baseUrl, 20 | html, 21 | imageTags, 22 | }; 23 | ``` 24 | 25 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 26 | -------------------------------------------------------------------------------- /examples/typescript/docs/Global.md: -------------------------------------------------------------------------------- 1 | # Global 2 | 3 | \'Built-in global content piece type for site-wide settings. 💡 Developers can add custom fields to the global piece type in their project configuration. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique identifier | [optional] [default to undefined] 10 | **title** | **string** | Default title field | [optional] [readonly] [default to undefined] 11 | **slug** | **string** | Default slug field | [optional] [readonly] [default to undefined] 12 | **type** | **string** | | [optional] [readonly] [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { Global } from 'apostrophecms-client'; 18 | 19 | const instance: Global = { 20 | _id, 21 | title, 22 | slug, 23 | type, 24 | }; 25 | ``` 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Copyright (c) 2025 Apostrophe Technologies 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /examples/typescript/docs/CreatePieceRequest.md: -------------------------------------------------------------------------------- 1 | # CreatePieceRequest 2 | 3 | Generic structure for creating any piece type 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **title** | **string** | Piece title (required for all piece types) | [default to undefined] 10 | **slug** | **string** | URL slug (auto-generated from title if not provided) | [optional] [default to undefined] 11 | **visibility** | **string** | Visibility setting | [optional] [default to VisibilityEnum_Public] 12 | **archived** | **boolean** | Whether the piece is archived | [optional] [default to false] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { CreatePieceRequest } from 'apostrophecms-client'; 18 | 19 | const instance: CreatePieceRequest = { 20 | title, 21 | slug, 22 | visibility, 23 | archived, 24 | }; 25 | ``` 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | -------------------------------------------------------------------------------- /examples/typescript/docs/AuthWhoAmI200Response.md: -------------------------------------------------------------------------------- 1 | # AuthWhoAmI200Response 2 | 3 | Additional fields based on whoamiFields configuration 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | User\'s unique identifier | [optional] [default to undefined] 10 | **username** | **string** | User\'s login username | [optional] [default to undefined] 11 | **title** | **string** | User\'s display name | [optional] [default to undefined] 12 | **email** | **string** | User\'s email address (if configured in whoamiFields) | [optional] [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { AuthWhoAmI200Response } from 'apostrophecms-client'; 18 | 19 | const instance: AuthWhoAmI200Response = { 20 | _id, 21 | username, 22 | title, 23 | email, 24 | }; 25 | ``` 26 | 27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 28 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageGetSrcById200Response.md: -------------------------------------------------------------------------------- 1 | # ImageGetSrcById200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **url** | **string** | Direct URL to the image file | [optional] [default to undefined] 9 | **width** | **number** | Image width in pixels | [optional] [default to undefined] 10 | **height** | **number** | Image height in pixels | [optional] [default to undefined] 11 | **format** | **string** | Image format | [optional] [default to undefined] 12 | **size** | **number** | File size in bytes | [optional] [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { ImageGetSrcById200Response } from 'apostrophecms-client'; 18 | 19 | const instance: ImageGetSrcById200Response = { 20 | url, 21 | width, 22 | height, 23 | format, 24 | size, 25 | }; 26 | ``` 27 | 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftPatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftPatchByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Updated title of the submitted draft | [optional] [default to undefined] 9 | **content** | **string** | Updated content of the submitted draft | [optional] [default to undefined] 10 | **submissionNotes** | **string** | Updated notes about the submission | [optional] [default to undefined] 11 | **priority** | **string** | Updated priority level for review | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { SubmittedDraftPatchByIdRequest } from 'apostrophecms-client'; 17 | 18 | const instance: SubmittedDraftPatchByIdRequest = { 19 | title, 20 | content, 21 | submissionNotes, 22 | priority, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageSummary.md: -------------------------------------------------------------------------------- 1 | # PageSummary 2 | 3 | Abbreviated page information for ancestors/references 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **title** | **string** | | [optional] [default to undefined] 11 | **slug** | **string** | | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **_url** | **string** | | [optional] [default to undefined] 14 | **level** | **number** | | [optional] [default to undefined] 15 | **rank** | **number** | | [optional] [default to undefined] 16 | 17 | ## Example 18 | 19 | ```typescript 20 | import { PageSummary } from 'apostrophecms-client'; 21 | 22 | const instance: PageSummary = { 23 | _id, 24 | title, 25 | slug, 26 | type, 27 | _url, 28 | level, 29 | rank, 30 | }; 31 | ``` 32 | 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftPutByIdRequest.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftPutByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Title of the submitted draft | [default to undefined] 9 | **content** | **string** | Content of the submitted draft | [default to undefined] 10 | **author** | **string** | Author of the submitted draft | [optional] [default to undefined] 11 | **submissionNotes** | **string** | Notes about the submission | [optional] [default to undefined] 12 | **priority** | **string** | Priority level for review | [optional] [default to PriorityEnum_Normal] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { SubmittedDraftPutByIdRequest } from 'apostrophecms-client'; 18 | 19 | const instance: SubmittedDraftPutByIdRequest = { 20 | title, 21 | content, 22 | author, 23 | submissionNotes, 24 | priority, 25 | }; 26 | ``` 27 | 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileTag.md: -------------------------------------------------------------------------------- 1 | # FileTag 2 | 3 | Built-in file tag piece type for organizing files 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **title** | **string** | Tag name | [optional] [default to undefined] 11 | **slug** | **string** | URL-friendly tag name | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **archived** | **boolean** | | [optional] [default to false] 14 | **createdAt** | **string** | | [optional] [default to undefined] 15 | **updatedAt** | **string** | | [optional] [default to undefined] 16 | 17 | ## Example 18 | 19 | ```typescript 20 | import { FileTag } from 'apostrophecms-client'; 21 | 22 | const instance: FileTag = { 23 | _id, 24 | title, 25 | slug, 26 | type, 27 | archived, 28 | createdAt, 29 | updatedAt, 30 | }; 31 | ``` 32 | 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | -------------------------------------------------------------------------------- /examples/typescript/.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/ImageTag.md: -------------------------------------------------------------------------------- 1 | # ImageTag 2 | 3 | Built-in image tag piece type for organizing images 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **title** | **string** | Tag name | [optional] [default to undefined] 11 | **slug** | **string** | URL-friendly tag name | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **archived** | **boolean** | | [optional] [default to false] 14 | **createdAt** | **string** | | [optional] [default to undefined] 15 | **updatedAt** | **string** | | [optional] [default to undefined] 16 | 17 | ## Example 18 | 19 | ```typescript 20 | import { ImageTag } from 'apostrophecms-client'; 21 | 22 | const instance: ImageTag = { 23 | _id, 24 | title, 25 | slug, 26 | type, 27 | archived, 28 | createdAt, 29 | updatedAt, 30 | }; 31 | ``` 32 | 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageSeoFields.md: -------------------------------------------------------------------------------- 1 | # PageSeoFields 2 | 3 | SEO metadata for the page 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **metaDescription** | **string** | Meta description for search engines | [optional] [default to undefined] 10 | **metaKeywords** | **string** | Meta keywords (legacy, rarely used) | [optional] [default to undefined] 11 | **ogTitle** | **string** | Open Graph title for social sharing | [optional] [default to undefined] 12 | **ogDescription** | **string** | Open Graph description for social sharing | [optional] [default to undefined] 13 | **ogImage** | [**PageSeoFieldsOgImage**](PageSeoFieldsOgImage.md) | | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { PageSeoFields } from 'apostrophecms-client'; 19 | 20 | const instance: PageSeoFields = { 21 | metaDescription, 22 | metaKeywords, 23 | ogTitle, 24 | ogDescription, 25 | ogImage, 26 | }; 27 | ``` 28 | 29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 30 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserPatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # UserPatchByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Display name for the user | [optional] [default to undefined] 9 | **email** | **string** | User\'s email address | [optional] [default to undefined] 10 | **firstName** | **string** | User\'s first name | [optional] [default to undefined] 11 | **lastName** | **string** | User\'s last name | [optional] [default to undefined] 12 | **role** | **string** | User\'s role/permission level | [optional] [default to undefined] 13 | **disabled** | **boolean** | Whether the user account is disabled | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { UserPatchByIdRequest } from 'apostrophecms-client'; 19 | 20 | const instance: UserPatchByIdRequest = { 21 | title, 22 | email, 23 | firstName, 24 | lastName, 25 | role, 26 | disabled, 27 | }; 28 | ``` 29 | 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | -------------------------------------------------------------------------------- /examples/typescript/docs/GlobalPostRequest.md: -------------------------------------------------------------------------------- 1 | # GlobalPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Global content title | [optional] [default to undefined] 9 | **footerContent** | **string** | Footer content that appears on all pages | [optional] [default to undefined] 10 | **contactInfo** | [**GlobalPostRequestContactInfo**](GlobalPostRequestContactInfo.md) | | [optional] [default to undefined] 11 | **socialMedia** | [**GlobalPostRequestSocialMedia**](GlobalPostRequestSocialMedia.md) | | [optional] [default to undefined] 12 | **siteSettings** | [**GlobalPostRequestSiteSettings**](GlobalPostRequestSiteSettings.md) | | [optional] [default to undefined] 13 | 14 | ## Example 15 | 16 | ```typescript 17 | import { GlobalPostRequest } from 'apostrophecms-client'; 18 | 19 | const instance: GlobalPostRequest = { 20 | title, 21 | footerContent, 22 | contactInfo, 23 | socialMedia, 24 | siteSettings, 25 | }; 26 | ``` 27 | 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 29 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # PageUpdateRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_targetId** | **string** | ID of target page for repositioning (required if moving page) | [optional] [default to undefined] 9 | **_position** | [**PageUpdateRequestPosition**](PageUpdateRequestPosition.md) | | [optional] [default to undefined] 10 | **title** | **string** | Updated page title | [optional] [default to undefined] 11 | **slug** | **string** | Updated URL slug | [optional] [default to undefined] 12 | **visibility** | **string** | Updated visibility setting | [optional] [default to undefined] 13 | **updatedBy** | [**User**](User.md) | | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { PageUpdateRequest } from 'apostrophecms-client'; 19 | 20 | const instance: PageUpdateRequest = { 21 | _targetId, 22 | _position, 23 | title, 24 | slug, 25 | visibility, 26 | updatedBy, 27 | }; 28 | ``` 29 | 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | -------------------------------------------------------------------------------- /examples/typescript/docs/UiCondition.md: -------------------------------------------------------------------------------- 1 | # UiCondition 2 | 3 | \'Apostrophe conditional used by `if` and `requiredIf`. Keys are field paths (including `<` parent access and dot notation) or method calls with `()`. Values are either simple equality (primitive) or an operator object. Supports `$or` / `$and` groups. See OperatorObject. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **$or** | [**Array<UiCondition>**](UiCondition.md) | Any condition group may pass. :contentReference[oaicite:1]{index=1} | [optional] [default to undefined] 10 | **$and** | [**Array<UiCondition>**](UiCondition.md) | All condition groups must pass. (Redundant at the same level, but useful when nested with `$or`.) :contentReference[oaicite:2]{index=2} | [optional] [default to undefined] 11 | 12 | ## Example 13 | 14 | ```typescript 15 | import { UiCondition } from 'apostrophecms-client'; 16 | 17 | const instance: UiCondition = { 18 | $or, 19 | $and, 20 | }; 21 | ``` 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | -------------------------------------------------------------------------------- /examples/typescript/docs/PagePatchByIdRequest.md: -------------------------------------------------------------------------------- 1 | # PagePatchByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_targetId** | **string** | ID of target page for repositioning (required if moving page) | [optional] [default to undefined] 9 | **_position** | [**PageUpdateRequestPosition**](PageUpdateRequestPosition.md) | | [optional] [default to undefined] 10 | **title** | **string** | Updated page title | [optional] [default to undefined] 11 | **slug** | **string** | Updated URL slug | [optional] [default to undefined] 12 | **visibility** | **string** | Updated visibility setting | [optional] [default to undefined] 13 | **updatedBy** | [**User**](User.md) | | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { PagePatchByIdRequest } from 'apostrophecms-client'; 19 | 20 | const instance: PagePatchByIdRequest = { 21 | _targetId, 22 | _position, 23 | title, 24 | slug, 25 | visibility, 26 | updatedBy, 27 | }; 28 | ``` 29 | 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserPutByIdRequest.md: -------------------------------------------------------------------------------- 1 | # UserPutByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Display name for the user | [default to undefined] 9 | **username** | **string** | Unique username for login | [default to undefined] 10 | **email** | **string** | User\'s email address | [default to undefined] 11 | **firstName** | **string** | User\'s first name | [optional] [default to undefined] 12 | **lastName** | **string** | User\'s last name | [optional] [default to undefined] 13 | **role** | **string** | User\'s role/permission level | [optional] [default to undefined] 14 | **disabled** | **boolean** | Whether the user account is disabled | [optional] [default to false] 15 | 16 | ## Example 17 | 18 | ```typescript 19 | import { UserPutByIdRequest } from 'apostrophecms-client'; 20 | 21 | const instance: UserPutByIdRequest = { 22 | title, 23 | username, 24 | email, 25 | firstName, 26 | lastName, 27 | role, 28 | disabled, 29 | }; 30 | ``` 31 | 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraftPostRequest.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraftPostRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Title of the submitted draft | [optional] [default to undefined] 9 | **content** | **string** | Content of the submitted draft | [optional] [default to undefined] 10 | **author** | **string** | Author of the submitted draft | [optional] [default to undefined] 11 | **submissionNotes** | **string** | Notes from the submitter about the draft | [optional] [default to undefined] 12 | **priority** | **string** | Priority level for review | [optional] [default to PriorityEnum_Normal] 13 | **category** | **string** | Category or type of content being submitted | [optional] [default to undefined] 14 | 15 | ## Example 16 | 17 | ```typescript 18 | import { SubmittedDraftPostRequest } from 'apostrophecms-client'; 19 | 20 | const instance: SubmittedDraftPostRequest = { 21 | title, 22 | content, 23 | author, 24 | submissionNotes, 25 | priority, 26 | category, 27 | }; 28 | ``` 29 | 30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 31 | -------------------------------------------------------------------------------- /examples/typescript/docs/Widget.md: -------------------------------------------------------------------------------- 1 | # Widget 2 | 3 | Content widget within an area - represents a piece of structured content 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | | [optional] [default to undefined] 10 | **metaType** | **string** | | [optional] [default to undefined] 11 | **type** | **string** | Widget type (e.g., rich-text, image, custom widgets) | [optional] [default to undefined] 12 | **_edit** | **boolean** | | [optional] [default to undefined] 13 | **_docId** | **string** | | [optional] [default to undefined] 14 | **content** | **string** | HTML content for rich text widgets (filtered based on widget configuration) | [optional] [default to undefined] 15 | **_import** | [**WidgetImport**](WidgetImport.md) | | [optional] [default to undefined] 16 | 17 | ## Example 18 | 19 | ```typescript 20 | import { Widget } from 'apostrophecms-client'; 21 | 22 | const instance: Widget = { 23 | _id, 24 | metaType, 25 | type, 26 | _edit, 27 | _docId, 28 | content, 29 | _import, 30 | }; 31 | ``` 32 | 33 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 34 | -------------------------------------------------------------------------------- /examples/typescript/docs/AreaOptions.md: -------------------------------------------------------------------------------- 1 | # AreaOptions 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **widgets** | **{ [key: string]: object; }** | Allowed widget types for this area. Keys are widget module names (e.g., \"@apostrophecms/rich-text\"). Values are per-widget options that apply *only* in this area. | [default to undefined] 9 | **groups** | [**{ [key: string]: AreaWidgetGroup; }**](AreaWidgetGroup.md) | Organize widgets into groups for the expanded preview menu. Each group has a label, optional columns (1–4, default 3), and its own widgets map (same shape as `widgets`). | [optional] [default to undefined] 10 | **max** | **number** | Maximum number of widgets allowed in this area. | [optional] [default to undefined] 11 | **expanded** | **boolean** | Use the expanded preview menu UX. | [optional] [default to undefined] 12 | 13 | ## Example 14 | 15 | ```typescript 16 | import { AreaOptions } from 'apostrophecms-client'; 17 | 18 | const instance: AreaOptions = { 19 | widgets, 20 | groups, 21 | max, 22 | expanded, 23 | }; 24 | ``` 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | -------------------------------------------------------------------------------- /examples/typescript/docs/FieldPredicate.md: -------------------------------------------------------------------------------- 1 | # FieldPredicate 2 | 3 | A simple equality (primitive) or an OperatorObject. :contentReference[oaicite:5]{index=5} 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **$eq** | **any** | | [optional] [default to undefined] 10 | **$ne** | **any** | | [optional] [default to undefined] 11 | **$gt** | **number** | | [optional] [default to undefined] 12 | **$gte** | **number** | | [optional] [default to undefined] 13 | **$lt** | **number** | | [optional] [default to undefined] 14 | **$lte** | **number** | | [optional] [default to undefined] 15 | **$in** | **Array<any>** | | [optional] [default to undefined] 16 | **$nin** | **Array<any>** | | [optional] [default to undefined] 17 | **$exists** | **boolean** | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { FieldPredicate } from 'apostrophecms-client'; 23 | 24 | const instance: FieldPredicate = { 25 | $eq, 26 | $ne, 27 | $gt, 28 | $gte, 29 | $lt, 30 | $lte, 31 | $in, 32 | $nin, 33 | $exists, 34 | }; 35 | ``` 36 | 37 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 38 | -------------------------------------------------------------------------------- /examples/typescript/docs/UserCreateRequest.md: -------------------------------------------------------------------------------- 1 | # UserCreateRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **title** | **string** | Display name for the user | [default to undefined] 9 | **username** | **string** | Unique username for login | [default to undefined] 10 | **email** | **string** | User\'s email address | [default to undefined] 11 | **password** | **string** | User\'s password | [optional] [default to undefined] 12 | **firstName** | **string** | User\'s first name | [optional] [default to undefined] 13 | **lastName** | **string** | User\'s last name | [optional] [default to undefined] 14 | **role** | **string** | User\'s role/permission level | [optional] [default to undefined] 15 | **disabled** | **boolean** | Whether the user account is disabled | [optional] [default to false] 16 | 17 | ## Example 18 | 19 | ```typescript 20 | import { UserCreateRequest } from 'apostrophecms-client'; 21 | 22 | const instance: UserCreateRequest = { 23 | title, 24 | username, 25 | email, 26 | password, 27 | firstName, 28 | lastName, 29 | role, 30 | disabled, 31 | }; 32 | ``` 33 | 34 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 35 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageCreateRequest.md: -------------------------------------------------------------------------------- 1 | # PageCreateRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_targetId** | **string** | ID of target page for positioning (_home and _archive are convenience values) | [default to undefined] 9 | **_position** | [**PageCreateRequestPosition**](PageCreateRequestPosition.md) | | [default to undefined] 10 | **_copyingId** | **string** | Optional ID of existing page to copy properties from | [optional] [default to undefined] 11 | **title** | **string** | Page title | [default to undefined] 12 | **slug** | **string** | URL slug (auto-generated if not provided) | [optional] [default to undefined] 13 | **type** | **string** | Page type (must be configured in your project) | [optional] [default to undefined] 14 | **visibility** | **string** | Who can view this page | [optional] [default to VisibilityEnum_Public] 15 | 16 | ## Example 17 | 18 | ```typescript 19 | import { PageCreateRequest } from 'apostrophecms-client'; 20 | 21 | const instance: PageCreateRequest = { 22 | _targetId, 23 | _position, 24 | _copyingId, 25 | title, 26 | slug, 27 | type, 28 | visibility, 29 | }; 30 | ``` 31 | 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | -------------------------------------------------------------------------------- /examples/typescript/docs/PagePutByIdRequest.md: -------------------------------------------------------------------------------- 1 | # PagePutByIdRequest 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_targetId** | **string** | ID of target page for positioning (_home and _archive are convenience values) | [default to undefined] 9 | **_position** | [**PageCreateRequestPosition**](PageCreateRequestPosition.md) | | [default to undefined] 10 | **_copyingId** | **string** | Optional ID of existing page to copy properties from | [optional] [default to undefined] 11 | **title** | **string** | Page title | [default to undefined] 12 | **slug** | **string** | URL slug (auto-generated if not provided) | [optional] [default to undefined] 13 | **type** | **string** | Page type (must be configured in your project) | [optional] [default to undefined] 14 | **visibility** | **string** | Who can view this page | [optional] [default to VisibilityEnum_Public] 15 | 16 | ## Example 17 | 18 | ```typescript 19 | import { PagePutByIdRequest } from 'apostrophecms-client'; 20 | 21 | const instance: PagePutByIdRequest = { 22 | _targetId, 23 | _position, 24 | _copyingId, 25 | title, 26 | slug, 27 | type, 28 | visibility, 29 | }; 30 | ``` 31 | 32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 33 | -------------------------------------------------------------------------------- /examples/typescript/docs/OperatorObject.md: -------------------------------------------------------------------------------- 1 | # OperatorObject 2 | 3 | MongoDB-style operators supported by Apostrophe conditions. Note: `$eq` has special handling with arrays (see docs). `$exists: true` means not null/undefined; empty string is truthy so use `$ne: \'\'\'\'` or check `.length`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **$eq** | **any** | | [optional] [default to undefined] 10 | **$ne** | **any** | | [optional] [default to undefined] 11 | **$gt** | **number** | | [optional] [default to undefined] 12 | **$gte** | **number** | | [optional] [default to undefined] 13 | **$lt** | **number** | | [optional] [default to undefined] 14 | **$lte** | **number** | | [optional] [default to undefined] 15 | **$in** | **Array<any>** | | [optional] [default to undefined] 16 | **$nin** | **Array<any>** | | [optional] [default to undefined] 17 | **$exists** | **boolean** | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { OperatorObject } from 'apostrophecms-client'; 23 | 24 | const instance: OperatorObject = { 25 | $eq, 26 | $ne, 27 | $gt, 28 | $gte, 29 | $lt, 30 | $lte, 31 | $in, 32 | $nin, 33 | $exists, 34 | }; 35 | ``` 36 | 37 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 38 | -------------------------------------------------------------------------------- /examples/typescript/docs/OembedField.md: -------------------------------------------------------------------------------- 1 | # OembedField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { OembedField } from 'apostrophecms-client'; 23 | 24 | const instance: OembedField = { 25 | type, 26 | label, 27 | help, 28 | htmlHelp, 29 | def, 30 | required, 31 | readOnly, 32 | hidden, 33 | _if, 34 | requiredIf, 35 | }; 36 | ``` 37 | 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | -------------------------------------------------------------------------------- /examples/typescript/docs/Image.md: -------------------------------------------------------------------------------- 1 | # Image 2 | 3 | Built-in image/media piece type for managing photos and graphics 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique identifier | [optional] [default to undefined] 10 | **title** | **string** | Image title/alt text | [optional] [default to undefined] 11 | **slug** | **string** | | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **archived** | **boolean** | | [optional] [default to false] 14 | **visibility** | **string** | | [optional] [default to VisibilityEnum_Public] 15 | **attachment** | [**ImageAttachment**](ImageAttachment.md) | | [optional] [default to undefined] 16 | **credit** | **string** | Image credit or attribution | [optional] [default to undefined] 17 | **tags** | **Array<string>** | Image tags for organization | [optional] [default to undefined] 18 | **createdAt** | **string** | | [optional] [default to undefined] 19 | **updatedAt** | **string** | | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { Image } from 'apostrophecms-client'; 25 | 26 | const instance: Image = { 27 | _id, 28 | title, 29 | slug, 30 | type, 31 | archived, 32 | visibility, 33 | attachment, 34 | credit, 35 | tags, 36 | createdAt, 37 | updatedAt, 38 | }; 39 | ``` 40 | 41 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 42 | -------------------------------------------------------------------------------- /examples/typescript/docs/File.md: -------------------------------------------------------------------------------- 1 | # ModelFile 2 | 3 | Built-in file piece type for general file uploads (PDFs, documents, etc.) 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique identifier | [optional] [default to undefined] 10 | **title** | **string** | File title/description | [optional] [default to undefined] 11 | **slug** | **string** | | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **archived** | **boolean** | | [optional] [default to false] 14 | **visibility** | **string** | | [optional] [default to VisibilityEnum_Public] 15 | **attachment** | [**FileAttachment**](FileAttachment.md) | | [optional] [default to undefined] 16 | **description** | **string** | File description | [optional] [default to undefined] 17 | **tags** | **Array<string>** | File tags for organization | [optional] [default to undefined] 18 | **createdAt** | **string** | | [optional] [default to undefined] 19 | **updatedAt** | **string** | | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { ModelFile } from 'apostrophecms-client'; 25 | 26 | const instance: ModelFile = { 27 | _id, 28 | title, 29 | slug, 30 | type, 31 | archived, 32 | visibility, 33 | attachment, 34 | description, 35 | tags, 36 | createdAt, 37 | updatedAt, 38 | }; 39 | ``` 40 | 41 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 42 | -------------------------------------------------------------------------------- /examples/typescript/docs/ColorField.md: -------------------------------------------------------------------------------- 1 | # ColorField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default hex color (e.g. \"#ff0000\"). | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { ColorField } from 'apostrophecms-client'; 23 | 24 | const instance: ColorField = { 25 | type, 26 | label, 27 | help, 28 | htmlHelp, 29 | def, 30 | required, 31 | readOnly, 32 | hidden, 33 | _if, 34 | requiredIf, 35 | }; 36 | ``` 37 | 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | -------------------------------------------------------------------------------- /examples/typescript/docs/FileObject.md: -------------------------------------------------------------------------------- 1 | # FileObject 2 | 3 | Built-in file piece type for general file uploads (PDFs, documents, etc.) 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique identifier | [optional] [default to undefined] 10 | **title** | **string** | File title/description | [optional] [default to undefined] 11 | **slug** | **string** | | [optional] [default to undefined] 12 | **type** | **string** | | [optional] [default to undefined] 13 | **archived** | **boolean** | | [optional] [default to false] 14 | **visibility** | **string** | | [optional] [default to VisibilityEnum_Public] 15 | **attachment** | [**FileObjectAttachment**](FileObjectAttachment.md) | | [optional] [default to undefined] 16 | **description** | **string** | File description | [optional] [default to undefined] 17 | **tags** | **Array<string>** | File tags for organization | [optional] [default to undefined] 18 | **createdAt** | **string** | | [optional] [default to undefined] 19 | **updatedAt** | **string** | | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { FileObject } from 'apostrophecms-client'; 25 | 26 | const instance: FileObject = { 27 | _id, 28 | title, 29 | slug, 30 | type, 31 | archived, 32 | visibility, 33 | attachment, 34 | description, 35 | tags, 36 | createdAt, 37 | updatedAt, 38 | }; 39 | ``` 40 | 41 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 42 | -------------------------------------------------------------------------------- /examples/typescript/docs/BaseField.md: -------------------------------------------------------------------------------- 1 | # BaseField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id (e.g., \"float\", \"string\", \"boolean\"). | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { BaseField } from 'apostrophecms-client'; 23 | 24 | const instance: BaseField = { 25 | type, 26 | label, 27 | help, 28 | htmlHelp, 29 | def, 30 | required, 31 | readOnly, 32 | hidden, 33 | _if, 34 | requiredIf, 35 | }; 36 | ``` 37 | 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | -------------------------------------------------------------------------------- /examples/typescript/docs/ObjectField.md: -------------------------------------------------------------------------------- 1 | # ObjectField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **fields** | [**Fieldset**](Fieldset.md) | | [default to undefined] 19 | 20 | ## Example 21 | 22 | ```typescript 23 | import { ObjectField } from 'apostrophecms-client'; 24 | 25 | const instance: ObjectField = { 26 | type, 27 | label, 28 | help, 29 | htmlHelp, 30 | def, 31 | required, 32 | readOnly, 33 | hidden, 34 | _if, 35 | requiredIf, 36 | fields, 37 | }; 38 | ``` 39 | 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | -------------------------------------------------------------------------------- /examples/typescript/docs/TimeField.md: -------------------------------------------------------------------------------- 1 | # TimeField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default value in HH:MM:SS (24-hour). If not set and not required, defaults to the current time. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | 19 | ## Example 20 | 21 | ```typescript 22 | import { TimeField } from 'apostrophecms-client'; 23 | 24 | const instance: TimeField = { 25 | type, 26 | label, 27 | help, 28 | htmlHelp, 29 | def, 30 | required, 31 | readOnly, 32 | hidden, 33 | _if, 34 | requiredIf, 35 | }; 36 | ``` 37 | 38 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 39 | -------------------------------------------------------------------------------- /examples/typescript/docs/AreaField.md: -------------------------------------------------------------------------------- 1 | # AreaField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **_options** | [**AreaOptions**](AreaOptions.md) | | [default to undefined] 19 | 20 | ## Example 21 | 22 | ```typescript 23 | import { AreaField } from 'apostrophecms-client'; 24 | 25 | const instance: AreaField = { 26 | type, 27 | label, 28 | help, 29 | htmlHelp, 30 | def, 31 | required, 32 | readOnly, 33 | hidden, 34 | _if, 35 | requiredIf, 36 | _options, 37 | }; 38 | ``` 39 | 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | -------------------------------------------------------------------------------- /examples/typescript/docs/BooleanField.md: -------------------------------------------------------------------------------- 1 | # BooleanField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **boolean** | Default value shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **toggle** | [**BooleanFieldAllOfToggle**](BooleanFieldAllOfToggle.md) | | [optional] [default to undefined] 19 | 20 | ## Example 21 | 22 | ```typescript 23 | import { BooleanField } from 'apostrophecms-client'; 24 | 25 | const instance: BooleanField = { 26 | type, 27 | label, 28 | help, 29 | htmlHelp, 30 | def, 31 | required, 32 | readOnly, 33 | hidden, 34 | _if, 35 | requiredIf, 36 | toggle, 37 | }; 38 | ``` 39 | 40 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 41 | -------------------------------------------------------------------------------- /examples/typescript/docs/IntegerField.md: -------------------------------------------------------------------------------- 1 | # IntegerField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **number** | Default integer value shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **number** | Minimum allowed value (inclusive). | [optional] [default to undefined] 19 | **max** | **number** | Maximum allowed value (inclusive) | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { IntegerField } from 'apostrophecms-client'; 25 | 26 | const instance: IntegerField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | min, 38 | max, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/AttachmentField.md: -------------------------------------------------------------------------------- 1 | # AttachmentField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **accept** | [**AttachmentFieldAllOfAccept**](AttachmentFieldAllOfAccept.md) | | [optional] [default to undefined] 19 | **maxSize** | **number** | Optional max file size in bytes (documentation-only hint). | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { AttachmentField } from 'apostrophecms-client'; 25 | 26 | const instance: AttachmentField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | accept, 38 | maxSize, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/DateField.md: -------------------------------------------------------------------------------- 1 | # DateField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default date shown in the editor UI (YYYY-MM-DD). | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **string** | Minimum allowed date (inclusive), ISO-8601 (YYYY-MM-DD). | [optional] [default to undefined] 19 | **max** | **string** | Maximum allowed date (inclusive), ISO-8601 (YYYY-MM-DD). | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { DateField } from 'apostrophecms-client'; 25 | 26 | const instance: DateField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | min, 38 | max, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/DateAndTimeField.md: -------------------------------------------------------------------------------- 1 | # DateAndTimeField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default timestamp in RFC 3339 format (e.g., 2025-08-29T13:00:00Z). | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **string** | Minimum allowed timestamp (inclusive), RFC 3339. | [optional] [default to undefined] 19 | **max** | **string** | Maximum allowed timestamp (inclusive), RFC 3339. | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { DateAndTimeField } from 'apostrophecms-client'; 25 | 26 | const instance: DateAndTimeField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | min, 38 | max, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/FloatField.md: -------------------------------------------------------------------------------- 1 | # FloatField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **number** | Default decimal value. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **number** | Minimum allowed value (inclusive). | [optional] [default to undefined] 19 | **max** | **number** | Maximum allowed value (inclusive) | [optional] [default to undefined] 20 | **format** | **string** | OpenAPI hint for tooling; always \"float\". | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { FloatField } from 'apostrophecms-client'; 26 | 27 | const instance: FloatField = { 28 | type, 29 | label, 30 | help, 31 | htmlHelp, 32 | def, 33 | required, 34 | readOnly, 35 | hidden, 36 | _if, 37 | requiredIf, 38 | min, 39 | max, 40 | format, 41 | }; 42 | ``` 43 | 44 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 45 | -------------------------------------------------------------------------------- /examples/typescript/docs/RangeField.md: -------------------------------------------------------------------------------- 1 | # RangeField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **number** | Default slider value in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **number** | Minimum value for the slider. | [optional] [default to undefined] 19 | **max** | **number** | Maximum value for the slider. | [optional] [default to undefined] 20 | **step** | **number** | Increment step for the slider. If omitted, defaults to 1. | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { RangeField } from 'apostrophecms-client'; 26 | 27 | const instance: RangeField = { 28 | type, 29 | label, 30 | help, 31 | htmlHelp, 32 | def, 33 | required, 34 | readOnly, 35 | hidden, 36 | _if, 37 | requiredIf, 38 | min, 39 | max, 40 | step, 41 | }; 42 | ``` 43 | 44 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 45 | -------------------------------------------------------------------------------- /examples/typescript/docs/UrlField.md: -------------------------------------------------------------------------------- 1 | # UrlField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default URL shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **pattern** | **string** | Optional regex for stricter validation of allowed URLs (in addition to standard URI syntax). | [optional] [default to undefined] 19 | **autocomplete** | **string** | Value for the HTML autocomplete attribute. Common values include \"url\" or \"off\". | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { UrlField } from 'apostrophecms-client'; 25 | 26 | const instance: UrlField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | pattern, 38 | autocomplete, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/EmailField.md: -------------------------------------------------------------------------------- 1 | # EmailField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default email address shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **pattern** | **string** | Optional regex for stricter validation (in addition to HTML5 email validation). | [optional] [default to undefined] 19 | **autocomplete** | **string** | Value for the HTML autocomplete attribute. Common values are \"email\" or \"off\". | [optional] [default to undefined] 20 | 21 | ## Example 22 | 23 | ```typescript 24 | import { EmailField } from 'apostrophecms-client'; 25 | 26 | const instance: EmailField = { 27 | type, 28 | label, 29 | help, 30 | htmlHelp, 31 | def, 32 | required, 33 | readOnly, 34 | hidden, 35 | _if, 36 | requiredIf, 37 | pattern, 38 | autocomplete, 39 | }; 40 | ``` 41 | 42 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 43 | -------------------------------------------------------------------------------- /examples/typescript/docs/User.md: -------------------------------------------------------------------------------- 1 | # User 2 | 3 | Built-in user piece type for account management. **Base Properties**: Inherited from @apostrophecms/piece-type **User-Specific Properties**: title, username, email, role, disabled 💡 Developers can add custom fields to the user piece type in their project configuration. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique identifier | [optional] [default to undefined] 10 | **title** | **string** | User\'s display name | [optional] [default to undefined] 11 | **username** | **string** | Login username (must be unique) | [optional] [default to undefined] 12 | **email** | **string** | User\'s email address | [optional] [default to undefined] 13 | **role** | **string** | User role - determines permissions | [optional] [default to undefined] 14 | **disabled** | **boolean** | Whether the user account is disabled | [optional] [default to false] 15 | **archived** | **boolean** | Whether the user is archived | [optional] [default to false] 16 | **visibility** | **string** | Visibility setting | [optional] [default to VisibilityEnum_LoginRequired] 17 | **type** | **string** | | [optional] [default to undefined] 18 | **slug** | **string** | | [optional] [default to undefined] 19 | **createdAt** | **string** | Account creation date | [optional] [default to undefined] 20 | **updatedAt** | **string** | Last update date | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { User } from 'apostrophecms-client'; 26 | 27 | const instance: User = { 28 | _id, 29 | title, 30 | username, 31 | email, 32 | role, 33 | disabled, 34 | archived, 35 | visibility, 36 | type, 37 | slug, 38 | createdAt, 39 | updatedAt, 40 | }; 41 | ``` 42 | 43 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 44 | -------------------------------------------------------------------------------- /examples/typescript/docs/RadioField.md: -------------------------------------------------------------------------------- 1 | # RadioField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | [**RadioFieldAllOfDef**](RadioFieldAllOfDef.md) | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **choices** | [**RadioFieldAllOfChoices**](RadioFieldAllOfChoices.md) | | [default to undefined] 19 | **following** | [**RadioFieldAllOfFollowing**](RadioFieldAllOfFollowing.md) | | [optional] [default to undefined] 20 | **followingIgnore** | [**RadioFieldAllOfFollowingIgnore**](RadioFieldAllOfFollowingIgnore.md) | | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { RadioField } from 'apostrophecms-client'; 26 | 27 | const instance: RadioField = { 28 | type, 29 | label, 30 | help, 31 | htmlHelp, 32 | def, 33 | required, 34 | readOnly, 35 | hidden, 36 | _if, 37 | requiredIf, 38 | choices, 39 | following, 40 | followingIgnore, 41 | }; 42 | ``` 43 | 44 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 45 | -------------------------------------------------------------------------------- /examples/typescript/docs/ArrayField.md: -------------------------------------------------------------------------------- 1 | # ArrayField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **fields** | [**Fieldset**](Fieldset.md) | | [default to undefined] 19 | **min** | **number** | Minimum number of items (inclusive). | [optional] [default to undefined] 20 | **max** | **number** | Maximum number of items (inclusive). | [optional] [default to undefined] 21 | **titleField** | **string** | Field name in each item used as the item label in the UI. | [optional] [default to undefined] 22 | 23 | ## Example 24 | 25 | ```typescript 26 | import { ArrayField } from 'apostrophecms-client'; 27 | 28 | const instance: ArrayField = { 29 | type, 30 | label, 31 | help, 32 | htmlHelp, 33 | def, 34 | required, 35 | readOnly, 36 | hidden, 37 | _if, 38 | requiredIf, 39 | fields, 40 | min, 41 | max, 42 | titleField, 43 | }; 44 | ``` 45 | 46 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 47 | -------------------------------------------------------------------------------- /examples/typescript/git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | git_host=$4 10 | 11 | if [ "$git_host" = "" ]; then 12 | git_host="github.com" 13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host" 14 | fi 15 | 16 | if [ "$git_user_id" = "" ]; then 17 | git_user_id="GIT_USER_ID" 18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 19 | fi 20 | 21 | if [ "$git_repo_id" = "" ]; then 22 | git_repo_id="GIT_REPO_ID" 23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 24 | fi 25 | 26 | if [ "$release_note" = "" ]; then 27 | release_note="Minor update" 28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 29 | fi 30 | 31 | # Initialize the local directory as a Git repository 32 | git init 33 | 34 | # Adds the files in the local repository and stages them for commit. 35 | git add . 36 | 37 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 38 | git commit -m "$release_note" 39 | 40 | # Sets the new remote 41 | git_remote=$(git remote) 42 | if [ "$git_remote" = "" ]; then # git remote not defined 43 | 44 | if [ "$GIT_TOKEN" = "" ]; then 45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git 47 | else 48 | git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git 49 | fi 50 | 51 | fi 52 | 53 | git pull origin master 54 | 55 | # Pushes (Forces) the changes in the local repository up to the remote repository 56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" 57 | git push origin master 2>&1 | grep -v 'To https' 58 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "apostrophecms-openapi", 3 | "version": "1.0.0", 4 | "description": "OpenAPI 3.0 specification for the ApostropheCMS REST API", 5 | "main": "apostrophecms-openapi.yaml", 6 | "scripts": { 7 | "docs": "node scripts/serve-docs.js", 8 | "docs:open": "node scripts/serve-docs.js --open", 9 | "example-docs": "node scripts/serve-example-docs.js", 10 | "example-docs:open": "node scripts/serve-example-docs.js --open", 11 | "validate": "swagger-cli validate apostrophecms-openapi.yaml", 12 | "lint": "spectral lint apostrophecms-openapi.yaml", 13 | "test": "npm run validate && npm run lint", 14 | "generate:typescript": "openapi-generator-cli generate -i apostrophecms-openapi.yaml -g typescript-axios -o ./examples/typescript --additional-properties=npmName=apostrophecms-client,supportsES6=true", 15 | "generate:python": "openapi-generator-cli generate -i apostrophecms-openapi.yaml -g python -o ./examples/python --additional-properties=packageName=apostrophecms_client", 16 | "generate:php": "openapi-generator-cli generate -i apostrophecms-openapi.yaml -g php -o ./examples/php --additional-properties=packageName=ApostropheCMS,invokerPackage=ApostropheCMS,composerVendorName=apostrophecms,composerPackageName=api-client" 17 | }, 18 | "keywords": [ 19 | "openapi", 20 | "api", 21 | "rest", 22 | "apostrophecms", 23 | "cms", 24 | "headless", 25 | "specification", 26 | "swagger" 27 | ], 28 | "author": "ApostropheCMS Team", 29 | "license": "MIT", 30 | "repository": { 31 | "type": "git", 32 | "url": "https://github.com/apostrophecms/apostrophecms-openapi.git" 33 | }, 34 | "homepage": "https://github.com/apostrophecms/apostrophecms-openapi#readme", 35 | "devDependencies": { 36 | "@openapitools/openapi-generator-cli": "^2.7.0", 37 | "@stoplight/spectral-cli": "^6.11.0", 38 | "express": "^4.18.2", 39 | "open": "^8.4.2", 40 | "swagger-cli": "^4.0.4", 41 | "swagger-ui-dist": "^5.9.0" 42 | }, 43 | "files": [ 44 | "apostrophecms-openapi.yaml", 45 | "README.md", 46 | "LICENSE.md" 47 | ] 48 | } -------------------------------------------------------------------------------- /examples/typescript/docs/RelationshipReverseField.md: -------------------------------------------------------------------------------- 1 | # RelationshipReverseField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **withType** | **string** | Module name that holds the forward relationship. | [default to undefined] 19 | **reverseOf** | **string** | Name of the forward relationship field on `withType` (e.g.,\"_authors\" on \"article\"). | [default to undefined] 20 | **builders** | **{ [key: string]: any; }** | Cursor builders applied when populating the reverse join. | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { RelationshipReverseField } from 'apostrophecms-client'; 26 | 27 | const instance: RelationshipReverseField = { 28 | type, 29 | label, 30 | help, 31 | htmlHelp, 32 | def, 33 | required, 34 | readOnly, 35 | hidden, 36 | _if, 37 | requiredIf, 38 | withType, 39 | reverseOf, 40 | builders, 41 | }; 42 | ``` 43 | 44 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 45 | -------------------------------------------------------------------------------- /examples/typescript/docs/CheckboxesField.md: -------------------------------------------------------------------------------- 1 | # CheckboxesField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | [**Array<CheckboxesFieldAllOfDef>**](CheckboxesFieldAllOfDef.md) | Default selected values. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **choices** | [**CheckboxesFieldAllOfChoices**](CheckboxesFieldAllOfChoices.md) | | [default to undefined] 19 | **following** | [**CheckboxesFieldAllOfFollowing**](CheckboxesFieldAllOfFollowing.md) | | [optional] [default to undefined] 20 | **followingIgnore** | [**CheckboxesFieldAllOfFollowingIgnore**](CheckboxesFieldAllOfFollowingIgnore.md) | | [optional] [default to undefined] 21 | 22 | ## Example 23 | 24 | ```typescript 25 | import { CheckboxesField } from 'apostrophecms-client'; 26 | 27 | const instance: CheckboxesField = { 28 | type, 29 | label, 30 | help, 31 | htmlHelp, 32 | def, 33 | required, 34 | readOnly, 35 | hidden, 36 | _if, 37 | requiredIf, 38 | choices, 39 | following, 40 | followingIgnore, 41 | }; 42 | ``` 43 | 44 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 45 | -------------------------------------------------------------------------------- /examples/typescript/index.ts: -------------------------------------------------------------------------------- 1 | /* tslint:disable */ 2 | /* eslint-disable */ 3 | /** 4 | * ApostropheCMS REST API 5 | * **🚀 The headless CMS that developers actually want to use** **For production use:** Download this YAML file and update the server URL and cookie names to match your setup. The ApostropheCMS REST API allows you to create, read, update, and delete content programmatically. Perfect for building modern websites, mobile apps, and any digital experience that needs flexible content management. ## Quick Start Guide 1. **Authentication**: Use the login endpoint to get a bearer token or session cookie 2. **Get Content**: Start with `/@apostrophecms/page` to fetch your page structure 3. **Media Files**: Upload files via `/@apostrophecms/attachment/upload` 4. **Internationalization**: Use `/@apostrophecms/i18n` to localize your content ## Content Architecture ApostropheCMS uses a flexible \"pieces\" system for content types. While the core system provides essential pieces like users and global content, most projects define custom piece types like articles, events, or products using the `@apostrophecms/piece-type` module. ## Built-in Piece Types - `@apostrophecms/user` - User accounts and profiles - `@apostrophecms/global` - Site-wide content (customizable with additional fields) - `@apostrophecms/image` - Image file management - `@apostrophecms/file` - General file management (PDFs, documents, etc.) ## Built-in Tag Types - `@apostrophecms/image-tag` - Tags for organizing images - `@apostrophecms/file-tag` - Tags for organizing files ## Authentication Methods - **Bearer Token**: Recommended for API clients and SPAs - **Session Cookie**: For traditional web applications - **API Key**: For server-to-server communication ## Rate Limiting API requests are rate-limited to prevent abuse. See response headers for current limits. 6 | * 7 | * The version of the OpenAPI document: 1.0.0 8 | * Contact: support@apostrophecms.com 9 | * 10 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). 11 | * https://openapi-generator.tech 12 | * Do not edit the class manually. 13 | */ 14 | 15 | 16 | export * from "./api"; 17 | export * from "./configuration"; 18 | 19 | -------------------------------------------------------------------------------- /examples/typescript/docs/SelectField.md: -------------------------------------------------------------------------------- 1 | # SelectField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | [**SelectFieldAllOfDef**](SelectFieldAllOfDef.md) | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **multiple** | **boolean** | Allow selecting multiple values (stores an array). | [optional] [default to undefined] 19 | **choices** | [**SelectFieldAllOfChoices**](SelectFieldAllOfChoices.md) | | [optional] [default to undefined] 20 | **following** | [**SelectFieldAllOfFollowing**](SelectFieldAllOfFollowing.md) | | [optional] [default to undefined] 21 | **followingIgnore** | [**SelectFieldAllOfFollowingIgnore**](SelectFieldAllOfFollowingIgnore.md) | | [optional] [default to undefined] 22 | 23 | ## Example 24 | 25 | ```typescript 26 | import { SelectField } from 'apostrophecms-client'; 27 | 28 | const instance: SelectField = { 29 | type, 30 | label, 31 | help, 32 | htmlHelp, 33 | def, 34 | required, 35 | readOnly, 36 | hidden, 37 | _if, 38 | requiredIf, 39 | multiple, 40 | choices, 41 | following, 42 | followingIgnore, 43 | }; 44 | ``` 45 | 46 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 47 | -------------------------------------------------------------------------------- /examples/typescript/docs/PasswordField.md: -------------------------------------------------------------------------------- 1 | # PasswordField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default password value (generally not used). | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **min** | **number** | Minimum number of characters required. | [optional] [default to undefined] 19 | **max** | **number** | Maximum number of characters allowed. | [optional] [default to undefined] 20 | **pattern** | **string** | Regex to enforce password rules (e.g., at least one number). | [optional] [default to undefined] 21 | **autocomplete** | **string** | HTML autocomplete attribute, usually \"new-password\" or \"current-password\". | [optional] [default to undefined] 22 | 23 | ## Example 24 | 25 | ```typescript 26 | import { PasswordField } from 'apostrophecms-client'; 27 | 28 | const instance: PasswordField = { 29 | type, 30 | label, 31 | help, 32 | htmlHelp, 33 | def, 34 | required, 35 | readOnly, 36 | hidden, 37 | _if, 38 | requiredIf, 39 | min, 40 | max, 41 | pattern, 42 | autocomplete, 43 | }; 44 | ``` 45 | 46 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 47 | -------------------------------------------------------------------------------- /scripts/serve-docs.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const path = require('path'); 3 | const fs = require('fs'); 4 | const open = require('open'); 5 | 6 | const app = express(); 7 | const port = 3001; 8 | 9 | // Serve swagger-ui-dist files 10 | const swaggerUiAssetPath = require('swagger-ui-dist').getAbsoluteFSPath(); 11 | app.use('/swagger-ui', express.static(swaggerUiAssetPath)); 12 | 13 | // Serve custom CSS 14 | app.use('/styles', express.static(path.join(__dirname, '../styles'), { 15 | setHeaders: (res, path) => { 16 | if (path.endsWith('.css')) { 17 | res.setHeader('Content-Type', 'text/css'); 18 | } 19 | } 20 | })); 21 | 22 | // Serve the OpenAPI spec 23 | app.get('/openapi.yaml', (req, res) => { 24 | res.sendFile(path.join(__dirname, '../apostrophecms-openapi.yaml')); 25 | }); 26 | 27 | // Serve a custom HTML page 28 | app.get('/', (req, res) => { 29 | const html = ` 30 | 31 | 32 | 33 | ApostropheCMS API Documentation 34 | 35 | 36 | 39 | 40 | 41 |
42 | 43 | 44 | 58 | 59 | `; 60 | res.send(html); 61 | }); 62 | 63 | app.listen(port, () => { 64 | const url = `http://localhost:${port}`; 65 | console.log(`📚 ApostropheCMS API Documentation available at: ${url}`); 66 | console.log(`📝 Edit apostrophecms-openapi.yaml and refresh to see changes`); 67 | 68 | // Open browser if --open flag is passed 69 | if (process.argv.includes('--open')) { 70 | open(url); 71 | } 72 | }); -------------------------------------------------------------------------------- /scripts/serve-example-docs.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const path = require('path'); 3 | const fs = require('fs'); 4 | const open = require('open'); 5 | 6 | const app = express(); 7 | const port = 3001; 8 | 9 | // Serve swagger-ui-dist files 10 | const swaggerUiAssetPath = require('swagger-ui-dist').getAbsoluteFSPath(); 11 | app.use('/swagger-ui', express.static(swaggerUiAssetPath)); 12 | 13 | // Serve custom CSS 14 | app.use('/styles', express.static(path.join(__dirname, '../styles'), { 15 | setHeaders: (res, path) => { 16 | if (path.endsWith('.css')) { 17 | res.setHeader('Content-Type', 'text/css'); 18 | } 19 | } 20 | })); 21 | 22 | // Serve the OpenAPI spec 23 | app.get('/openapi.yaml', (req, res) => { 24 | res.sendFile(path.join(__dirname, '../examples/apostrophecms-piece-examples.yaml')); 25 | }); 26 | 27 | // Serve a custom HTML page 28 | app.get('/', (req, res) => { 29 | const html = ` 30 | 31 | 32 | 33 | ApostropheCMS API Documentation 34 | 35 | 36 | 39 | 40 | 41 |
42 | 43 | 44 | 58 | 59 | `; 60 | res.send(html); 61 | }); 62 | 63 | app.listen(port, () => { 64 | const url = `http://localhost:${port}`; 65 | console.log(`📚 ApostropheCMS API Documentation available at: ${url}`); 66 | console.log(`📝 Edit apostrophecms-openapi.yaml and refresh to see changes`); 67 | 68 | // Open browser if --open flag is passed 69 | if (process.argv.includes('--open')) { 70 | open(url); 71 | } 72 | }); -------------------------------------------------------------------------------- /examples/typescript/docs/SlugField.md: -------------------------------------------------------------------------------- 1 | # SlugField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default slug value shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **prefix** | **string** | Optional prefix automatically prepended when generating the slug. | [optional] [default to undefined] 19 | **source** | **string** | Name of the field this slug should follow (usually \"title\"). Works with `following`/`followingIgnore`. | [optional] [default to undefined] 20 | **unique** | **boolean** | If true, ensures slug is unique across docs of this type. | [optional] [default to undefined] 21 | **pattern** | **string** | Optional regex to further constrain allowed slugs. | [optional] [default to undefined] 22 | 23 | ## Example 24 | 25 | ```typescript 26 | import { SlugField } from 'apostrophecms-client'; 27 | 28 | const instance: SlugField = { 29 | type, 30 | label, 31 | help, 32 | htmlHelp, 33 | def, 34 | required, 35 | readOnly, 36 | hidden, 37 | _if, 38 | requiredIf, 39 | prefix, 40 | source, 41 | unique, 42 | pattern, 43 | }; 44 | ``` 45 | 46 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 47 | -------------------------------------------------------------------------------- /examples/typescript/docs/RelationshipField.md: -------------------------------------------------------------------------------- 1 | # RelationshipField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **any** | | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **withType** | **string** | Module name of the related doc type (e.g., \"article\", \"@apostrophecms/image\"). | [default to undefined] 19 | **min** | **number** | Minimum number of related docs required (inclusive). | [optional] [default to undefined] 20 | **max** | **number** | Maximum number of related docs allowed (inclusive). | [optional] [default to undefined] 21 | **fields** | [**Fieldset**](Fieldset.md) | | [optional] [default to undefined] 22 | **builders** | **{ [key: string]: any; }** | Apostrophe cursor builders for the related query (e.g., {project: { title: 1 }, sort: { title: 1 } }). | [optional] [default to undefined] 23 | 24 | ## Example 25 | 26 | ```typescript 27 | import { RelationshipField } from 'apostrophecms-client'; 28 | 29 | const instance: RelationshipField = { 30 | type, 31 | label, 32 | help, 33 | htmlHelp, 34 | def, 35 | required, 36 | readOnly, 37 | hidden, 38 | _if, 39 | requiredIf, 40 | withType, 41 | min, 42 | max, 43 | fields, 44 | builders, 45 | }; 46 | ``` 47 | 48 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 49 | -------------------------------------------------------------------------------- /examples/typescript/docs/Attachment.md: -------------------------------------------------------------------------------- 1 | # Attachment 2 | 3 | File attachment information from upload endpoint 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique attachment identifier | [optional] [default to undefined] 10 | **_url** | **string** | URL to the original file | [optional] [default to undefined] 11 | **_urls** | **{ [key: string]: string; }** | URLs for different image sizes (images only) | [optional] [default to undefined] 12 | **name** | **string** | Slugified filename | [optional] [default to undefined] 13 | **title** | **string** | Sortified filename | [optional] [default to undefined] 14 | **extension** | **string** | File extension | [optional] [default to undefined] 15 | **type** | **string** | | [optional] [default to undefined] 16 | **group** | **string** | File group type | [optional] [default to undefined] 17 | **length** | **number** | File size in bytes | [optional] [default to undefined] 18 | **md5** | **string** | MD5 checksum | [optional] [default to undefined] 19 | **width** | **number** | Image width in pixels (images only) | [optional] [default to undefined] 20 | **height** | **number** | Image height in pixels (images only) | [optional] [default to undefined] 21 | **landscape** | **boolean** | Whether image is landscape orientation (images only) | [optional] [default to undefined] 22 | **portrait** | **boolean** | Whether image is portrait orientation (images only) | [optional] [default to undefined] 23 | **docIds** | **Array<string>** | IDs of documents using this attachment | [optional] [default to undefined] 24 | **archivedDocIds** | **Array<string>** | IDs of archived documents using this attachment | [optional] [default to undefined] 25 | **createdAt** | **string** | | [optional] [default to undefined] 26 | **updatedAt** | **string** | | [optional] [default to undefined] 27 | 28 | ## Example 29 | 30 | ```typescript 31 | import { Attachment } from 'apostrophecms-client'; 32 | 33 | const instance: Attachment = { 34 | _id, 35 | _url, 36 | _urls, 37 | name, 38 | title, 39 | extension, 40 | type, 41 | group, 42 | length, 43 | md5, 44 | width, 45 | height, 46 | landscape, 47 | portrait, 48 | docIds, 49 | archivedDocIds, 50 | createdAt, 51 | updatedAt, 52 | }; 53 | ``` 54 | 55 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 56 | -------------------------------------------------------------------------------- /examples/typescript/docs/StringField.md: -------------------------------------------------------------------------------- 1 | # StringField 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **type** | **string** | Apostrophe field type id. | [default to undefined] 9 | **label** | **string** | Human-readable label for editors. | [default to undefined] 10 | **help** | **string** | Short helper text shown in the UI. | [optional] [default to undefined] 11 | **htmlHelp** | **string** | Rich helper text (HTML allowed by Apostrophe). | [optional] [default to undefined] 12 | **def** | **string** | Default value shown in the editor UI. | [optional] [default to undefined] 13 | **required** | **boolean** | If true, value must be provided. | [optional] [default to undefined] 14 | **readOnly** | **boolean** | If true, UI should render as read-only (Apostrophe option). | [optional] [default to undefined] 15 | **hidden** | **boolean** | If true, hide in editor UI. | [optional] [default to undefined] 16 | **_if** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 17 | **requiredIf** | [**UiCondition**](UiCondition.md) | | [optional] [default to undefined] 18 | **textarea** | **boolean** | If true, renders a multiline textarea UI. | [optional] [default to undefined] 19 | **min** | **number** | Minimum number of characters allowed. | [optional] [default to undefined] 20 | **max** | **number** | Maximum number of characters allowed. | [optional] [default to undefined] 21 | **pattern** | **string** | Regular expression (string form) to validate the input. Only matching values are allowed. | [optional] [default to undefined] 22 | **autocomplete** | **string** | Value of the HTML autocomplete attribute (see MDN). Use `\"off\"` to disable autocomplete. | [optional] [default to undefined] 23 | **following** | [**StringFieldAllOfFollowing**](StringFieldAllOfFollowing.md) | | [optional] [default to undefined] 24 | **followingIgnore** | [**StringFieldAllOfFollowingIgnore**](StringFieldAllOfFollowingIgnore.md) | | [optional] [default to undefined] 25 | **sortify** | **boolean** | If true, creates a parallel “sortified” version of this field for case- and punctuation-insensitive sorting. | [optional] [default to undefined] 26 | 27 | ## Example 28 | 29 | ```typescript 30 | import { StringField } from 'apostrophecms-client'; 31 | 32 | const instance: StringField = { 33 | type, 34 | label, 35 | help, 36 | htmlHelp, 37 | def, 38 | required, 39 | readOnly, 40 | hidden, 41 | _if, 42 | requiredIf, 43 | textarea, 44 | min, 45 | max, 46 | pattern, 47 | autocomplete, 48 | following, 49 | followingIgnore, 50 | sortify, 51 | }; 52 | ``` 53 | 54 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 55 | -------------------------------------------------------------------------------- /examples/typescript/docs/SubmittedDraft.md: -------------------------------------------------------------------------------- 1 | # SubmittedDraft 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | Unique identifier for the submitted draft | [default to undefined] 9 | **type** | **string** | Document type identifier | [default to undefined] 10 | **title** | **string** | Title of the submitted draft | [default to undefined] 11 | **slug** | **string** | URL-friendly version of the title | [optional] [default to undefined] 12 | **content** | **string** | Content of the submitted draft | [default to undefined] 13 | **author** | **string** | Author of the submitted draft | [default to undefined] 14 | **authorId** | **string** | ID of the user who created the draft | [optional] [default to undefined] 15 | **submissionNotes** | **string** | Notes from the submitter about the draft | [optional] [default to undefined] 16 | **priority** | **string** | Priority level for review | [optional] [default to undefined] 17 | **category** | **string** | Category or type of content being submitted | [optional] [default to undefined] 18 | **status** | **string** | Current status of the submitted draft | [default to undefined] 19 | **submittedAt** | **string** | When the draft was submitted for review | [optional] [default to undefined] 20 | **reviewedAt** | **string** | When the draft was last reviewed | [optional] [default to undefined] 21 | **reviewedBy** | **string** | ID of the user who reviewed the draft | [optional] [default to undefined] 22 | **reviewNotes** | **string** | Notes from the reviewer | [optional] [default to undefined] 23 | **publishedAt** | **string** | When the draft was published (if applicable) | [optional] [default to undefined] 24 | **archived** | **boolean** | Whether the submitted draft is archived | [optional] [default to false] 25 | **createdAt** | **string** | When the submitted draft was created | [default to undefined] 26 | **updatedAt** | **string** | When the submitted draft was last updated | [default to undefined] 27 | **aposLocale** | **string** | Locale for this version of the content | [optional] [default to undefined] 28 | **aposMode** | **string** | Content mode (draft or published) | [optional] [default to undefined] 29 | 30 | ## Example 31 | 32 | ```typescript 33 | import { SubmittedDraft } from 'apostrophecms-client'; 34 | 35 | const instance: SubmittedDraft = { 36 | _id, 37 | type, 38 | title, 39 | slug, 40 | content, 41 | author, 42 | authorId, 43 | submissionNotes, 44 | priority, 45 | category, 46 | status, 47 | submittedAt, 48 | reviewedAt, 49 | reviewedBy, 50 | reviewNotes, 51 | publishedAt, 52 | archived, 53 | createdAt, 54 | updatedAt, 55 | aposLocale, 56 | aposMode, 57 | }; 58 | ``` 59 | 60 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 61 | -------------------------------------------------------------------------------- /examples/typescript/docs/FlatPageResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # FlatPageResponseResultsInner 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | Unique document identifier | [optional] [default to undefined] 9 | **orphan** | **boolean** | Whether page is excluded from navigation menus | [optional] [default to undefined] 10 | **visibility** | **string** | Page visibility setting - controls who can view this page | [optional] [default to undefined] 11 | **type** | **string** | Page type identifier (configured in your project) | [optional] [default to undefined] 12 | **title** | **string** | Page title - used for navigation and SEO | [optional] [default to undefined] 13 | **slug** | **string** | URL slug for the page | [optional] [default to undefined] 14 | **rank** | **number** | Order among sibling pages (for navigation sorting) | [optional] [default to undefined] 15 | **level** | **number** | Page tree depth level (0 = home page) | [optional] [default to undefined] 16 | **path** | **string** | Ancestor path of page IDs | [optional] [default to undefined] 17 | **_url** | **string** | Complete page URL - use this for links | [optional] [default to undefined] 18 | **_ancestors** | **Array<string>** | Array of ancestor page IDs (in flat response) | [optional] [default to undefined] 19 | **_children** | **Array<string>** | Array of child page IDs (in flat response) | [optional] [default to undefined] 20 | **createdAt** | **string** | ISO date of creation | [optional] [default to undefined] 21 | **updatedAt** | **string** | ISO date of last update | [optional] [default to undefined] 22 | **archived** | **boolean** | Whether page is archived (hidden from normal views) | [optional] [default to undefined] 23 | **historicUrls** | **Array<string>** | Previous URLs that redirect to this page (SEO preservation) | [optional] [default to undefined] 24 | **metaType** | **string** | | [optional] [default to undefined] 25 | **titleSortified** | **string** | Sortable version of title | [optional] [default to undefined] 26 | **updatedBy** | [**User**](User.md) | | [optional] [default to undefined] 27 | **_edit** | **boolean** | Whether current user can edit this page | [optional] [default to undefined] 28 | 29 | ## Example 30 | 31 | ```typescript 32 | import { FlatPageResponseResultsInner } from 'apostrophecms-client'; 33 | 34 | const instance: FlatPageResponseResultsInner = { 35 | _id, 36 | orphan, 37 | visibility, 38 | type, 39 | title, 40 | slug, 41 | rank, 42 | level, 43 | path, 44 | _url, 45 | _ancestors, 46 | _children, 47 | createdAt, 48 | updatedAt, 49 | archived, 50 | historicUrls, 51 | metaType, 52 | titleSortified, 53 | updatedBy, 54 | _edit, 55 | }; 56 | ``` 57 | 58 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 59 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageTreeResponse.md: -------------------------------------------------------------------------------- 1 | # PageTreeResponse 2 | 3 | Complete page data with nested children structure - perfect for building navigation 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique document identifier | [optional] [default to undefined] 10 | **orphan** | **boolean** | Whether page is excluded from navigation menus | [optional] [default to undefined] 11 | **visibility** | **string** | Page visibility setting - controls who can view this page | [optional] [default to undefined] 12 | **type** | **string** | Page type identifier (configured in your project) | [optional] [default to undefined] 13 | **title** | **string** | Page title - used for navigation and SEO | [optional] [default to undefined] 14 | **slug** | **string** | URL slug for the page | [optional] [default to undefined] 15 | **rank** | **number** | Order among sibling pages (for navigation sorting) | [optional] [default to undefined] 16 | **level** | **number** | Page tree depth level (0 = home page) | [optional] [default to undefined] 17 | **path** | **string** | Ancestor path of page IDs | [optional] [default to undefined] 18 | **_url** | **string** | Complete page URL - use this for links | [optional] [default to undefined] 19 | **_ancestors** | [**Array<PageSummary>**](PageSummary.md) | Array of ancestor pages (for breadcrumbs) | [optional] [default to undefined] 20 | **_children** | [**Array<PageTreeResponse>**](PageTreeResponse.md) | Array of child pages (nested structure) | [optional] [default to undefined] 21 | **createdAt** | **string** | ISO date of creation | [optional] [default to undefined] 22 | **updatedAt** | **string** | ISO date of last update | [optional] [default to undefined] 23 | **archived** | **boolean** | Whether page is archived (hidden from normal views) | [optional] [default to undefined] 24 | **historicUrls** | **Array<string>** | Previous URLs that redirect to this page (SEO preservation) | [optional] [default to undefined] 25 | **metaType** | **string** | | [optional] [default to undefined] 26 | **titleSortified** | **string** | Sortable version of title | [optional] [default to undefined] 27 | **updatedBy** | [**User**](User.md) | | [optional] [default to undefined] 28 | **_edit** | **boolean** | Whether current user can edit this page | [optional] [default to undefined] 29 | 30 | ## Example 31 | 32 | ```typescript 33 | import { PageTreeResponse } from 'apostrophecms-client'; 34 | 35 | const instance: PageTreeResponse = { 36 | _id, 37 | orphan, 38 | visibility, 39 | type, 40 | title, 41 | slug, 42 | rank, 43 | level, 44 | path, 45 | _url, 46 | _ancestors, 47 | _children, 48 | createdAt, 49 | updatedAt, 50 | archived, 51 | historicUrls, 52 | metaType, 53 | titleSortified, 54 | updatedBy, 55 | _edit, 56 | }; 57 | ``` 58 | 59 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 60 | -------------------------------------------------------------------------------- /examples/typescript/docs/PageGet200Response.md: -------------------------------------------------------------------------------- 1 | # PageGet200Response 2 | 3 | 4 | ## Properties 5 | 6 | Name | Type | Description | Notes 7 | ------------ | ------------- | ------------- | ------------- 8 | **_id** | **string** | Unique document identifier | [optional] [default to undefined] 9 | **orphan** | **boolean** | Whether page is excluded from navigation menus | [optional] [default to undefined] 10 | **visibility** | **string** | Page visibility setting - controls who can view this page | [optional] [default to undefined] 11 | **type** | **string** | Page type identifier (configured in your project) | [optional] [default to undefined] 12 | **title** | **string** | Page title - used for navigation and SEO | [optional] [default to undefined] 13 | **slug** | **string** | URL slug for the page | [optional] [default to undefined] 14 | **rank** | **number** | Order among sibling pages (for navigation sorting) | [optional] [default to undefined] 15 | **level** | **number** | Page tree depth level (0 = home page) | [optional] [default to undefined] 16 | **path** | **string** | Ancestor path of page IDs | [optional] [default to undefined] 17 | **_url** | **string** | Complete page URL - use this for links | [optional] [default to undefined] 18 | **_ancestors** | [**Array<PageSummary>**](PageSummary.md) | Array of ancestor pages (for breadcrumbs) | [optional] [default to undefined] 19 | **_children** | [**Array<PageTreeResponse>**](PageTreeResponse.md) | Array of child pages (nested structure) | [optional] [default to undefined] 20 | **createdAt** | **string** | ISO date of creation | [optional] [default to undefined] 21 | **updatedAt** | **string** | ISO date of last update | [optional] [default to undefined] 22 | **archived** | **boolean** | Whether page is archived (hidden from normal views) | [optional] [default to undefined] 23 | **historicUrls** | **Array<string>** | Previous URLs that redirect to this page (SEO preservation) | [optional] [default to undefined] 24 | **metaType** | **string** | | [optional] [default to undefined] 25 | **titleSortified** | **string** | Sortable version of title | [optional] [default to undefined] 26 | **updatedBy** | [**User**](User.md) | | [optional] [default to undefined] 27 | **_edit** | **boolean** | Whether current user can edit this page | [optional] [default to undefined] 28 | **results** | [**Array<FlatPageResponseResultsInner>**](FlatPageResponseResultsInner.md) | | [optional] [default to undefined] 29 | 30 | ## Example 31 | 32 | ```typescript 33 | import { PageGet200Response } from 'apostrophecms-client'; 34 | 35 | const instance: PageGet200Response = { 36 | _id, 37 | orphan, 38 | visibility, 39 | type, 40 | title, 41 | slug, 42 | rank, 43 | level, 44 | path, 45 | _url, 46 | _ancestors, 47 | _children, 48 | createdAt, 49 | updatedAt, 50 | archived, 51 | historicUrls, 52 | metaType, 53 | titleSortified, 54 | updatedBy, 55 | _edit, 56 | results, 57 | }; 58 | ``` 59 | 60 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 61 | -------------------------------------------------------------------------------- /examples/typescript/docs/Page.md: -------------------------------------------------------------------------------- 1 | # Page 2 | 3 | An ApostropheCMS page document with hierarchical structure and content areas 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | **_id** | **string** | Unique document identifier, may include mode and locale (e.g., \"id:en:published\") | [default to undefined] 10 | **aposDocId** | **string** | Base document ID without mode/locale qualifiers | [default to undefined] 11 | **aposLocale** | **string** | Document locale code | [optional] [default to undefined] 12 | **aposMode** | **string** | Document mode (draft or published) | [optional] [default to undefined] 13 | **archived** | **boolean** | Whether the page is archived | [optional] [default to false] 14 | **createdAt** | **string** | Page creation timestamp | [optional] [default to undefined] 15 | **updatedAt** | **string** | Page last update timestamp | [optional] [default to undefined] 16 | **titleSortified** | **string** | Sortable version of the page title | [optional] [default to undefined] 17 | **slug** | **string** | URL slug for the page | [default to undefined] 18 | **path** | **string** | Full hierarchical path in the page tree | [default to undefined] 19 | **rank** | **number** | Sort order within parent page | [optional] [default to undefined] 20 | **level** | **number** | Depth level in the page tree (0 = root level) | [default to undefined] 21 | **orphan** | **boolean** | Whether page is orphaned (not in tree structure) | [optional] [default to false] 22 | **parked** | **Array<string>** | Array of parking lot configurations if page is parked | [optional] [default to undefined] 23 | **visibility** | **string** | Page visibility setting | [optional] [default to VisibilityEnum_Public] 24 | **type** | **string** | Page type module name | [default to undefined] 25 | **title** | **string** | Page title | [default to undefined] 26 | **main** | [**PageMain**](PageMain.md) | | [optional] [default to undefined] 27 | **seoFields** | [**PageSeoFields**](PageSeoFields.md) | | [optional] [default to undefined] 28 | **_ancestors** | **Array<string>** | Array of ancestor page IDs in the page tree hierarchy | [optional] [default to undefined] 29 | **_children** | [**Array<Page>**](Page.md) | Array of child pages (when requested with children parameter) | [optional] [default to undefined] 30 | **_url** | **string** | Full URL to the page | [optional] [default to undefined] 31 | **_edit** | **boolean** | Whether current user can edit this page | [optional] [default to undefined] 32 | **_publish** | **boolean** | Whether current user can publish this page | [optional] [default to undefined] 33 | **_publishedDoc** | [**Page**](Page.md) | Published version of the page (when viewing drafts) | [optional] [default to undefined] 34 | **_draftDoc** | [**Page**](Page.md) | Draft version of the page (when viewing published) | [optional] [default to undefined] 35 | 36 | ## Example 37 | 38 | ```typescript 39 | import { Page } from 'apostrophecms-client'; 40 | 41 | const instance: Page = { 42 | _id, 43 | aposDocId, 44 | aposLocale, 45 | aposMode, 46 | archived, 47 | createdAt, 48 | updatedAt, 49 | titleSortified, 50 | slug, 51 | path, 52 | rank, 53 | level, 54 | orphan, 55 | parked, 56 | visibility, 57 | type, 58 | title, 59 | main, 60 | seoFields, 61 | _ancestors, 62 | _children, 63 | _url, 64 | _edit, 65 | _publish, 66 | _publishedDoc, 67 | _draftDoc, 68 | }; 69 | ``` 70 | 71 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 72 | --------------------------------------------------------------------------------