@markupai/api 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +40 -0
- package/Client.js +32 -0
- package/LICENSE +201 -0
- package/README.md +165 -0
- package/api/errors/ContentTooLargeError.d.ts +8 -0
- package/api/errors/ContentTooLargeError.js +52 -0
- package/api/errors/ForbiddenError.d.ts +9 -0
- package/api/errors/ForbiddenError.js +52 -0
- package/api/errors/InternalServerError.d.ts +9 -0
- package/api/errors/InternalServerError.js +52 -0
- package/api/errors/NotFoundError.d.ts +9 -0
- package/api/errors/NotFoundError.js +52 -0
- package/api/errors/UnprocessableEntityError.d.ts +8 -0
- package/api/errors/UnprocessableEntityError.js +52 -0
- package/api/errors/index.d.ts +5 -0
- package/api/errors/index.js +21 -0
- package/api/index.d.ts +3 -0
- package/api/index.js +19 -0
- package/api/resources/index.d.ts +8 -0
- package/api/resources/index.js +47 -0
- package/api/resources/styleChecks/client/Client.d.ts +70 -0
- package/api/resources/styleChecks/client/Client.js +215 -0
- package/api/resources/styleChecks/client/index.d.ts +1 -0
- package/api/resources/styleChecks/client/index.js +17 -0
- package/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts +22 -0
- package/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.js +5 -0
- package/api/resources/styleChecks/client/requests/index.d.ts +1 -0
- package/api/resources/styleChecks/client/requests/index.js +2 -0
- package/api/resources/styleChecks/index.d.ts +1 -0
- package/api/resources/styleChecks/index.js +17 -0
- package/api/resources/styleGuides/client/Client.d.ts +109 -0
- package/api/resources/styleGuides/client/Client.js +394 -0
- package/api/resources/styleGuides/client/index.d.ts +1 -0
- package/api/resources/styleGuides/client/index.js +17 -0
- package/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.d.ts +13 -0
- package/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.js +5 -0
- package/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.ts +11 -0
- package/api/resources/styleGuides/client/requests/StyleGuideRequestBody.js +5 -0
- package/api/resources/styleGuides/client/requests/index.d.ts +2 -0
- package/api/resources/styleGuides/client/requests/index.js +2 -0
- package/api/resources/styleGuides/index.d.ts +1 -0
- package/api/resources/styleGuides/index.js +17 -0
- package/api/resources/styleRewrites/client/Client.d.ts +70 -0
- package/api/resources/styleRewrites/client/Client.js +215 -0
- package/api/resources/styleRewrites/client/index.d.ts +1 -0
- package/api/resources/styleRewrites/client/index.js +17 -0
- package/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts +22 -0
- package/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.js +5 -0
- package/api/resources/styleRewrites/client/requests/index.d.ts +1 -0
- package/api/resources/styleRewrites/client/requests/index.js +2 -0
- package/api/resources/styleRewrites/index.d.ts +1 -0
- package/api/resources/styleRewrites/index.js +17 -0
- package/api/resources/styleSuggestions/client/Client.d.ts +70 -0
- package/api/resources/styleSuggestions/client/Client.js +215 -0
- package/api/resources/styleSuggestions/client/index.d.ts +1 -0
- package/api/resources/styleSuggestions/client/index.js +17 -0
- package/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.d.ts +22 -0
- package/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.js +5 -0
- package/api/resources/styleSuggestions/client/requests/index.d.ts +1 -0
- package/api/resources/styleSuggestions/client/requests/index.js +2 -0
- package/api/resources/styleSuggestions/index.d.ts +1 -0
- package/api/resources/styleSuggestions/index.js +17 -0
- package/api/types/CheckOptions.d.ts +9 -0
- package/api/types/CheckOptions.js +5 -0
- package/api/types/ClarityScore.d.ts +14 -0
- package/api/types/ClarityScore.js +5 -0
- package/api/types/Dialects.d.ts +9 -0
- package/api/types/Dialects.js +11 -0
- package/api/types/ErrorResponse.d.ts +11 -0
- package/api/types/ErrorResponse.js +5 -0
- package/api/types/GrammarCategory.d.ts +13 -0
- package/api/types/GrammarCategory.js +15 -0
- package/api/types/GrammarScore.d.ts +7 -0
- package/api/types/GrammarScore.js +5 -0
- package/api/types/Issue.d.ts +13 -0
- package/api/types/Issue.js +5 -0
- package/api/types/IssueCategory.d.ts +13 -0
- package/api/types/IssueCategory.js +15 -0
- package/api/types/QualityScore.d.ts +6 -0
- package/api/types/QualityScore.js +5 -0
- package/api/types/RewriteResponse.d.ts +15 -0
- package/api/types/RewriteResponse.js +5 -0
- package/api/types/ScoreOutput.d.ts +12 -0
- package/api/types/ScoreOutput.js +5 -0
- package/api/types/SentenceLengthCategory.d.ts +13 -0
- package/api/types/SentenceLengthCategory.js +15 -0
- package/api/types/SentenceStructureCategory.d.ts +14 -0
- package/api/types/SentenceStructureCategory.js +16 -0
- package/api/types/SimpleVocabCategory.d.ts +8 -0
- package/api/types/SimpleVocabCategory.js +10 -0
- package/api/types/StyleCheckResponse.d.ts +13 -0
- package/api/types/StyleCheckResponse.js +5 -0
- package/api/types/StyleGuide.d.ts +10 -0
- package/api/types/StyleGuide.js +5 -0
- package/api/types/StyleGuideCategory.d.ts +15 -0
- package/api/types/StyleGuideCategory.js +17 -0
- package/api/types/StyleGuideResponse.d.ts +19 -0
- package/api/types/StyleGuideResponse.js +5 -0
- package/api/types/StyleGuideScore.d.ts +7 -0
- package/api/types/StyleGuideScore.js +5 -0
- package/api/types/StyleGuideStatus.d.ts +10 -0
- package/api/types/StyleGuideStatus.js +12 -0
- package/api/types/StyleGuides.d.ts +11 -0
- package/api/types/StyleGuides.js +13 -0
- package/api/types/Subcategory.d.ts +8 -0
- package/api/types/Subcategory.js +5 -0
- package/api/types/Suggestion.d.ts +14 -0
- package/api/types/Suggestion.js +5 -0
- package/api/types/SuggestionResponse.d.ts +13 -0
- package/api/types/SuggestionResponse.js +5 -0
- package/api/types/TermReplaceCategory.d.ts +8 -0
- package/api/types/TermReplaceCategory.js +10 -0
- package/api/types/TerminologyScore.d.ts +7 -0
- package/api/types/TerminologyScore.js +5 -0
- package/api/types/ToneCategory.d.ts +12 -0
- package/api/types/ToneCategory.js +14 -0
- package/api/types/ToneScore.d.ts +12 -0
- package/api/types/ToneScore.js +5 -0
- package/api/types/Tones.d.ts +12 -0
- package/api/types/Tones.js +14 -0
- package/api/types/WebhookResponse.d.ts +7 -0
- package/api/types/WebhookResponse.js +5 -0
- package/api/types/WorkflowResponse.d.ts +8 -0
- package/api/types/WorkflowResponse.js +5 -0
- package/api/types/WorkflowStatus.d.ts +10 -0
- package/api/types/WorkflowStatus.js +12 -0
- package/api/types/index.d.ts +32 -0
- package/api/types/index.js +48 -0
- package/core/auth/BasicAuth.d.ts +8 -0
- package/core/auth/BasicAuth.js +26 -0
- package/core/auth/BearerToken.d.ts +5 -0
- package/core/auth/BearerToken.js +15 -0
- package/core/auth/index.d.ts +2 -0
- package/core/auth/index.js +7 -0
- package/core/fetcher/APIResponse.d.ts +20 -0
- package/core/fetcher/APIResponse.js +2 -0
- package/core/fetcher/Fetcher.d.ts +39 -0
- package/core/fetcher/Fetcher.js +107 -0
- package/core/fetcher/Headers.d.ts +2 -0
- package/core/fetcher/Headers.js +84 -0
- package/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/core/fetcher/HttpResponsePromise.js +103 -0
- package/core/fetcher/RawResponse.d.ts +29 -0
- package/core/fetcher/RawResponse.js +44 -0
- package/core/fetcher/Supplier.d.ts +4 -0
- package/core/fetcher/Supplier.js +22 -0
- package/core/fetcher/createRequestUrl.d.ts +1 -0
- package/core/fetcher/createRequestUrl.js +12 -0
- package/core/fetcher/getFetchFn.d.ts +4 -0
- package/core/fetcher/getFetchFn.js +68 -0
- package/core/fetcher/getHeader.d.ts +1 -0
- package/core/fetcher/getHeader.js +11 -0
- package/core/fetcher/getRequestBody.d.ts +7 -0
- package/core/fetcher/getRequestBody.js +23 -0
- package/core/fetcher/getResponseBody.d.ts +1 -0
- package/core/fetcher/getResponseBody.js +54 -0
- package/core/fetcher/index.d.ts +8 -0
- package/core/fetcher/index.js +15 -0
- package/core/fetcher/makeRequest.d.ts +1 -0
- package/core/fetcher/makeRequest.js +42 -0
- package/core/fetcher/requestWithRetries.d.ts +1 -0
- package/core/fetcher/requestWithRetries.js +40 -0
- package/core/fetcher/signals.d.ts +11 -0
- package/core/fetcher/signals.js +36 -0
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
- package/core/form-data-utils/FormDataWrapper.d.ts +63 -0
- package/core/form-data-utils/FormDataWrapper.js +227 -0
- package/core/form-data-utils/encodeAsFormParameter.d.ts +4 -0
- package/core/form-data-utils/encodeAsFormParameter.js +18 -0
- package/core/form-data-utils/index.d.ts +2 -0
- package/core/form-data-utils/index.js +20 -0
- package/core/index.d.ts +4 -0
- package/core/index.js +20 -0
- package/core/json.d.ts +15 -0
- package/core/json.js +24 -0
- package/core/runtime/index.d.ts +1 -0
- package/core/runtime/index.js +5 -0
- package/core/runtime/runtime.d.ts +9 -0
- package/core/runtime/runtime.js +103 -0
- package/dist/Client.d.ts +40 -0
- package/dist/Client.js +32 -0
- package/dist/api/errors/ContentTooLargeError.d.ts +8 -0
- package/dist/api/errors/ContentTooLargeError.js +52 -0
- package/dist/api/errors/ForbiddenError.d.ts +9 -0
- package/dist/api/errors/ForbiddenError.js +52 -0
- package/dist/api/errors/InternalServerError.d.ts +9 -0
- package/dist/api/errors/InternalServerError.js +52 -0
- package/dist/api/errors/NotFoundError.d.ts +9 -0
- package/dist/api/errors/NotFoundError.js +52 -0
- package/dist/api/errors/UnprocessableEntityError.d.ts +8 -0
- package/dist/api/errors/UnprocessableEntityError.js +52 -0
- package/dist/api/errors/index.d.ts +5 -0
- package/dist/api/errors/index.js +21 -0
- package/dist/api/index.d.ts +3 -0
- package/dist/api/index.js +19 -0
- package/dist/api/resources/index.d.ts +8 -0
- package/dist/api/resources/index.js +47 -0
- package/dist/api/resources/styleChecks/client/Client.d.ts +70 -0
- package/dist/api/resources/styleChecks/client/Client.js +215 -0
- package/dist/api/resources/styleChecks/client/index.d.ts +1 -0
- package/dist/api/resources/styleChecks/client/index.js +17 -0
- package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.d.ts +22 -0
- package/dist/api/resources/styleChecks/client/requests/StyleChecksCreateStyleCheckRequest.js +5 -0
- package/dist/api/resources/styleChecks/client/requests/index.d.ts +1 -0
- package/dist/api/resources/styleChecks/client/requests/index.js +2 -0
- package/dist/api/resources/styleChecks/index.d.ts +1 -0
- package/dist/api/resources/styleChecks/index.js +17 -0
- package/dist/api/resources/styleGuides/client/Client.d.ts +109 -0
- package/dist/api/resources/styleGuides/client/Client.js +394 -0
- package/dist/api/resources/styleGuides/client/index.d.ts +1 -0
- package/dist/api/resources/styleGuides/client/index.js +17 -0
- package/dist/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.d.ts +13 -0
- package/dist/api/resources/styleGuides/client/requests/BodyStyleGuidesUpdateStyleGuide.js +5 -0
- package/dist/api/resources/styleGuides/client/requests/StyleGuideRequestBody.d.ts +11 -0
- package/dist/api/resources/styleGuides/client/requests/StyleGuideRequestBody.js +5 -0
- package/dist/api/resources/styleGuides/client/requests/index.d.ts +2 -0
- package/dist/api/resources/styleGuides/client/requests/index.js +2 -0
- package/dist/api/resources/styleGuides/index.d.ts +1 -0
- package/dist/api/resources/styleGuides/index.js +17 -0
- package/dist/api/resources/styleRewrites/client/Client.d.ts +70 -0
- package/dist/api/resources/styleRewrites/client/Client.js +215 -0
- package/dist/api/resources/styleRewrites/client/index.d.ts +1 -0
- package/dist/api/resources/styleRewrites/client/index.js +17 -0
- package/dist/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts +22 -0
- package/dist/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.js +5 -0
- package/dist/api/resources/styleRewrites/client/requests/index.d.ts +1 -0
- package/dist/api/resources/styleRewrites/client/requests/index.js +2 -0
- package/dist/api/resources/styleRewrites/index.d.ts +1 -0
- package/dist/api/resources/styleRewrites/index.js +17 -0
- package/dist/api/resources/styleSuggestions/client/Client.d.ts +70 -0
- package/dist/api/resources/styleSuggestions/client/Client.js +215 -0
- package/dist/api/resources/styleSuggestions/client/index.d.ts +1 -0
- package/dist/api/resources/styleSuggestions/client/index.js +17 -0
- package/dist/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.d.ts +22 -0
- package/dist/api/resources/styleSuggestions/client/requests/StyleSuggestionsCreateStyleSuggestionRequest.js +5 -0
- package/dist/api/resources/styleSuggestions/client/requests/index.d.ts +1 -0
- package/dist/api/resources/styleSuggestions/client/requests/index.js +2 -0
- package/dist/api/resources/styleSuggestions/index.d.ts +1 -0
- package/dist/api/resources/styleSuggestions/index.js +17 -0
- package/dist/api/types/CheckOptions.d.ts +9 -0
- package/dist/api/types/CheckOptions.js +5 -0
- package/dist/api/types/ClarityScore.d.ts +14 -0
- package/dist/api/types/ClarityScore.js +5 -0
- package/dist/api/types/Dialects.d.ts +9 -0
- package/dist/api/types/Dialects.js +11 -0
- package/dist/api/types/ErrorResponse.d.ts +11 -0
- package/dist/api/types/ErrorResponse.js +5 -0
- package/dist/api/types/GrammarCategory.d.ts +13 -0
- package/dist/api/types/GrammarCategory.js +15 -0
- package/dist/api/types/GrammarScore.d.ts +7 -0
- package/dist/api/types/GrammarScore.js +5 -0
- package/dist/api/types/Issue.d.ts +13 -0
- package/dist/api/types/Issue.js +5 -0
- package/dist/api/types/IssueCategory.d.ts +13 -0
- package/dist/api/types/IssueCategory.js +15 -0
- package/dist/api/types/QualityScore.d.ts +6 -0
- package/dist/api/types/QualityScore.js +5 -0
- package/dist/api/types/RewriteResponse.d.ts +15 -0
- package/dist/api/types/RewriteResponse.js +5 -0
- package/dist/api/types/ScoreOutput.d.ts +12 -0
- package/dist/api/types/ScoreOutput.js +5 -0
- package/dist/api/types/SentenceLengthCategory.d.ts +13 -0
- package/dist/api/types/SentenceLengthCategory.js +15 -0
- package/dist/api/types/SentenceStructureCategory.d.ts +14 -0
- package/dist/api/types/SentenceStructureCategory.js +16 -0
- package/dist/api/types/SimpleVocabCategory.d.ts +8 -0
- package/dist/api/types/SimpleVocabCategory.js +10 -0
- package/dist/api/types/StyleCheckResponse.d.ts +13 -0
- package/dist/api/types/StyleCheckResponse.js +5 -0
- package/dist/api/types/StyleGuide.d.ts +10 -0
- package/dist/api/types/StyleGuide.js +5 -0
- package/dist/api/types/StyleGuideCategory.d.ts +15 -0
- package/dist/api/types/StyleGuideCategory.js +17 -0
- package/dist/api/types/StyleGuideResponse.d.ts +19 -0
- package/dist/api/types/StyleGuideResponse.js +5 -0
- package/dist/api/types/StyleGuideScore.d.ts +7 -0
- package/dist/api/types/StyleGuideScore.js +5 -0
- package/dist/api/types/StyleGuideStatus.d.ts +10 -0
- package/dist/api/types/StyleGuideStatus.js +12 -0
- package/dist/api/types/StyleGuides.d.ts +11 -0
- package/dist/api/types/StyleGuides.js +13 -0
- package/dist/api/types/Subcategory.d.ts +8 -0
- package/dist/api/types/Subcategory.js +5 -0
- package/dist/api/types/Suggestion.d.ts +14 -0
- package/dist/api/types/Suggestion.js +5 -0
- package/dist/api/types/SuggestionResponse.d.ts +13 -0
- package/dist/api/types/SuggestionResponse.js +5 -0
- package/dist/api/types/TermReplaceCategory.d.ts +8 -0
- package/dist/api/types/TermReplaceCategory.js +10 -0
- package/dist/api/types/TerminologyScore.d.ts +7 -0
- package/dist/api/types/TerminologyScore.js +5 -0
- package/dist/api/types/ToneCategory.d.ts +12 -0
- package/dist/api/types/ToneCategory.js +14 -0
- package/dist/api/types/ToneScore.d.ts +12 -0
- package/dist/api/types/ToneScore.js +5 -0
- package/dist/api/types/Tones.d.ts +12 -0
- package/dist/api/types/Tones.js +14 -0
- package/dist/api/types/WebhookResponse.d.ts +7 -0
- package/dist/api/types/WebhookResponse.js +5 -0
- package/dist/api/types/WorkflowResponse.d.ts +8 -0
- package/dist/api/types/WorkflowResponse.js +5 -0
- package/dist/api/types/WorkflowStatus.d.ts +10 -0
- package/dist/api/types/WorkflowStatus.js +12 -0
- package/dist/api/types/index.d.ts +32 -0
- package/dist/api/types/index.js +48 -0
- package/dist/core/auth/BasicAuth.d.ts +8 -0
- package/dist/core/auth/BasicAuth.js +26 -0
- package/dist/core/auth/BearerToken.d.ts +5 -0
- package/dist/core/auth/BearerToken.js +15 -0
- package/dist/core/auth/index.d.ts +2 -0
- package/dist/core/auth/index.js +7 -0
- package/dist/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/core/fetcher/APIResponse.js +2 -0
- package/dist/core/fetcher/Fetcher.d.ts +39 -0
- package/dist/core/fetcher/Fetcher.js +107 -0
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +84 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +44 -0
- package/dist/core/fetcher/Supplier.d.ts +4 -0
- package/dist/core/fetcher/Supplier.js +22 -0
- package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/core/fetcher/createRequestUrl.js +12 -0
- package/dist/core/fetcher/getFetchFn.d.ts +4 -0
- package/dist/core/fetcher/getFetchFn.js +68 -0
- package/dist/core/fetcher/getHeader.d.ts +1 -0
- package/dist/core/fetcher/getHeader.js +11 -0
- package/dist/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/core/fetcher/getRequestBody.js +23 -0
- package/dist/core/fetcher/getResponseBody.d.ts +1 -0
- package/dist/core/fetcher/getResponseBody.js +54 -0
- package/dist/core/fetcher/index.d.ts +8 -0
- package/dist/core/fetcher/index.js +15 -0
- package/dist/core/fetcher/makeRequest.d.ts +1 -0
- package/dist/core/fetcher/makeRequest.js +42 -0
- package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/core/fetcher/requestWithRetries.js +40 -0
- package/dist/core/fetcher/signals.d.ts +11 -0
- package/dist/core/fetcher/signals.js +36 -0
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
- package/dist/core/form-data-utils/FormDataWrapper.d.ts +63 -0
- package/dist/core/form-data-utils/FormDataWrapper.js +227 -0
- package/dist/core/form-data-utils/encodeAsFormParameter.d.ts +4 -0
- package/dist/core/form-data-utils/encodeAsFormParameter.js +18 -0
- package/dist/core/form-data-utils/index.d.ts +2 -0
- package/dist/core/form-data-utils/index.js +20 -0
- package/dist/core/index.d.ts +4 -0
- package/dist/core/index.js +20 -0
- package/dist/core/json.d.ts +15 -0
- package/dist/core/json.js +24 -0
- package/dist/core/runtime/index.d.ts +1 -0
- package/dist/core/runtime/index.js +5 -0
- package/dist/core/runtime/runtime.d.ts +9 -0
- package/dist/core/runtime/runtime.js +103 -0
- package/dist/environments.d.ts +7 -0
- package/dist/environments.js +9 -0
- package/dist/errors/MarkupAIError.d.ts +15 -0
- package/dist/errors/MarkupAIError.js +30 -0
- package/dist/errors/MarkupAITimeoutError.d.ts +6 -0
- package/dist/errors/MarkupAITimeoutError.js +13 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.js +7 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +44 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +4 -0
- package/environments.d.ts +7 -0
- package/environments.js +9 -0
- package/errors/MarkupAIError.d.ts +15 -0
- package/errors/MarkupAIError.js +30 -0
- package/errors/MarkupAITimeoutError.d.ts +6 -0
- package/errors/MarkupAITimeoutError.js +13 -0
- package/errors/index.d.ts +2 -0
- package/errors/index.js +7 -0
- package/index.d.ts +4 -0
- package/index.js +44 -0
- package/jest.config.mjs +8 -0
- package/package.json +46 -0
- package/reference.md +748 -0
- package/scripts/rename-to-esm-files.js +115 -0
- package/version.d.ts +1 -0
- package/version.js +4 -0
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
39
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
40
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
41
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
42
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
43
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
44
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
45
|
+
});
|
|
46
|
+
};
|
|
47
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
48
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
49
|
+
};
|
|
50
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
51
|
+
exports.StyleRewrites = void 0;
|
|
52
|
+
const environments = __importStar(require("../../../../environments"));
|
|
53
|
+
const core = __importStar(require("../../../../core"));
|
|
54
|
+
const MarkupAI = __importStar(require("../../../index"));
|
|
55
|
+
const url_join_1 = __importDefault(require("url-join"));
|
|
56
|
+
const errors = __importStar(require("../../../../errors/index"));
|
|
57
|
+
/**
|
|
58
|
+
* Includes all information from style suggestions, plus a rewrite of the text.
|
|
59
|
+
*/
|
|
60
|
+
class StyleRewrites {
|
|
61
|
+
constructor(_options) {
|
|
62
|
+
this._options = _options;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Start a style and brand rewrite workflow. Returns a workflow ID to use for polling results.
|
|
66
|
+
*
|
|
67
|
+
* @param {File | fs.ReadStream | Blob} file_upload
|
|
68
|
+
* @param {MarkupAI.StyleRewritesCreateStyleRewriteRequest} request
|
|
69
|
+
* @param {StyleRewrites.RequestOptions} requestOptions - Request-specific configuration.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link MarkupAI.ContentTooLargeError}
|
|
72
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
73
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* await client.styleRewrites.createStyleRewrite(fs.createReadStream("/path/to/your/file"), {
|
|
77
|
+
* dialect: "american_english",
|
|
78
|
+
* tone: "academic",
|
|
79
|
+
* style_guide: "style_guide"
|
|
80
|
+
* })
|
|
81
|
+
*/
|
|
82
|
+
createStyleRewrite(file_upload, request, requestOptions) {
|
|
83
|
+
return core.HttpResponsePromise.fromPromise(this.__createStyleRewrite(file_upload, request, requestOptions));
|
|
84
|
+
}
|
|
85
|
+
__createStyleRewrite(file_upload, request, requestOptions) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
87
|
+
var _a, _b, _c;
|
|
88
|
+
const _request = yield core.newFormData();
|
|
89
|
+
yield _request.appendFile("file_upload", file_upload);
|
|
90
|
+
_request.append("dialect", request.dialect);
|
|
91
|
+
_request.append("tone", request.tone);
|
|
92
|
+
_request.append("style_guide", request.style_guide);
|
|
93
|
+
if (request.webhook_url != null) {
|
|
94
|
+
_request.append("webhook_url", request.webhook_url);
|
|
95
|
+
}
|
|
96
|
+
const _maybeEncodedRequest = yield _request.getRequest();
|
|
97
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
98
|
+
url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Production, "v1/style/rewrites"),
|
|
99
|
+
method: "POST",
|
|
100
|
+
headers: Object.assign(Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
101
|
+
requestType: "file",
|
|
102
|
+
duplex: _maybeEncodedRequest.duplex,
|
|
103
|
+
body: _maybeEncodedRequest.body,
|
|
104
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
105
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
106
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
107
|
+
});
|
|
108
|
+
if (_response.ok) {
|
|
109
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
110
|
+
}
|
|
111
|
+
if (_response.error.reason === "status-code") {
|
|
112
|
+
switch (_response.error.statusCode) {
|
|
113
|
+
case 413:
|
|
114
|
+
throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
115
|
+
case 422:
|
|
116
|
+
throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
117
|
+
case 500:
|
|
118
|
+
throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
|
|
119
|
+
default:
|
|
120
|
+
throw new errors.MarkupAIError({
|
|
121
|
+
statusCode: _response.error.statusCode,
|
|
122
|
+
body: _response.error.body,
|
|
123
|
+
rawResponse: _response.rawResponse,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
switch (_response.error.reason) {
|
|
128
|
+
case "non-json":
|
|
129
|
+
throw new errors.MarkupAIError({
|
|
130
|
+
statusCode: _response.error.statusCode,
|
|
131
|
+
body: _response.error.rawBody,
|
|
132
|
+
rawResponse: _response.rawResponse,
|
|
133
|
+
});
|
|
134
|
+
case "timeout":
|
|
135
|
+
throw new errors.MarkupAITimeoutError("Timeout exceeded when calling POST /v1/style/rewrites.");
|
|
136
|
+
case "unknown":
|
|
137
|
+
throw new errors.MarkupAIError({
|
|
138
|
+
message: _response.error.errorMessage,
|
|
139
|
+
rawResponse: _response.rawResponse,
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Retrieve the results of a rewrite workflow. Returns `running` or `complete` status.
|
|
146
|
+
*
|
|
147
|
+
* @param {string} workflowId
|
|
148
|
+
* @param {StyleRewrites.RequestOptions} requestOptions - Request-specific configuration.
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link MarkupAI.NotFoundError}
|
|
151
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
152
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
153
|
+
*
|
|
154
|
+
* @example
|
|
155
|
+
* await client.styleRewrites.getStyleRewrite("workflow_id")
|
|
156
|
+
*/
|
|
157
|
+
getStyleRewrite(workflowId, requestOptions) {
|
|
158
|
+
return core.HttpResponsePromise.fromPromise(this.__getStyleRewrite(workflowId, requestOptions));
|
|
159
|
+
}
|
|
160
|
+
__getStyleRewrite(workflowId, requestOptions) {
|
|
161
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
162
|
+
var _a, _b, _c;
|
|
163
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
164
|
+
url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Production, `v1/style/rewrites/${encodeURIComponent(workflowId)}`),
|
|
165
|
+
method: "GET",
|
|
166
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
167
|
+
contentType: "application/json",
|
|
168
|
+
requestType: "json",
|
|
169
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
170
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
171
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
172
|
+
});
|
|
173
|
+
if (_response.ok) {
|
|
174
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
175
|
+
}
|
|
176
|
+
if (_response.error.reason === "status-code") {
|
|
177
|
+
switch (_response.error.statusCode) {
|
|
178
|
+
case 404:
|
|
179
|
+
throw new MarkupAI.NotFoundError(_response.error.body, _response.rawResponse);
|
|
180
|
+
case 422:
|
|
181
|
+
throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
182
|
+
case 500:
|
|
183
|
+
throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
|
|
184
|
+
default:
|
|
185
|
+
throw new errors.MarkupAIError({
|
|
186
|
+
statusCode: _response.error.statusCode,
|
|
187
|
+
body: _response.error.body,
|
|
188
|
+
rawResponse: _response.rawResponse,
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
switch (_response.error.reason) {
|
|
193
|
+
case "non-json":
|
|
194
|
+
throw new errors.MarkupAIError({
|
|
195
|
+
statusCode: _response.error.statusCode,
|
|
196
|
+
body: _response.error.rawBody,
|
|
197
|
+
rawResponse: _response.rawResponse,
|
|
198
|
+
});
|
|
199
|
+
case "timeout":
|
|
200
|
+
throw new errors.MarkupAITimeoutError("Timeout exceeded when calling GET /v1/style/rewrites/{workflow_id}.");
|
|
201
|
+
case "unknown":
|
|
202
|
+
throw new errors.MarkupAIError({
|
|
203
|
+
message: _response.error.errorMessage,
|
|
204
|
+
rawResponse: _response.rawResponse,
|
|
205
|
+
});
|
|
206
|
+
}
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
_getAuthorizationHeader() {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
exports.StyleRewrites = StyleRewrites;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests"), exports);
|
package/dist/api/resources/styleRewrites/client/requests/StyleRewritesCreateStyleRewriteRequest.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as MarkupAI from "../../../../index";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* dialect: "american_english",
|
|
9
|
+
* tone: "academic",
|
|
10
|
+
* style_guide: "style_guide"
|
|
11
|
+
* }
|
|
12
|
+
*/
|
|
13
|
+
export interface StyleRewritesCreateStyleRewriteRequest {
|
|
14
|
+
/** The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects. */
|
|
15
|
+
dialect: MarkupAI.Dialects;
|
|
16
|
+
/** The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals. */
|
|
17
|
+
tone: MarkupAI.Tones;
|
|
18
|
+
/** The style guide to follow for your content. You can use a style guide ID or choose from built-in options: `ap`, `chicago`, or `microsoft`. */
|
|
19
|
+
style_guide: string;
|
|
20
|
+
/** A URL that results will be POSTed to once the process completes. */
|
|
21
|
+
webhook_url?: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type StyleRewritesCreateStyleRewriteRequest } from "./StyleRewritesCreateStyleRewriteRequest";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client"), exports);
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as environments from "../../../../environments";
|
|
5
|
+
import * as core from "../../../../core";
|
|
6
|
+
import * as MarkupAI from "../../../index";
|
|
7
|
+
import * as fs from "fs";
|
|
8
|
+
import { Blob } from "buffer";
|
|
9
|
+
export declare namespace StyleSuggestions {
|
|
10
|
+
interface Options {
|
|
11
|
+
environment?: core.Supplier<environments.MarkupAIEnvironment | string>;
|
|
12
|
+
/** Specify a custom URL to connect the client to. */
|
|
13
|
+
baseUrl?: core.Supplier<string>;
|
|
14
|
+
token: core.Supplier<core.BearerToken>;
|
|
15
|
+
fetcher?: core.FetchFunction;
|
|
16
|
+
}
|
|
17
|
+
interface RequestOptions {
|
|
18
|
+
/** The maximum time to wait for a response in seconds. */
|
|
19
|
+
timeoutInSeconds?: number;
|
|
20
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
21
|
+
maxRetries?: number;
|
|
22
|
+
/** A hook to abort the request. */
|
|
23
|
+
abortSignal?: AbortSignal;
|
|
24
|
+
/** Additional headers to include in the request. */
|
|
25
|
+
headers?: Record<string, string>;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Get detailed results from style checks, including flagged issues and suggestions for how to fix them. Perfect for polishing content and staying on-brand.
|
|
30
|
+
*/
|
|
31
|
+
export declare class StyleSuggestions {
|
|
32
|
+
protected readonly _options: StyleSuggestions.Options;
|
|
33
|
+
constructor(_options: StyleSuggestions.Options);
|
|
34
|
+
/**
|
|
35
|
+
* Start a style and brand suggestion workflow. Returns a workflow ID to use for polling results.
|
|
36
|
+
*
|
|
37
|
+
* @param {File | fs.ReadStream | Blob} file_upload
|
|
38
|
+
* @param {MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest} request
|
|
39
|
+
* @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link MarkupAI.ContentTooLargeError}
|
|
42
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
43
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
|
|
47
|
+
* dialect: "american_english",
|
|
48
|
+
* tone: "academic",
|
|
49
|
+
* style_guide: "style_guide"
|
|
50
|
+
* })
|
|
51
|
+
*/
|
|
52
|
+
createStyleSuggestion(file_upload: File | fs.ReadStream | Blob, request: MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.WorkflowResponse>;
|
|
53
|
+
private __createStyleSuggestion;
|
|
54
|
+
/**
|
|
55
|
+
* Retrieve the results of a style and brand suggestion workflow. Returns `running` or `complete` status.
|
|
56
|
+
*
|
|
57
|
+
* @param {string} workflowId
|
|
58
|
+
* @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link MarkupAI.NotFoundError}
|
|
61
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
62
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* await client.styleSuggestions.getStyleSuggestion("workflow_id")
|
|
66
|
+
*/
|
|
67
|
+
getStyleSuggestion(workflowId: string, requestOptions?: StyleSuggestions.RequestOptions): core.HttpResponsePromise<MarkupAI.SuggestionResponse>;
|
|
68
|
+
private __getStyleSuggestion;
|
|
69
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
70
|
+
}
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
39
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
40
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
41
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
42
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
43
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
44
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
45
|
+
});
|
|
46
|
+
};
|
|
47
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
48
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
49
|
+
};
|
|
50
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
51
|
+
exports.StyleSuggestions = void 0;
|
|
52
|
+
const environments = __importStar(require("../../../../environments"));
|
|
53
|
+
const core = __importStar(require("../../../../core"));
|
|
54
|
+
const MarkupAI = __importStar(require("../../../index"));
|
|
55
|
+
const url_join_1 = __importDefault(require("url-join"));
|
|
56
|
+
const errors = __importStar(require("../../../../errors/index"));
|
|
57
|
+
/**
|
|
58
|
+
* Get detailed results from style checks, including flagged issues and suggestions for how to fix them. Perfect for polishing content and staying on-brand.
|
|
59
|
+
*/
|
|
60
|
+
class StyleSuggestions {
|
|
61
|
+
constructor(_options) {
|
|
62
|
+
this._options = _options;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Start a style and brand suggestion workflow. Returns a workflow ID to use for polling results.
|
|
66
|
+
*
|
|
67
|
+
* @param {File | fs.ReadStream | Blob} file_upload
|
|
68
|
+
* @param {MarkupAI.StyleSuggestionsCreateStyleSuggestionRequest} request
|
|
69
|
+
* @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link MarkupAI.ContentTooLargeError}
|
|
72
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
73
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* await client.styleSuggestions.createStyleSuggestion(fs.createReadStream("/path/to/your/file"), {
|
|
77
|
+
* dialect: "american_english",
|
|
78
|
+
* tone: "academic",
|
|
79
|
+
* style_guide: "style_guide"
|
|
80
|
+
* })
|
|
81
|
+
*/
|
|
82
|
+
createStyleSuggestion(file_upload, request, requestOptions) {
|
|
83
|
+
return core.HttpResponsePromise.fromPromise(this.__createStyleSuggestion(file_upload, request, requestOptions));
|
|
84
|
+
}
|
|
85
|
+
__createStyleSuggestion(file_upload, request, requestOptions) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
87
|
+
var _a, _b, _c;
|
|
88
|
+
const _request = yield core.newFormData();
|
|
89
|
+
yield _request.appendFile("file_upload", file_upload);
|
|
90
|
+
_request.append("dialect", request.dialect);
|
|
91
|
+
_request.append("tone", request.tone);
|
|
92
|
+
_request.append("style_guide", request.style_guide);
|
|
93
|
+
if (request.webhook_url != null) {
|
|
94
|
+
_request.append("webhook_url", request.webhook_url);
|
|
95
|
+
}
|
|
96
|
+
const _maybeEncodedRequest = yield _request.getRequest();
|
|
97
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
98
|
+
url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Production, "v1/style/suggestions"),
|
|
99
|
+
method: "POST",
|
|
100
|
+
headers: Object.assign(Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
101
|
+
requestType: "file",
|
|
102
|
+
duplex: _maybeEncodedRequest.duplex,
|
|
103
|
+
body: _maybeEncodedRequest.body,
|
|
104
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
105
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
106
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
107
|
+
});
|
|
108
|
+
if (_response.ok) {
|
|
109
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
110
|
+
}
|
|
111
|
+
if (_response.error.reason === "status-code") {
|
|
112
|
+
switch (_response.error.statusCode) {
|
|
113
|
+
case 413:
|
|
114
|
+
throw new MarkupAI.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
115
|
+
case 422:
|
|
116
|
+
throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
117
|
+
case 500:
|
|
118
|
+
throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
|
|
119
|
+
default:
|
|
120
|
+
throw new errors.MarkupAIError({
|
|
121
|
+
statusCode: _response.error.statusCode,
|
|
122
|
+
body: _response.error.body,
|
|
123
|
+
rawResponse: _response.rawResponse,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
switch (_response.error.reason) {
|
|
128
|
+
case "non-json":
|
|
129
|
+
throw new errors.MarkupAIError({
|
|
130
|
+
statusCode: _response.error.statusCode,
|
|
131
|
+
body: _response.error.rawBody,
|
|
132
|
+
rawResponse: _response.rawResponse,
|
|
133
|
+
});
|
|
134
|
+
case "timeout":
|
|
135
|
+
throw new errors.MarkupAITimeoutError("Timeout exceeded when calling POST /v1/style/suggestions.");
|
|
136
|
+
case "unknown":
|
|
137
|
+
throw new errors.MarkupAIError({
|
|
138
|
+
message: _response.error.errorMessage,
|
|
139
|
+
rawResponse: _response.rawResponse,
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Retrieve the results of a style and brand suggestion workflow. Returns `running` or `complete` status.
|
|
146
|
+
*
|
|
147
|
+
* @param {string} workflowId
|
|
148
|
+
* @param {StyleSuggestions.RequestOptions} requestOptions - Request-specific configuration.
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link MarkupAI.NotFoundError}
|
|
151
|
+
* @throws {@link MarkupAI.UnprocessableEntityError}
|
|
152
|
+
* @throws {@link MarkupAI.InternalServerError}
|
|
153
|
+
*
|
|
154
|
+
* @example
|
|
155
|
+
* await client.styleSuggestions.getStyleSuggestion("workflow_id")
|
|
156
|
+
*/
|
|
157
|
+
getStyleSuggestion(workflowId, requestOptions) {
|
|
158
|
+
return core.HttpResponsePromise.fromPromise(this.__getStyleSuggestion(workflowId, requestOptions));
|
|
159
|
+
}
|
|
160
|
+
__getStyleSuggestion(workflowId, requestOptions) {
|
|
161
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
162
|
+
var _a, _b, _c;
|
|
163
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
|
164
|
+
url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MarkupAIEnvironment.Production, `v1/style/suggestions/${encodeURIComponent(workflowId)}`),
|
|
165
|
+
method: "GET",
|
|
166
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@markupai/api", "X-Fern-SDK-Version": "0.0.6", "User-Agent": "@markupai/api/0.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
167
|
+
contentType: "application/json",
|
|
168
|
+
requestType: "json",
|
|
169
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
170
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
171
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
172
|
+
});
|
|
173
|
+
if (_response.ok) {
|
|
174
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
175
|
+
}
|
|
176
|
+
if (_response.error.reason === "status-code") {
|
|
177
|
+
switch (_response.error.statusCode) {
|
|
178
|
+
case 404:
|
|
179
|
+
throw new MarkupAI.NotFoundError(_response.error.body, _response.rawResponse);
|
|
180
|
+
case 422:
|
|
181
|
+
throw new MarkupAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
182
|
+
case 500:
|
|
183
|
+
throw new MarkupAI.InternalServerError(_response.error.body, _response.rawResponse);
|
|
184
|
+
default:
|
|
185
|
+
throw new errors.MarkupAIError({
|
|
186
|
+
statusCode: _response.error.statusCode,
|
|
187
|
+
body: _response.error.body,
|
|
188
|
+
rawResponse: _response.rawResponse,
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
switch (_response.error.reason) {
|
|
193
|
+
case "non-json":
|
|
194
|
+
throw new errors.MarkupAIError({
|
|
195
|
+
statusCode: _response.error.statusCode,
|
|
196
|
+
body: _response.error.rawBody,
|
|
197
|
+
rawResponse: _response.rawResponse,
|
|
198
|
+
});
|
|
199
|
+
case "timeout":
|
|
200
|
+
throw new errors.MarkupAITimeoutError("Timeout exceeded when calling GET /v1/style/suggestions/{workflow_id}.");
|
|
201
|
+
case "unknown":
|
|
202
|
+
throw new errors.MarkupAIError({
|
|
203
|
+
message: _response.error.errorMessage,
|
|
204
|
+
rawResponse: _response.rawResponse,
|
|
205
|
+
});
|
|
206
|
+
}
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
_getAuthorizationHeader() {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
exports.StyleSuggestions = StyleSuggestions;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests"), exports);
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as MarkupAI from "../../../../index";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* dialect: "american_english",
|
|
9
|
+
* tone: "academic",
|
|
10
|
+
* style_guide: "style_guide"
|
|
11
|
+
* }
|
|
12
|
+
*/
|
|
13
|
+
export interface StyleSuggestionsCreateStyleSuggestionRequest {
|
|
14
|
+
/** The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects. */
|
|
15
|
+
dialect: MarkupAI.Dialects;
|
|
16
|
+
/** The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals. */
|
|
17
|
+
tone: MarkupAI.Tones;
|
|
18
|
+
/** The style guide to follow for your content. You can use a style guide ID or choose from built-in options: `ap`, `chicago`, or `microsoft`. */
|
|
19
|
+
style_guide: string;
|
|
20
|
+
/** A URL that results will be POSTed to once the process completes. */
|
|
21
|
+
webhook_url?: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type StyleSuggestionsCreateStyleSuggestionRequest } from "./StyleSuggestionsCreateStyleSuggestionRequest";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client";
|