diff --git a/.bin/rebuild-api.sh b/.bin/rebuild-api.sh index 799d118..6676311 100755 --- a/.bin/rebuild-api.sh +++ b/.bin/rebuild-api.sh @@ -3,7 +3,7 @@ npm run docusaurus clean-api-docs analysis && npm run docusaurus gen-api-docs analysis npm run docusaurus clean-api-docs classification && npm run docusaurus gen-api-docs classification npm run docusaurus clean-api-docs content-generation && npm run docusaurus gen-api-docs content-generation -npm run docusaurus clean-api-docs embeddings && npm run docusaurus gen-api-docs embeddings +# npm run docusaurus clean-api-docs embeddings && npm run docusaurus gen-api-docs embeddings npm run docusaurus clean-api-docs events && npm run docusaurus gen-api-docs events npm run docusaurus clean-api-docs fact-check && npm run docusaurus gen-api-docs fact-check npm run docusaurus clean-api-docs graphql && npm run docusaurus gen-api-docs graphql diff --git a/docs/api/content-generation/create-content-generation.api.mdx b/docs/api/content-generation/create-content-generation.api.mdx index 334c49e..1eac19e 100644 --- a/docs/api/content-generation/create-content-generation.api.mdx +++ b/docs/api/content-generation/create-content-generation.api.mdx @@ -30,7 +30,7 @@ Create new Created -
Schema
    = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
+
Schema
    = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
Authentication Failure diff --git a/docs/api/content-generation/create-record-validation.api.mdx b/docs/api/content-generation/create-record-validation.api.mdx index a651f35..885b44a 100644 --- a/docs/api/content-generation/create-record-validation.api.mdx +++ b/docs/api/content-generation/create-record-validation.api.mdx @@ -38,7 +38,7 @@ The set of errors found for record. The set of errors found for record. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/create-sync.api.mdx b/docs/api/content-generation/create-sync.api.mdx index 6860c56..0ae9cb1 100644 --- a/docs/api/content-generation/create-sync.api.mdx +++ b/docs/api/content-generation/create-sync.api.mdx @@ -30,7 +30,7 @@ Start Found. -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/content-generation/create-validation-sync.api.mdx b/docs/api/content-generation/create-validation-sync.api.mdx index c100a78..fe19d3c 100644 --- a/docs/api/content-generation/create-validation-sync.api.mdx +++ b/docs/api/content-generation/create-validation-sync.api.mdx @@ -30,7 +30,7 @@ Create Completion sync Found. -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/content-generation/create-word.api.mdx b/docs/api/content-generation/create-word.api.mdx index 890750c..8d2c520 100644 --- a/docs/api/content-generation/create-word.api.mdx +++ b/docs/api/content-generation/create-word.api.mdx @@ -30,7 +30,7 @@ Create a Word bias Created -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/content-generation/create-words-from-csv-1.api.mdx b/docs/api/content-generation/create-words-from-csv-1.api.mdx index 4044f65..762eb2c 100644 --- a/docs/api/content-generation/create-words-from-csv-1.api.mdx +++ b/docs/api/content-generation/create-words-from-csv-1.api.mdx @@ -34,7 +34,7 @@ string Created -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    No Content diff --git a/docs/api/content-generation/get-content-generation.api.mdx b/docs/api/content-generation/get-content-generation.api.mdx index aec7e40..374569e 100644 --- a/docs/api/content-generation/get-content-generation.api.mdx +++ b/docs/api/content-generation/get-content-generation.api.mdx @@ -30,7 +30,7 @@ Get by id Found. -
    Schema
      = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
    +
    Schema
      = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
    Authentication Failure diff --git a/docs/api/content-generation/get-record.api.mdx b/docs/api/content-generation/get-record.api.mdx index 12e7507..74d0788 100644 --- a/docs/api/content-generation/get-record.api.mdx +++ b/docs/api/content-generation/get-record.api.mdx @@ -38,7 +38,7 @@ The set of errors found for record. The set of errors found for record. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/list-content-generations.api.mdx b/docs/api/content-generation/list-content-generations.api.mdx index b09acba..480512b 100644 --- a/docs/api/content-generation/list-content-generations.api.mdx +++ b/docs/api/content-generation/list-content-generations.api.mdx @@ -34,7 +34,7 @@ Found. An array of objects. -
  • Array [
    • = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
  • ]
    • +
  • Array [
    • = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/list-records.api.mdx b/docs/api/content-generation/list-records.api.mdx index 974864c..be12f56 100644 --- a/docs/api/content-generation/list-records.api.mdx +++ b/docs/api/content-generation/list-records.api.mdx @@ -42,7 +42,7 @@ The set of errors found for record. The set of errors found for record. -
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/list-validation-syncs.api.mdx b/docs/api/content-generation/list-validation-syncs.api.mdx index e4825fd..808840d 100644 --- a/docs/api/content-generation/list-validation-syncs.api.mdx +++ b/docs/api/content-generation/list-validation-syncs.api.mdx @@ -34,7 +34,7 @@ Found. An array of objects. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/list-words.api.mdx b/docs/api/content-generation/list-words.api.mdx index fb087b5..f3a8a88 100644 --- a/docs/api/content-generation/list-words.api.mdx +++ b/docs/api/content-generation/list-words.api.mdx @@ -34,7 +34,7 @@ Found. An array of objects. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/update-content-generation.api.mdx b/docs/api/content-generation/update-content-generation.api.mdx index 6e982b8..1dbe2e6 100644 --- a/docs/api/content-generation/update-content-generation.api.mdx +++ b/docs/api/content-generation/update-content-generation.api.mdx @@ -30,7 +30,7 @@ Update Update -
    Schema
      = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
    +
    Schema
      = 0.5` and `<= 1.9`"} schema={{"type":"number","format":"double","default":0.5,"description":"The penalty score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":1.9,"minimum":0.5}}>= 0.4` and `<= 0.8`"} schema={{"type":"number","format":"double","default":0.4,"description":"The temperature score.","exclusiveMaximum":false,"exclusiveMinimum":false,"maximum":0.8,"minimum":0.4}}>
    Authentication Failure diff --git a/docs/api/content-generation/update-record.api.mdx b/docs/api/content-generation/update-record.api.mdx index 78813d9..cb86efc 100644 --- a/docs/api/content-generation/update-record.api.mdx +++ b/docs/api/content-generation/update-record.api.mdx @@ -38,7 +38,7 @@ The set of errors found for record. The set of errors found for record. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/content-generation/update-word.api.mdx b/docs/api/content-generation/update-word.api.mdx index c2cf827..f603a87 100644 --- a/docs/api/content-generation/update-word.api.mdx +++ b/docs/api/content-generation/update-word.api.mdx @@ -30,7 +30,7 @@ Update a Word bias Updated -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/events/create-event.api.mdx b/docs/api/events/create-event.api.mdx index 8b6ec84..ec55c97 100644 --- a/docs/api/events/create-event.api.mdx +++ b/docs/api/events/create-event.api.mdx @@ -30,9 +30,9 @@ Create an event Created -
    Schema
    +
    Schema
    Authentication failure -
    Schema
     +
    Schema
    \ No newline at end of file diff --git a/docs/api/events/list-events.api.mdx b/docs/api/events/list-events.api.mdx index 3d78fc7..991df08 100644 --- a/docs/api/events/list-events.api.mdx +++ b/docs/api/events/list-events.api.mdx @@ -30,9 +30,9 @@ List the events bound to the authenticated account. Found -
    Schema
      items object[]
    • Array [
    • ]
    +
    Schema
      items object[]
    • Array [
    • ]
    Authentication failure -
    Schema
      items object[]
    • Array [
    • ]
     +
    Schema
      items object[]
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/api/fact-check/submit-fact-check.api.mdx b/docs/api/fact-check/submit-fact-check.api.mdx index 8aac5c3..fb499a3 100644 --- a/docs/api/fact-check/submit-fact-check.api.mdx +++ b/docs/api/fact-check/submit-fact-check.api.mdx @@ -5,7 +5,7 @@ description: "Submit a fact-checking request" sidebar_label: "Submit a fact-checking request" hide_title: true hide_table_of_contents: true -api: {"operationId":"submitFactCheck","tags":["Fact Check"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","example":"Aristotele said 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'"}}}}}},"responses":{"200":{"description":"Fact-checking result","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","example":"{\n \"@context\": \"http://schema.org\",\n \"@type\": \"ClaimReview\",\n \"claimReviewed\": \"Aristotle quote 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'\",\n \"author\": { \"@type\": \"Organization\", \"name\": \"WordLift\" },\n \"datePublished\": \"2024-01-17\",\n \"reviewRating\": {\n \"@type\": \"Rating\",\n \"ratingValue\": \"5\",\n \"alternateName\": \"True\",\n \"bestRating\": \"5\",\n \"worstRating\": \"1\"\n },\n \"url\": \"https://fact-check.wordlift.io/review/aristotle-quote\",\n \"reviewBody\": \"The quote 'It is the mark of an educated mind to be able to entertain a thought without accepting it.' is correctly attributable to Aristotle. It has been found in multiple credible sources, including publications of academic texts, reputable quote repositories, and philosophical discussions.\",\n \"itemReviewed\": {\n \"@type\": \"CreativeWork\",\n \"url\": [\"https://www.azquotes.com/quote/10261\", \"https://philosiblog.com/2012/03/07/it-is-the-mark-of-an-educated-mind-to-be-able-to-entertain-a-thought-without-accepting-it/\", \"https://www.brainyquote.com/quotes/aristotle_100584\", \"https://www.goodreads.com/quotes/1629-it-is-the-mark-of-an-educated-mind-to-be\", \"https://www.socratic-method.com/philosophy-quote-meanings/aristotle-it-is-the-mark-of-an-educated-mind-to-be-able-to-entertain-a-thought-without-accepting-it\"]\n }\n}"}}}}}}},"description":"Submit a fact-checking request","method":"post","path":"/score","servers":[{"url":"https://api.wordlift.io/fact-check"}],"security":[{"ApiKeyAuth":[]}],"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"jsonRequestBodyExample":{"query":"Aristotele said 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'"},"info":{"title":"WordLift Fact-Checking API","version":"1.0.0","description":"API for semi-automated fact-checking. Returns schema.org/ClaimReview markup. This markup is structured data that contains information about the fact check -- for example, what was the claim being assessed, who made the claim, what was the verdict."},"postman":{"name":"Submit a fact-checking request","description":{"type":"text/plain"},"url":{"path":["score"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"submitFactCheck","tags":["Fact Check"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","example":"Aristotele said 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'"}}}}}},"responses":{"200":{"description":"Fact-checking result","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","example":"{\n \"@context\": \"http://schema.org\",\n \"@type\": \"ClaimReview\",\n \"claimReviewed\": \"Aristotle quote 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'\",\n \"author\": { \"@type\": \"Organization\", \"name\": \"WordLift\" },\n \"datePublished\": \"2024-01-17\",\n \"reviewRating\": {\n \"@type\": \"Rating\",\n \"ratingValue\": \"5\",\n \"alternateName\": \"True\",\n \"bestRating\": \"5\",\n \"worstRating\": \"1\"\n },\n \"url\": \"https://fact-check.wordlift.io/review/aristotle-quote\",\n \"reviewBody\": \"The quote 'It is the mark of an educated mind to be able to entertain a thought without accepting it.' is correctly attributable to Aristotle. It has been found in multiple credible sources, including publications of academic texts, reputable quote repositories, and philosophical discussions.\",\n \"itemReviewed\": {\n \"@type\": \"CreativeWork\",\n \"url\": [\"https://www.azquotes.com/quote/10261\", \"https://philosiblog.com/2012/03/07/it-is-the-mark-of-an-educated-mind-to-be-able-to-entertain-a-thought-without-accepting-it/\", \"https://www.brainyquote.com/quotes/aristotle_100584\", \"https://www.goodreads.com/quotes/1629-it-is-the-mark-of-an-educated-mind-to-be\", \"https://www.socratic-method.com/philosophy-quote-meanings/aristotle-it-is-the-mark-of-an-educated-mind-to-be-able-to-entertain-a-thought-without-accepting-it\"]\n }\n}"}}}}}}},"description":"Submit a fact-checking request","method":"post","path":"/fact-check/score","servers":[{"url":"https://api.wordlift.io"}],"security":[{"ApiKeyAuth":[]}],"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"jsonRequestBodyExample":{"query":"Aristotele said 'It is the mark of an educated mind to be able to entertain a thought without accepting it.'"},"info":{"title":"WordLift Fact-Checking API","version":"1.0.0","description":"API for semi-automated fact-checking. Returns schema.org/ClaimReview markup. This markup is structured data that contains information about the fact check -- for example, what was the claim being assessed, who made the claim, what was the verdict."},"postman":{"name":"Submit a fact-checking request","description":{"type":"text/plain"},"url":{"path":["fact-check","score"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/fact-check/wordlift-fact-checking-api custom_edit_url: null diff --git a/docs/api/long-tail/get.api.mdx b/docs/api/long-tail/get.api.mdx index 68477d4..1f7507d 100644 --- a/docs/api/long-tail/get.api.mdx +++ b/docs/api/long-tail/get.api.mdx @@ -30,7 +30,7 @@ Get a Web Async operation by its id. Found. -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/long-tail/list.api.mdx b/docs/api/long-tail/list.api.mdx index 31fb5f5..b6717b7 100644 --- a/docs/api/long-tail/list.api.mdx +++ b/docs/api/long-tail/list.api.mdx @@ -30,7 +30,7 @@ List all Web Async operations. Found. -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    Authentication Failure diff --git a/docs/api/manager/botify-crawl-imports.tag.mdx b/docs/api/manager/botify-crawl-imports.tag.mdx new file mode 100644 index 0000000..cf6ff20 --- /dev/null +++ b/docs/api/manager/botify-crawl-imports.tag.mdx @@ -0,0 +1,20 @@ +--- +id: botify-crawl-imports +title: "Botify Crawl Imports" +description: "Botify Crawl Imports" +custom_edit_url: null +--- + + + +Import Botify Crawl data to KG + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/manager/create-analytics-import.api.mdx b/docs/api/manager/create-analytics-import.api.mdx index e3e150c..14b06e2 100644 --- a/docs/api/manager/create-analytics-import.api.mdx +++ b/docs/api/manager/create-analytics-import.api.mdx @@ -5,7 +5,7 @@ description: "Create a Analytics Import using Google Search Console or Botify de sidebar_label: "Create" hide_title: true hide_table_of_contents: true -api: {"description":"Create a Analytics Import using Google Search Console or Botify depending on the Account configuration.","operationId":"createAnalyticsImport","responses":{"201":{"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Analytics Imports"],"method":"post","path":"/analytics-imports","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a Analytics Import using Google Search Console or Botify depending on the Account configuration.","type":"text/plain"},"url":{"path":["analytics-imports"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"Create a Analytics Import using Google Search Console or Botify depending on the Account configuration.","operationId":"createAnalyticsImport","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"An Analytics Import request.","properties":{"urls":{"type":"array","description":"An array of URLs.","items":{"type":"string","description":"An array of URLs."},"uniqueItems":true}},"title":"AnalyticsImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/x-ndjson":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Analytics Imports"],"method":"post","path":"/analytics-imports","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"urls":["string"]},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a Analytics Import using Google Search Console or Botify depending on the Account configuration.","type":"text/plain"},"url":{"path":["analytics-imports"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/x-ndjson"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/manager/manager custom_edit_url: null @@ -26,11 +26,15 @@ import TabItem from "@theme/TabItem"; Create a Analytics Import using Google Search Console or Botify depending on the Account configuration. -
    +
    Request Body required
    Success -
    +
    Schema
    • Array [
      • + +string + +
    • ]
    Authentication Failure diff --git a/docs/api/manager/create-botify-crawl-import.api.mdx b/docs/api/manager/create-botify-crawl-import.api.mdx new file mode 100644 index 0000000..ed0d022 --- /dev/null +++ b/docs/api/manager/create-botify-crawl-import.api.mdx @@ -0,0 +1,38 @@ +--- +id: create-botify-crawl-import +title: "Create" +description: "Create a Botify Crawl Import" +sidebar_label: "Create" +hide_title: true +hide_table_of_contents: true +api: {"description":"Create a Botify Crawl Import","operationId":"createBotifyCrawlImport","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Botify Crawl Import request","properties":{"collection":{"type":"string"},"description":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"object","description":"A query request filter.","properties":{"key":{"type":"string","description":"The filter key."},"operator":{"type":"string","description":"A query request filter operator.","enum":["EQ","GT","LT","NE","GTE","LTE","IN","NIN","TEXT_MATCH"]},"value":{"type":"string","description":"The filter value."}},"required":["key","operator","value"],"title":"Filter"}},"headline":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"regex":{"type":"string"},"request_embeddings":{"type":"array","items":{"type":"string"}},"text":{"type":"array","items":{"type":"string"}},"types":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}},"title":"BotifyCrawlImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"type":"array","items":{"type":"object","properties":{"abstract":{"type":"string"},"date_published":{"type":"string","format":"date"},"headline":{"type":"string"},"image":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"title":"WebPage"}}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Botify Crawl Imports"],"method":"post","path":"/botify-crawl-imports","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"collection":"string","description":["string"],"filters":[{"key":"string","operator":"EQ","value":"string"}],"headline":"string","limit":0,"offset":0,"regex":"string","request_embeddings":["string"],"text":["string"],"types":["string"],"url":"string"},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a Botify Crawl Import","type":"text/plain"},"url":{"path":["botify-crawl-imports"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/x-ndjson"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/manager/manager +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create + + + +Create a Botify Crawl Import + +
    Request Body required
      filters object[]
    • Array [
    • ]
    + +Success + +
    Schema
    • Array [
    • ]
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/create-merchant.api.mdx b/docs/api/manager/create-merchant.api.mdx index d601bf4..b21cc5e 100644 --- a/docs/api/manager/create-merchant.api.mdx +++ b/docs/api/manager/create-merchant.api.mdx @@ -30,7 +30,7 @@ Create a Merchant Success -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/create-o-auth-2-authorized-client.api.mdx b/docs/api/manager/create-o-auth-2-authorized-client.api.mdx index ed14c1e..f1956b1 100644 --- a/docs/api/manager/create-o-auth-2-authorized-client.api.mdx +++ b/docs/api/manager/create-o-auth-2-authorized-client.api.mdx @@ -5,7 +5,7 @@ description: "Create a OAuth2 Authorized Client" sidebar_label: "Create" hide_title: true hide_table_of_contents: true -api: {"description":"Create a OAuth2 Authorized Client","operationId":"createOAuth2AuthorizedClient","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The OAuth2 Authorized Client request","properties":{"access_token_expires_at":{"type":"string","format":"date-time","description":"When the Access Token expires"},"access_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"access_token_scopes":{"type":"string","description":"The Access Token scopes"},"access_token_type":{"type":"string","description":"The Access Token Type"},"access_token_value":{"type":"string","description":"The Access Token Value"},"client_registration_id":{"type":"string","description":"The Client Registration Id"},"principal_name":{"type":"string","description":"The Principal Name"},"refresh_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"refresh_token_value":{"type":"string","description":"The Refresh Token Value"}},"title":"OAuth2AuthorizedClientRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A OAuth2 Authorized Client","properties":{"access_token_expires_at":{"type":"string","format":"date-time"},"access_token_issued_at":{"type":"string","format":"date-time"},"access_token_scopes":{"type":"string"},"access_token_type":{"type":"string"},"access_token_value":{"type":"string"},"client_registration_id":{"type":"string"},"id":{"type":"integer","format":"int64"},"principal_name":{"type":"string"},"refresh_token_issued_at":{"type":"string","format":"date-time"},"refresh_token_value":{"type":"string"}},"title":"OAuth2AuthorizedClient"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"post","path":"/oauth2/authorized-clients","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"access_token_expires_at":"2024-01-17T14:56:58.826Z","access_token_issued_at":"2024-01-17T14:56:58.826Z","access_token_scopes":"string","access_token_type":"string","access_token_value":"string","client_registration_id":"string","principal_name":"string","refresh_token_issued_at":"2024-01-17T14:56:58.826Z","refresh_token_value":"string"},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a OAuth2 Authorized Client","type":"text/plain"},"url":{"path":["oauth2","authorized-clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +api: {"description":"Create a OAuth2 Authorized Client","operationId":"createOAuth2AuthorizedClient","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The OAuth2 Authorized Client request","properties":{"access_token_expires_at":{"type":"string","format":"date-time","description":"When the Access Token expires"},"access_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"access_token_scopes":{"type":"string","description":"The Access Token scopes"},"access_token_type":{"type":"string","description":"The Access Token Type"},"access_token_value":{"type":"string","description":"The Access Token Value"},"client_registration_id":{"type":"string","description":"The Client Registration Id"},"principal_name":{"type":"string","description":"The Principal Name"},"refresh_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"refresh_token_value":{"type":"string","description":"The Refresh Token Value"}},"title":"OAuth2AuthorizedClientRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A OAuth2 Authorized Client","properties":{"access_token_expires_at":{"type":"string","format":"date-time"},"access_token_issued_at":{"type":"string","format":"date-time"},"access_token_scopes":{"type":"string"},"access_token_type":{"type":"string"},"access_token_value":{"type":"string"},"client_registration_id":{"type":"string"},"id":{"type":"integer","format":"int64"},"principal_name":{"type":"string"},"refresh_token_issued_at":{"type":"string","format":"date-time"},"refresh_token_value":{"type":"string"}},"title":"OAuth2AuthorizedClient"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"post","path":"/oauth2/authorized-clients","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"access_token_expires_at":"2024-02-28T15:20:20.108Z","access_token_issued_at":"2024-02-28T15:20:20.108Z","access_token_scopes":"string","access_token_type":"string","access_token_value":"string","client_registration_id":"string","principal_name":"string","refresh_token_issued_at":"2024-02-28T15:20:20.108Z","refresh_token_value":"string"},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a OAuth2 Authorized Client","type":"text/plain"},"url":{"path":["oauth2","authorized-clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} sidebar_class_name: "post api-method" info_path: api/manager/manager custom_edit_url: null @@ -30,7 +30,7 @@ Create a OAuth2 Authorized Client Found -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/create-query.api.mdx b/docs/api/manager/create-query.api.mdx new file mode 100644 index 0000000..b7f7b67 --- /dev/null +++ b/docs/api/manager/create-query.api.mdx @@ -0,0 +1,50 @@ +--- +id: create-query +title: "Create" +description: "Create" +sidebar_label: "Create" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createQuery","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A query request.","properties":{"filters":{"type":"array","description":"A list of prefilters.","items":{"type":"object","description":"A query request filter.","properties":{"key":{"type":"string","description":"The filter key."},"operator":{"type":"string","description":"A query request filter operator.","enum":["EQ","GT","LT","NE","GTE","LTE","IN","NIN","TEXT_MATCH"]},"value":{"type":"string","description":"The filter value."}},"required":["key","operator","value"],"title":"Filter"}},"query_embedding":{"type":"array","description":"The list of embeddings.","items":{"type":"number","format":"double","description":"The list of embeddings."}},"similarity_top_k":{"type":"integer","format":"int32","description":"The similarity top K.","minimum":1}},"required":["query_embedding","similarity_top_k"],"title":"QueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}},"description":"Found."},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"ApiKey":[]}],"tags":["Vector Search Queries"],"description":"Create","method":"put","path":"/vector-search/queries","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"filters":[{"key":"string","operator":"EQ","value":"string"}],"query_embedding":[0],"similarity_top_k":0},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"type":"text/plain"},"url":{"path":["vector-search","queries"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "put api-method" +info_path: api/manager/manager +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create + + + +Create + +
    Request Body required
      filters object[]
      + +A list of prefilters. + +
    • Array [
    • ]
      • = 1`"} schema={{"type":"integer","format":"int32","description":"The similarity top K.","minimum":1}}>
    + +Found. + +
    Schema
    • Array [
      • + +object + +
    • ]
    + +Authentication Failure + +
    + +Not Found + +
    + \ No newline at end of file diff --git a/docs/api/manager/create-sitemap-import.api.mdx b/docs/api/manager/create-sitemap-import.api.mdx index 6c1b88d..cd45ed6 100644 --- a/docs/api/manager/create-sitemap-import.api.mdx +++ b/docs/api/manager/create-sitemap-import.api.mdx @@ -5,7 +5,7 @@ description: "Create a Sitemap Import" sidebar_label: "Create" hide_title: true hide_table_of_contents: true -api: {"description":"Create a Sitemap Import","operationId":"createSitemapImport","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Sitemap Import request","properties":{"sitemap_url":{"type":"string","description":"The sitemap URL"},"urls":{"type":"array","description":"The URLs","items":{"type":"string","description":"The URLs"},"uniqueItems":true}},"title":"SitemapImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"type":"array","items":{"type":"object","properties":{"abstract":{"type":"string"},"date_published":{"type":"string","format":"date"},"headline":{"type":"string"},"image":{"type":"string","format":"url"},"text":{"type":"string"},"url":{"type":"string"}},"title":"WebPage"}}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Sitemap Imports"],"method":"post","path":"/sitemap-imports","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"sitemap_url":"string","urls":["string"]},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a Sitemap Import","type":"text/plain"},"url":{"path":["sitemap-imports"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/x-ndjson"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"description":"Create a Sitemap Import","operationId":"createSitemapImport","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Sitemap Import request","properties":{"sitemap_url":{"type":"string","description":"The sitemap URL"},"urls":{"type":"array","description":"The URLs","items":{"type":"string","description":"The URLs"},"uniqueItems":true}},"title":"SitemapImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"type":"array","items":{"type":"object","properties":{"abstract":{"type":"string"},"date_published":{"type":"string","format":"date"},"headline":{"type":"string"},"image":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"title":"WebPage"}}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Sitemap Imports"],"method":"post","path":"/sitemap-imports","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"sitemap_url":"string","urls":["string"]},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Create","description":{"content":"Create a Sitemap Import","type":"text/plain"},"url":{"path":["sitemap-imports"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/x-ndjson"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/manager/manager custom_edit_url: null @@ -30,7 +30,7 @@ Create a Sitemap Import Success -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    Authentication Failure diff --git a/docs/api/manager/create-sync.api.mdx b/docs/api/manager/create-sync.api.mdx index f1ea472..7343cbf 100644 --- a/docs/api/manager/create-sync.api.mdx +++ b/docs/api/manager/create-sync.api.mdx @@ -30,7 +30,7 @@ Start Found. -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/get-account.api.mdx b/docs/api/manager/get-account.api.mdx new file mode 100644 index 0000000..fbc73a2 --- /dev/null +++ b/docs/api/manager/get-account.api.mdx @@ -0,0 +1,42 @@ +--- +id: get-account +title: "Get an account." +description: "Get the account" +sidebar_label: "Get an account." +hide_title: true +hide_table_of_contents: true +api: {"description":"Get the account","operationId":"getAccount","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"analytics_client_factory":{"type":"string"},"analyzerId":{"type":"integer","format":"int64"},"botify_project":{"type":"string"},"botify_token":{"type":"string"},"botify_username":{"type":"string"},"country":{"type":"string"},"datasetId":{"type":"string","deprecated":true},"datasetUri":{"type":"string"},"domainUri":{"type":"string"},"google_search_console_site_url":{"type":"string"},"id":{"type":"integer","format":"int64"},"indexed":{"type":"boolean"},"key":{"type":"string"},"language":{"type":"string"},"ngDatasetId":{"type":"string"},"resolvedUrl":{"type":"string"},"subscriptionId":{"type":"integer","format":"int64"},"url":{"type":"string"},"wpAdmin":{"type":"string"},"wpJson":{"type":"string"},"wp_include_exclude_default":{"type":"string"}},"title":"Account"}}},"description":"Found"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"OAuth2":[]}],"tags":["Accounts"],"method":"get","path":"/accounts/{id}","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Get an account.","description":{"content":"Get the account","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: api/manager/manager +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an account. + + + +Get the account + +
    Path Parameters
    + +Found + +
    Schema
    + +Authentication Failure + +
    + +Not Found + +
    + \ No newline at end of file diff --git a/docs/api/manager/get-merchant-sync.api.mdx b/docs/api/manager/get-merchant-sync.api.mdx index 1905974..87709c9 100644 --- a/docs/api/manager/get-merchant-sync.api.mdx +++ b/docs/api/manager/get-merchant-sync.api.mdx @@ -30,7 +30,7 @@ Get by id Found. -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/get-merchant.api.mdx b/docs/api/manager/get-merchant.api.mdx index 6345083..5dbc23c 100644 --- a/docs/api/manager/get-merchant.api.mdx +++ b/docs/api/manager/get-merchant.api.mdx @@ -30,7 +30,7 @@ Get a Merchant by its `id`. Success -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/get-o-auth-2-authorized-client.api.mdx b/docs/api/manager/get-o-auth-2-authorized-client.api.mdx index c2640f9..038ac1c 100644 --- a/docs/api/manager/get-o-auth-2-authorized-client.api.mdx +++ b/docs/api/manager/get-o-auth-2-authorized-client.api.mdx @@ -30,7 +30,7 @@ Get a OAuth2 Authorized Client given its client registration id Found -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/list-accounts.api.mdx b/docs/api/manager/list-accounts.api.mdx index 73e3aff..7fd0a18 100644 --- a/docs/api/manager/list-accounts.api.mdx +++ b/docs/api/manager/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "List the accounts" sidebar_label: "List" hide_title: true hide_table_of_contents: true -api: {"description":"List the accounts","operationId":"listAccounts","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"description":"Filter accounts that can or cannot do Content Generation","in":"query","name":"can_content_generation","required":false,"schema":{"type":"boolean"}},{"description":"Add entity count data","in":"query","name":"include_entity_count","required":false,"schema":{"type":"boolean","default":false}},{"description":"Include all the accounts the user has access to","in":"query","name":"include_all_accounts","required":false,"schema":{"type":"boolean","default":false}},{"description":"Include the subscription data","in":"query","name":"include_subscription","required":false,"schema":{"type":"boolean","default":false}},{"description":"The URL","in":"query","name":"url","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.wordlift.accounts+json;version=1":{"schema":{"type":"object","description":"A page object with links to move to other pages and the list of objects.","properties":{"first":{"type":"string","description":"The link to the first page.","nullable":true},"items":{"type":"array","description":"An array of objects.","items":{"type":"object","description":"An array of objects.","properties":{"country":{"type":"string"},"diagnostic_plugins":{"type":"array","items":{"type":"object","description":"Plugin Data used for diagnostics","properties":{"account_id":{"type":"integer","format":"int64","description":"The account id.","readOnly":true},"active":{"type":"boolean","description":"Whether the plugin is active."},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"id":{"type":"integer","format":"int64","description":"The record id.","readOnly":true},"name":{"type":"string","description":"The plugin name."},"version":{"type":"string","description":"The plugin version."}},"title":"DiagnosticPlugin"}},"domain_uri":{"type":"string"},"google_search_console_site_url":{"type":"string"},"id":{"type":"integer","format":"int64"},"is_wordpress":{"type":"boolean"},"key":{"type":"string"},"language":{"type":"string"},"ng_dataset_id":{"type":"string"},"package_type":{"type":"string"},"subscription":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"order_id":{"type":"integer","format":"int64"},"sku":{"type":"string"}},"title":"AccountSubscription"},"subscription_id":{"type":"integer","format":"int64"},"total_entities":{"type":"integer","format":"int64"},"total_entities_with_schema_url":{"type":"integer","format":"int64"},"url":{"type":"string"},"user_id":{"type":"integer","format":"int64"},"wp_admin":{"type":"string"},"wp_include_exclude_default":{"type":"string"},"wp_json":{"type":"string"}},"title":"ActiveAccount"}},"last":{"type":"string","description":"The link to the last page.","nullable":true},"next":{"type":"string","description":"The link to the next page or `null` if there's no page.","nullable":true},"prev":{"type":"string","description":"The link to the previous page or `null` if there's no page.","nullable":true},"self":{"type":"string","description":"The link to the current page.","nullable":true}},"required":["first","items","last","next","prev","self"],"title":"PageActiveAccount"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Accounts"],"method":"get","path":"/accounts","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"List","description":{"content":"List the accounts","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"description":{"content":"Filter accounts that can or cannot do Content Generation","type":"text/plain"},"key":"can_content_generation","value":""},{"disabled":false,"description":{"content":"Add entity count data","type":"text/plain"},"key":"include_entity_count","value":""},{"disabled":false,"description":{"content":"Include all the accounts the user has access to","type":"text/plain"},"key":"include_all_accounts","value":""},{"disabled":false,"description":{"content":"Include the subscription data","type":"text/plain"},"key":"include_subscription","value":""},{"disabled":false,"description":{"content":"The URL","type":"text/plain"},"key":"url","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/vnd.wordlift.accounts+json;version=1"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +api: {"description":"List the accounts","operationId":"listAccounts","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"description":"Filter accounts that can or cannot do Content Generation","in":"query","name":"can_content_generation","required":false,"schema":{"type":"boolean"}},{"description":"Add entity count data","in":"query","name":"include_entity_count","required":false,"schema":{"type":"boolean","default":false}},{"description":"Include all the accounts the user has access to","in":"query","name":"include_all_accounts","required":false,"schema":{"type":"boolean","default":false}},{"description":"Include the subscription data","in":"query","name":"include_subscription","required":false,"schema":{"type":"boolean","default":false}},{"description":"The URL","in":"query","name":"url","required":false,"schema":{"type":"string"}},{"description":"The dataset id","in":"query","name":"ng_dataset_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.wordlift.accounts+json;version=1":{"schema":{"type":"object","description":"A page object with links to move to other pages and the list of objects.","properties":{"first":{"type":"string","description":"The link to the first page.","nullable":true},"items":{"type":"array","description":"An array of objects.","items":{"type":"object","description":"An array of objects.","properties":{"country":{"type":"string"},"diagnostic_plugins":{"type":"array","items":{"type":"object","description":"Plugin Data used for diagnostics","properties":{"account_id":{"type":"integer","format":"int64","description":"The account id.","readOnly":true},"active":{"type":"boolean","description":"Whether the plugin is active."},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"id":{"type":"integer","format":"int64","description":"The record id.","readOnly":true},"name":{"type":"string","description":"The plugin name."},"version":{"type":"string","description":"The plugin version."}},"title":"DiagnosticPlugin"}},"domain_uri":{"type":"string"},"google_search_console_site_url":{"type":"string"},"id":{"type":"integer","format":"int64"},"is_wordpress":{"type":"boolean"},"key":{"type":"string"},"language":{"type":"string"},"ng_dataset_id":{"type":"string"},"package_type":{"type":"string"},"subscription":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"order_id":{"type":"integer","format":"int64"},"sku":{"type":"string"}},"title":"AccountSubscription"},"subscription_id":{"type":"integer","format":"int64"},"total_entities":{"type":"integer","format":"int64"},"total_entities_with_schema_url":{"type":"integer","format":"int64"},"url":{"type":"string"},"user_id":{"type":"integer","format":"int64"},"wp_admin":{"type":"string"},"wp_include_exclude_default":{"type":"string"},"wp_json":{"type":"string"}},"title":"ActiveAccount"}},"last":{"type":"string","description":"The link to the last page.","nullable":true},"next":{"type":"string","description":"The link to the next page or `null` if there's no page.","nullable":true},"prev":{"type":"string","description":"The link to the previous page or `null` if there's no page.","nullable":true},"self":{"type":"string","description":"The link to the current page.","nullable":true}},"required":["first","items","last","next","prev","self"],"title":"PageActiveAccount"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Accounts"],"method":"get","path":"/accounts","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"List","description":{"content":"List the accounts","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"description":{"content":"Filter accounts that can or cannot do Content Generation","type":"text/plain"},"key":"can_content_generation","value":""},{"disabled":false,"description":{"content":"Add entity count data","type":"text/plain"},"key":"include_entity_count","value":""},{"disabled":false,"description":{"content":"Include all the accounts the user has access to","type":"text/plain"},"key":"include_all_accounts","value":""},{"disabled":false,"description":{"content":"Include the subscription data","type":"text/plain"},"key":"include_subscription","value":""},{"disabled":false,"description":{"content":"The URL","type":"text/plain"},"key":"url","value":""},{"disabled":false,"description":{"content":"The dataset id","type":"text/plain"},"key":"ng_dataset_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/vnd.wordlift.accounts+json;version=1"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} sidebar_class_name: "get api-method" info_path: api/manager/manager custom_edit_url: null @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; List the accounts -
    Query Parameters
    +
    Query Parameters
    Found @@ -34,7 +34,7 @@ Found An array of objects. -
  • Array [
    • diagnostic_plugins object[]
  • Array [
  • ]
    • subscription object
  • ]
    • +
  • Array [
    • diagnostic_plugins object[]
  • Array [
  • ]
    • subscription object
  • ]
    • Authentication Failure diff --git a/docs/api/manager/list-merchant-syncs.api.mdx b/docs/api/manager/list-merchant-syncs.api.mdx index 90db845..066e75f 100644 --- a/docs/api/manager/list-merchant-syncs.api.mdx +++ b/docs/api/manager/list-merchant-syncs.api.mdx @@ -34,7 +34,7 @@ Found An array of objects. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/manager/list-merchants.api.mdx b/docs/api/manager/list-merchants.api.mdx index 2a6fe6a..432eb29 100644 --- a/docs/api/manager/list-merchants.api.mdx +++ b/docs/api/manager/list-merchants.api.mdx @@ -34,7 +34,7 @@ Found An array of objects. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/manager/list-o-auth-2-authorized-clients.api.mdx b/docs/api/manager/list-o-auth-2-authorized-clients.api.mdx index bc16b2a..46d4748 100644 --- a/docs/api/manager/list-o-auth-2-authorized-clients.api.mdx +++ b/docs/api/manager/list-o-auth-2-authorized-clients.api.mdx @@ -34,7 +34,7 @@ Found An array of objects. -
  • Array [
  • ]
    • +
  • Array [
  • ]
    • Authentication Failure diff --git a/docs/api/manager/sidebar.js b/docs/api/manager/sidebar.js index 4b51870..59f5ea1 100644 --- a/docs/api/manager/sidebar.js +++ b/docs/api/manager/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/manager/manager"},{"type":"category","label":"Account","link":{"type":"doc","id":"api/manager/account"},"items":[{"type":"doc","id":"api/manager/get-me","label":"Get","className":"api-method get"}]},{"type":"category","label":"Custom Domains","link":{"type":"doc","id":"api/manager/custom-domains"},"items":[{"type":"doc","id":"api/manager/validate","label":"Validate","className":"api-method post"}]},{"type":"category","label":"AddOns","link":{"type":"doc","id":"api/manager/add-ons"},"items":[{"type":"doc","id":"api/manager/list-configurations","label":"List","className":"api-method get"}]},{"type":"category","label":"Data URI","link":{"type":"doc","id":"api/manager/data-uri"},"items":[{"type":"doc","id":"api/manager/get","label":"Get the Web Data URI for a Web Page URL.","className":"api-method get"}]},{"type":"category","label":"Sitemap Imports","link":{"type":"doc","id":"api/manager/sitemap-imports"},"items":[{"type":"doc","id":"api/manager/create-sitemap-import","label":"Create","className":"api-method post"}]},{"type":"category","label":"Google Search Console Searches","link":{"type":"doc","id":"api/manager/google-search-console-searches"},"items":[{"type":"doc","id":"api/manager/list-website-search-1","label":"List Website Search data","className":"api-method get"}]},{"type":"category","label":"Google Search Console","link":{"type":"doc","id":"api/manager/google-search-console"},"items":[{"type":"doc","id":"api/manager/list-website-search","label":"List Website Search data","className":"api-method get"},{"type":"doc","id":"api/manager/list-websites","label":"List","className":"api-method get"}]},{"type":"category","label":"Google Merchants","link":{"type":"doc","id":"api/manager/google-merchants"},"items":[{"type":"doc","id":"api/manager/list-google-merchants","label":"List","className":"api-method get"}]},{"type":"category","label":"OAuth2 Authorized Clients","link":{"type":"doc","id":"api/manager/o-auth-2-authorized-clients"},"items":[{"type":"doc","id":"api/manager/list-o-auth-2-authorized-clients","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-o-auth-2-authorized-client","label":"Create","className":"api-method post"},{"type":"doc","id":"api/manager/delete-o-auth-2-authorized-client","label":"Delete","className":"api-method delete"},{"type":"doc","id":"api/manager/get-o-auth-2-authorized-client","label":"Get","className":"api-method get"},{"type":"doc","id":"api/manager/update-o-auth-2-authorized-client","label":"Update","className":"api-method put"}]},{"type":"category","label":"Analytics Imports","link":{"type":"doc","id":"api/manager/analytics-imports"},"items":[{"type":"doc","id":"api/manager/create-analytics-import","label":"Create","className":"api-method post"}]},{"type":"category","label":"Redeem Codes","link":{"type":"doc","id":"api/manager/redeem-codes"},"items":[{"type":"doc","id":"api/manager/redeem-code","label":"Redeem the provided code and get a key","className":"api-method post"}]},{"type":"category","label":"Include Excludes (WordPress plugin)","link":{"type":"doc","id":"api/manager/include-excludes-word-press-plugin"},"items":[{"type":"doc","id":"api/manager/list-include-excludes","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/update-include-excludes","label":"Update","className":"api-method put"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/manager/accounts"},"items":[{"type":"doc","id":"api/manager/list-accounts","label":"List","className":"api-method get"}]},{"type":"category","label":"Merchants","link":{"type":"doc","id":"api/manager/merchants"},"items":[{"type":"doc","id":"api/manager/list-merchants","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-merchant","label":"Create","className":"api-method post"},{"type":"doc","id":"api/manager/delete-merchant","label":"Delete by id","className":"api-method delete"},{"type":"doc","id":"api/manager/get-merchant","label":"Get by id","className":"api-method get"},{"type":"doc","id":"api/manager/update-merchant","label":"Update","className":"api-method put"}]},{"type":"category","label":"Google Search Console OAuth2","link":{"type":"doc","id":"api/manager/google-search-console-o-auth-2"},"items":[{"type":"doc","id":"api/manager/create-auth-code-exchange","label":"Get an Access Code","className":"api-method post"},{"type":"doc","id":"api/manager/create-authorize-uri","label":"Create an Authorization URI","className":"api-method post"}]},{"type":"category","label":"Merchant Syncs","link":{"type":"doc","id":"api/manager/merchant-syncs"},"items":[{"type":"doc","id":"api/manager/list-merchant-syncs","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-sync","label":"Start","className":"api-method post"},{"type":"doc","id":"api/manager/get-merchant-sync","label":"Get by id","className":"api-method get"}]},{"type":"category","label":"Plugin Diagnostics","link":{"type":"doc","id":"api/manager/plugin-diagnostics"},"items":[{"type":"doc","id":"api/manager/update-diagnostic-plugin-collection","label":"Update","className":"api-method put"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/manager/manager"},{"type":"category","label":"Account","link":{"type":"doc","id":"api/manager/account"},"items":[{"type":"doc","id":"api/manager/get-me","label":"Get","className":"api-method get"}]},{"type":"category","label":"Custom Domains","link":{"type":"doc","id":"api/manager/custom-domains"},"items":[{"type":"doc","id":"api/manager/validate","label":"Validate","className":"api-method post"}]},{"type":"category","label":"Botify Crawl Imports","link":{"type":"doc","id":"api/manager/botify-crawl-imports"},"items":[{"type":"doc","id":"api/manager/create-botify-crawl-import","label":"Create","className":"api-method post"}]},{"type":"category","label":"AddOns","link":{"type":"doc","id":"api/manager/add-ons"},"items":[{"type":"doc","id":"api/manager/list-configurations","label":"List","className":"api-method get"}]},{"type":"category","label":"Data URI","link":{"type":"doc","id":"api/manager/data-uri"},"items":[{"type":"doc","id":"api/manager/get","label":"Get the Web Data URI for a Web Page URL.","className":"api-method get"}]},{"type":"category","label":"Sitemap Imports","link":{"type":"doc","id":"api/manager/sitemap-imports"},"items":[{"type":"doc","id":"api/manager/create-sitemap-import","label":"Create","className":"api-method post"}]},{"type":"category","label":"Google Search Console Searches","link":{"type":"doc","id":"api/manager/google-search-console-searches"},"items":[{"type":"doc","id":"api/manager/list-website-search-1","label":"List Website Search data","className":"api-method get"}]},{"type":"category","label":"Google Search Console","link":{"type":"doc","id":"api/manager/google-search-console"},"items":[{"type":"doc","id":"api/manager/list-website-search","label":"List Website Search data","className":"api-method get"},{"type":"doc","id":"api/manager/list-websites","label":"List","className":"api-method get"}]},{"type":"category","label":"Google Merchants","link":{"type":"doc","id":"api/manager/google-merchants"},"items":[{"type":"doc","id":"api/manager/list-google-merchants","label":"List","className":"api-method get"}]},{"type":"category","label":"OAuth2 Authorized Clients","link":{"type":"doc","id":"api/manager/o-auth-2-authorized-clients"},"items":[{"type":"doc","id":"api/manager/list-o-auth-2-authorized-clients","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-o-auth-2-authorized-client","label":"Create","className":"api-method post"},{"type":"doc","id":"api/manager/delete-o-auth-2-authorized-client","label":"Delete","className":"api-method delete"},{"type":"doc","id":"api/manager/get-o-auth-2-authorized-client","label":"Get","className":"api-method get"},{"type":"doc","id":"api/manager/update-o-auth-2-authorized-client","label":"Update","className":"api-method put"}]},{"type":"category","label":"Analytics Imports","link":{"type":"doc","id":"api/manager/analytics-imports"},"items":[{"type":"doc","id":"api/manager/create-analytics-import","label":"Create","className":"api-method post"}]},{"type":"category","label":"Vector Search Nodes","link":{"type":"doc","id":"api/manager/vector-search-nodes"},"items":[{"type":"doc","id":"api/manager/update-nodes-collection","label":"Update","className":"api-method put"}]},{"type":"category","label":"Redeem Codes","link":{"type":"doc","id":"api/manager/redeem-codes"},"items":[{"type":"doc","id":"api/manager/redeem-code","label":"Redeem the provided code and get a key","className":"api-method post"}]},{"type":"category","label":"Vector Search Queries","link":{"type":"doc","id":"api/manager/vector-search-queries"},"items":[{"type":"doc","id":"api/manager/create-query","label":"Create","className":"api-method put"}]},{"type":"category","label":"Include Excludes (WordPress plugin)","link":{"type":"doc","id":"api/manager/include-excludes-word-press-plugin"},"items":[{"type":"doc","id":"api/manager/list-include-excludes","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/update-include-excludes","label":"Update","className":"api-method put"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/manager/accounts"},"items":[{"type":"doc","id":"api/manager/list-accounts","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/get-account","label":"Get an account.","className":"api-method get"}]},{"type":"category","label":"Merchants","link":{"type":"doc","id":"api/manager/merchants"},"items":[{"type":"doc","id":"api/manager/list-merchants","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-merchant","label":"Create","className":"api-method post"},{"type":"doc","id":"api/manager/delete-merchant","label":"Delete by id","className":"api-method delete"},{"type":"doc","id":"api/manager/get-merchant","label":"Get by id","className":"api-method get"},{"type":"doc","id":"api/manager/update-merchant","label":"Update","className":"api-method put"}]},{"type":"category","label":"Google Search Console OAuth2","link":{"type":"doc","id":"api/manager/google-search-console-o-auth-2"},"items":[{"type":"doc","id":"api/manager/create-auth-code-exchange","label":"Get an Access Code","className":"api-method post"},{"type":"doc","id":"api/manager/create-authorize-uri","label":"Create an Authorization URI","className":"api-method post"}]},{"type":"category","label":"Merchant Syncs","link":{"type":"doc","id":"api/manager/merchant-syncs"},"items":[{"type":"doc","id":"api/manager/list-merchant-syncs","label":"List","className":"api-method get"},{"type":"doc","id":"api/manager/create-sync","label":"Start","className":"api-method post"},{"type":"doc","id":"api/manager/get-merchant-sync","label":"Get by id","className":"api-method get"}]},{"type":"category","label":"Plugin Diagnostics","link":{"type":"doc","id":"api/manager/plugin-diagnostics"},"items":[{"type":"doc","id":"api/manager/update-diagnostic-plugin-collection","label":"Update","className":"api-method put"}]}]; \ No newline at end of file diff --git a/docs/api/manager/update-merchant.api.mdx b/docs/api/manager/update-merchant.api.mdx index 18935a4..d5f2045 100644 --- a/docs/api/manager/update-merchant.api.mdx +++ b/docs/api/manager/update-merchant.api.mdx @@ -30,7 +30,7 @@ Update a Merchant Success -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/update-nodes-collection.api.mdx b/docs/api/manager/update-nodes-collection.api.mdx new file mode 100644 index 0000000..5a91d42 --- /dev/null +++ b/docs/api/manager/update-nodes-collection.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-nodes-collection +title: "Update" +description: "Update" +sidebar_label: "Update" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateNodesCollection","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"A list of node requests.","items":{"type":"object","description":"A node request.","properties":{"embeddings":{"type":"array","description":"A list of embeddings.","items":{"type":"number","format":"double","description":"A list of embeddings."}},"entity_id":{"type":"string","description":"The entity id in the form on an IRI, e.g. https://data.example.org/dataset/entity."},"metadata":{"type":"object","additionalProperties":{"type":"object","description":"A map of metadata properties."},"description":"A map of metadata properties."},"node_id":{"type":"string","description":"The node id generally expressed in the form of a UUID."},"text":{"type":"string","description":"The original text."}},"required":["entity_id","node_id"],"title":"NodeRequest"}}}},"required":true},"responses":{"200":{"description":"Found."},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"ApiKey":[]}],"tags":["Vector Search Nodes"],"description":"Update","method":"put","path":"/vector-search/nodes-collection","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":[{"embeddings":[0],"entity_id":"string","metadata":{},"node_id":"string","text":"string"}],"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Update","description":{"type":"text/plain"},"url":{"path":["vector-search","nodes-collection"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "put api-method" +info_path: api/manager/manager +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update + + + +Update + +
    Request Body array required
    • Array [
      • metadata object
      + +A map of metadata properties. + +
    • ]
    + +Found. + +
    + +Authentication Failure + +
    + +Not Found + +
    + \ No newline at end of file diff --git a/docs/api/manager/update-o-auth-2-authorized-client.api.mdx b/docs/api/manager/update-o-auth-2-authorized-client.api.mdx index e1497be..7baf063 100644 --- a/docs/api/manager/update-o-auth-2-authorized-client.api.mdx +++ b/docs/api/manager/update-o-auth-2-authorized-client.api.mdx @@ -5,7 +5,7 @@ description: "Update a OAuth2 Authorized Client given its client registration id sidebar_label: "Update" hide_title: true hide_table_of_contents: true -api: {"description":"Update a OAuth2 Authorized Client given its client registration id","operationId":"updateOAuth2AuthorizedClient","parameters":[{"description":"The Id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The OAuth2 Authorized Client request","properties":{"access_token_expires_at":{"type":"string","format":"date-time","description":"When the Access Token expires"},"access_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"access_token_scopes":{"type":"string","description":"The Access Token scopes"},"access_token_type":{"type":"string","description":"The Access Token Type"},"access_token_value":{"type":"string","description":"The Access Token Value"},"client_registration_id":{"type":"string","description":"The Client Registration Id"},"principal_name":{"type":"string","description":"The Principal Name"},"refresh_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"refresh_token_value":{"type":"string","description":"The Refresh Token Value"}},"title":"OAuth2AuthorizedClientRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A OAuth2 Authorized Client","properties":{"access_token_expires_at":{"type":"string","format":"date-time"},"access_token_issued_at":{"type":"string","format":"date-time"},"access_token_scopes":{"type":"string"},"access_token_type":{"type":"string"},"access_token_value":{"type":"string"},"client_registration_id":{"type":"string"},"id":{"type":"integer","format":"int64"},"principal_name":{"type":"string"},"refresh_token_issued_at":{"type":"string","format":"date-time"},"refresh_token_value":{"type":"string"}},"title":"OAuth2AuthorizedClient"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"put","path":"/oauth2/authorized-clients/{id}","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"access_token_expires_at":"2024-01-17T14:56:58.826Z","access_token_issued_at":"2024-01-17T14:56:58.826Z","access_token_scopes":"string","access_token_type":"string","access_token_value":"string","client_registration_id":"string","principal_name":"string","refresh_token_issued_at":"2024-01-17T14:56:58.826Z","refresh_token_value":"string"},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Update","description":{"content":"Update a OAuth2 Authorized Client given its client registration id","type":"text/plain"},"url":{"path":["oauth2","authorized-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +api: {"description":"Update a OAuth2 Authorized Client given its client registration id","operationId":"updateOAuth2AuthorizedClient","parameters":[{"description":"The Id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The OAuth2 Authorized Client request","properties":{"access_token_expires_at":{"type":"string","format":"date-time","description":"When the Access Token expires"},"access_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"access_token_scopes":{"type":"string","description":"The Access Token scopes"},"access_token_type":{"type":"string","description":"The Access Token Type"},"access_token_value":{"type":"string","description":"The Access Token Value"},"client_registration_id":{"type":"string","description":"The Client Registration Id"},"principal_name":{"type":"string","description":"The Principal Name"},"refresh_token_issued_at":{"type":"string","format":"date-time","description":"When the Access Token was issued"},"refresh_token_value":{"type":"string","description":"The Refresh Token Value"}},"title":"OAuth2AuthorizedClientRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A OAuth2 Authorized Client","properties":{"access_token_expires_at":{"type":"string","format":"date-time"},"access_token_issued_at":{"type":"string","format":"date-time"},"access_token_scopes":{"type":"string"},"access_token_type":{"type":"string"},"access_token_value":{"type":"string"},"client_registration_id":{"type":"string"},"id":{"type":"integer","format":"int64"},"principal_name":{"type":"string"},"refresh_token_issued_at":{"type":"string","format":"date-time"},"refresh_token_value":{"type":"string"}},"title":"OAuth2AuthorizedClient"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"put","path":"/oauth2/authorized-clients/{id}","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"description":"`Key {your key}`","in":"header","name":"Authorization","type":"apiKey"},"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://s.wordlift.io/oauth/authorize/","scopes":{"basic":"basic scope"},"tokenUrl":"https://s.wordlift.io/oauth/token/"}},"type":"oauth2"}},"jsonRequestBodyExample":{"access_token_expires_at":"2024-02-28T15:20:20.108Z","access_token_issued_at":"2024-02-28T15:20:20.108Z","access_token_scopes":"string","access_token_type":"string","access_token_value":"string","client_registration_id":"string","principal_name":"string","refresh_token_issued_at":"2024-02-28T15:20:20.108Z","refresh_token_value":"string"},"info":{"contact":{"email":"hello@wordlift.io","name":"WordLift","url":"https://wordlift.io"},"description":"Subscription management and related services.","license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"},"termsOfService":"https://wordlift.io/terms-of-service/","title":"Manager","version":"1.0"},"postman":{"name":"Update","description":{"content":"Update a OAuth2 Authorized Client given its client registration id","type":"text/plain"},"url":{"path":["oauth2","authorized-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} sidebar_class_name: "put api-method" info_path: api/manager/manager custom_edit_url: null @@ -30,7 +30,7 @@ Update a OAuth2 Authorized Client given its client registration id Found -
    Schema
    +
    Schema
    Authentication Failure diff --git a/docs/api/manager/vector-search-nodes.tag.mdx b/docs/api/manager/vector-search-nodes.tag.mdx new file mode 100644 index 0000000..9e19f3d --- /dev/null +++ b/docs/api/manager/vector-search-nodes.tag.mdx @@ -0,0 +1,20 @@ +--- +id: vector-search-nodes +title: "Vector Search Nodes" +description: "Vector Search Nodes" +custom_edit_url: null +--- + + + +Manage vector search nodes embeddings. + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/manager/vector-search-queries.tag.mdx b/docs/api/manager/vector-search-queries.tag.mdx new file mode 100644 index 0000000..3177fed --- /dev/null +++ b/docs/api/manager/vector-search-queries.tag.mdx @@ -0,0 +1,20 @@ +--- +id: vector-search-queries +title: "Vector Search Queries" +description: "Vector Search Queries" +custom_edit_url: null +--- + + + +Create vector search queries. + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/seo-score/create-seo-score.api.mdx b/docs/api/seo-score/create-seo-score.api.mdx index 9c6a6ea..c1b9312 100644 --- a/docs/api/seo-score/create-seo-score.api.mdx +++ b/docs/api/seo-score/create-seo-score.api.mdx @@ -5,7 +5,7 @@ description: "Create" sidebar_label: "Create" hide_title: true hide_table_of_contents: true -api: {"tags":["SEO Scores"],"operationId":"createSEOScore","requestBody":{"description":"body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL of the content to be analyzed. Mutually exclusive with text."},"text":{"type":"string","description":"A paragraph of text content to be analyzed. Mutually exclusive with URL."},"keyword":{"type":"string","description":"Keyword or query related to the content."},"description_narrative":{"type":"string","description":"Narrative description of the intent behind the query."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"analyze":{"type":"string","example":"[{\"M\": 2, \"T\": 2, \"O\": 2}]","description":"Traffic light system indicating the match. M for match, T for trustworthiness, O for overall score."}}}}}},"400":{"description":"Bad request","content":{}},"401":{"description":"Unauthorized","content":{}},"500":{"description":"Internal server error","content":{}}},"security":[{"ApiKey":[]}],"description":"Create","method":"post","path":"/score","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"type":"apiKey","name":"Authorization","in":"header"}},"jsonRequestBodyExample":{"url":"string","text":"string","keyword":"string","description_narrative":"string"},"info":{"title":"SEO Content Analysis API","version":"1.0","description":"This API assesses the match between a URL or text content, a query, and an intent, using advanced SEO techniques.","termsOfService":"https://wordlift.io/terms-of-service/","contact":{"name":"WordLift","url":"https://wordlift.io","email":"hello@wordlift.io"},"license":{"name":"(c) copyright 2022-present WordLift","url":"https://wordlift.io"}},"postman":{"name":"Create","description":{"type":"text/plain"},"url":{"path":["score"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"tags":["SEO Scores"],"operationId":"createSEOScore","requestBody":{"description":"body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL of the content to be analyzed. Mutually exclusive with text."},"text":{"type":"string","description":"A paragraph of text content to be analyzed. Mutually exclusive with URL."},"keyword":{"type":"string","description":"Keyword or query related to the content."},"description_narrative":{"type":"string","description":"Narrative description of the intent behind the query."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"analyze":{"type":"string","example":"[{\"M\": 2, \"T\": 2, \"O\": 2}]","description":"Traffic light system indicating the match. M for match, T for trustworthiness, O for overall score."}}}}}},"400":{"description":"Bad request","content":{}},"401":{"description":"Unauthorized","content":{}},"500":{"description":"Internal server error","content":{}}},"security":[{"ApiKey":[]}],"description":"Create","method":"post","path":"/score","servers":[{"url":"https://api.wordlift.io/quality-rating"}],"securitySchemes":{"ApiKey":{"type":"apiKey","name":"Authorization","in":"header"}},"jsonRequestBodyExample":{"url":"string","text":"string","keyword":"string","description_narrative":"string"},"info":{"title":"SEO Content Analysis API","version":"1.0","description":"This API assesses the match between a URL or text content, a query, and an intent, using advanced SEO techniques.","termsOfService":"https://wordlift.io/terms-of-service/","contact":{"name":"WordLift","url":"https://wordlift.io","email":"hello@wordlift.io"},"license":{"name":"(c) copyright 2023-present WordLift","url":"https://wordlift.io"}},"postman":{"name":"Create","description":{"type":"text/plain"},"url":{"path":["score"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/seo-score/seo-content-analysis-api custom_edit_url: null diff --git a/docs/api/seo-score/seo-content-analysis-api.info.mdx b/docs/api/seo-score/seo-content-analysis-api.info.mdx index 721323a..8a0096f 100644 --- a/docs/api/seo-score/seo-content-analysis-api.info.mdx +++ b/docs/api/seo-score/seo-content-analysis-api.info.mdx @@ -21,5 +21,5 @@ import Export from "@theme/ApiDemoPanel/Export"; This API assesses the match between a URL or text content, a query, and an intent, using advanced SEO techniques. -

    Authentication

    Security Scheme Type:apiKey
    Header parameter name:Authorization
    +

    Authentication

    Security Scheme Type:apiKey
    Header parameter name:Authorization
    \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 69658f1..057b6da 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -322,14 +322,15 @@ const config = { categoryLinkSource: "tag", }, }, - embeddings: { - specPath: "api/embeddings.yaml", // path or URL to the OpenAPI spec - outputDir: "docs/api/embeddings", // output directory for generated *.mdx and sidebar.js files - sidebarOptions: { - groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag - categoryLinkSource: "tag", - }, - }, + // This API is deprecated. + // embeddings: { + // specPath: "api/embeddings.yaml", // path or URL to the OpenAPI spec + // outputDir: "docs/api/embeddings", // output directory for generated *.mdx and sidebar.js files + // sidebarOptions: { + // groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag + // categoryLinkSource: "tag", + // }, + // }, events: { specPath: "api/events.yaml", // path or URL to the OpenAPI spec outputDir: "docs/api/events", // output directory for generated *.mdx and sidebar.js files