diff --git a/.bin/rebuild-api.sh b/.bin/rebuild-api.sh index 4844cd9..fd3d272 100755 --- a/.bin/rebuild-api.sh +++ b/.bin/rebuild-api.sh @@ -4,6 +4,7 @@ npm run docusaurus clean-api-docs analysis && npm run docusaurus gen-api-docs an 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 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 npm run docusaurus clean-api-docs inspector && npm run docusaurus gen-api-docs inspector npm run docusaurus clean-api-docs long-tail && npm run docusaurus gen-api-docs long-tail diff --git a/api/fact-check.yaml b/api/fact-check.yaml new file mode 100644 index 0000000..a8ea55e --- /dev/null +++ b/api/fact-check.yaml @@ -0,0 +1,43 @@ +openapi: 3.0.0 +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. +servers: + - url: https://api.wordlift.io +paths: + /fact-check/score: + post: + summary: Submit a fact-checking request + 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}" +security: + - ApiKeyAuth: [] +components: + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: Authorization diff --git a/docs/api/content-generation/create-content-generation.api.mdx b/docs/api/content-generation/create-content-generation.api.mdx index 1d4cff0..334c49e 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 1d9bfba..a651f35 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 9e24724..6860c56 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 096bda3..c100a78 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 4761790..890750c 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 b2fa3ad..4044f65 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 7bd8249..aec7e40 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 081046c..12e7507 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 3f5d0d6..b09acba 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 9866e59..974864c 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 4452755..e4825fd 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 26f5161..fb087b5 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 1dab9b8..6e982b8 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 b90eafb..78813d9 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 0e9bec6..c2cf827 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 9c7ff8d..8b6ec84 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 e3d76a3..3d78fc7 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/sidebar.js b/docs/api/fact-check/sidebar.js new file mode 100644 index 0000000..7485b74 --- /dev/null +++ b/docs/api/fact-check/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/fact-check/wordlift-fact-checking-api"},{"type":"category","label":"Fact Check","items":[{"type":"doc","id":"api/fact-check/submit-fact-check","label":"Submit a fact-checking request","className":"api-method post"}]}]; \ 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 new file mode 100644 index 0000000..8aac5c3 --- /dev/null +++ b/docs/api/fact-check/submit-fact-check.api.mdx @@ -0,0 +1,34 @@ +--- +id: submit-fact-check +title: "Submit a fact-checking request" +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"}}}}} +sidebar_class_name: "post api-method" +info_path: api/fact-check/wordlift-fact-checking-api +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"; + +## Submit a fact-checking request + + + +Submit a fact-checking request + +
    Request Body required
    + +Fact-checking result + +
    Schema
    + \ No newline at end of file diff --git a/docs/api/fact-check/wordlift-fact-checking-api.info.mdx b/docs/api/fact-check/wordlift-fact-checking-api.info.mdx new file mode 100644 index 0000000..f814bb8 --- /dev/null +++ b/docs/api/fact-check/wordlift-fact-checking-api.info.mdx @@ -0,0 +1,25 @@ +--- +id: wordlift-fact-checking-api +title: "WordLift Fact-Checking API" +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." +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from "@theme/ApiLogo"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 1.0.0 + +# WordLift Fact-Checking API + + + +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. + +

    Authentication

    Security Scheme Type:apiKey
    Header parameter name:Authorization
    + \ No newline at end of file diff --git a/docs/api/long-tail/get.api.mdx b/docs/api/long-tail/get.api.mdx index c569cec..68477d4 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 27b6f0b..31fb5f5 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/entities.tag.mdx b/docs/api/manager/account.tag.mdx similarity index 68% rename from docs/api/manager/entities.tag.mdx rename to docs/api/manager/account.tag.mdx index 4989e9c..ecc46fc 100644 --- a/docs/api/manager/entities.tag.mdx +++ b/docs/api/manager/account.tag.mdx @@ -1,13 +1,13 @@ --- -id: entities -title: "Entities" -description: "Entities" +id: account +title: "Account" +description: "Account" custom_edit_url: null --- -Quickly Retrieve entities and their Structured Data. +Get Account Information diff --git a/docs/api/manager/analytics-imports.tag.mdx b/docs/api/manager/analytics-imports.tag.mdx new file mode 100644 index 0000000..437d9c4 --- /dev/null +++ b/docs/api/manager/analytics-imports.tag.mdx @@ -0,0 +1,20 @@ +--- +id: analytics-imports +title: "Analytics Imports" +description: "Analytics Imports" +custom_edit_url: null +--- + + + +Import Analytics data to the KG using different sources, e.g. Google Search Console. + + + +```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 new file mode 100644 index 0000000..e3e150c --- /dev/null +++ b/docs/api/manager/create-analytics-import.api.mdx @@ -0,0 +1,38 @@ +--- +id: create-analytics-import +title: "Create" +description: "Create a Analytics Import using Google Search Console or Botify depending on the Account configuration." +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"}]}}} +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 Analytics Import using Google Search Console or Botify depending on the Account configuration. + +
    + +Success + +
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/create-auth-code-exchange.api.mdx b/docs/api/manager/create-auth-code-exchange.api.mdx new file mode 100644 index 0000000..b006829 --- /dev/null +++ b/docs/api/manager/create-auth-code-exchange.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-auth-code-exchange +title: "Get an Access Code" +description: "Call this API to have the Platform receive an Authentication Token to access the Analytics data via Google Search Console." +sidebar_label: "Get an Access Code" +hide_title: true +hide_table_of_contents: true +api: {"description":"Call this API to have the Platform receive an Authentication Token to access the Analytics data via Google Search Console.","operationId":"createAuthCodeExchange","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The request of the `exchangeAuthCode` endpoint.","properties":{"code":{"type":"string","description":"The Authorization Code. The API will use the Authorization Code to exchange it with an Access Token."},"google_search_console_resource_id":{"type":"string","description":"The Google Search Console Resource Id as it shows in the Google Search Console, e.g. sc-domain:example.org."}},"required":["code","google_search_console_resource_id"],"title":"ExchangeAuthCodeRequest"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"object","description":"The response of the `buildAuthorizeUri` endpoint.","properties":{"access_token":{"type":"string","description":"The access token"},"expires_in":{"type":"integer","format":"int32","description":"The number of seconds for the access token to expire"},"refresh_token":{"type":"string","description":"The refresh token"},"scope":{"type":"string","description":"The scope"},"token_type":{"type":"string","description":"The token type, usually Bearer"}},"title":"ExchangeAuthCodeResponse"}}},"description":"Found"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"ApiKey":[]}],"tags":["Google Search Console OAuth2"],"method":"post","path":"/google-search-console/oauth2/auth-code-exchanges","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":{"code":"string","google_search_console_resource_id":"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":"Get an Access Code","description":{"content":"Call this API to have the Platform receive an Authentication Token to access the Analytics data via Google Search Console.","type":"text/plain"},"url":{"path":["google-search-console","oauth2","auth-code-exchanges"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"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"; + +## Get an Access Code + + + +Call this API to have the Platform receive an Authentication Token to access the Analytics data via Google Search Console. + +
    Request Body required
    + +Found + +
    Schema
    + +Authentication Failure + +
    + +Not Found + +
    + \ No newline at end of file diff --git a/docs/api/manager/create-authorize-uri.api.mdx b/docs/api/manager/create-authorize-uri.api.mdx new file mode 100644 index 0000000..3afb357 --- /dev/null +++ b/docs/api/manager/create-authorize-uri.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-authorize-uri +title: "Create an Authorization URI" +description: "Call this API to get an authorization URI needed to interactively get an authorization token. Then call the `exchangeAuthCode` to exchange it with an authorization token." +sidebar_label: "Create an Authorization URI" +hide_title: true +hide_table_of_contents: true +api: {"description":"Call this API to get an authorization URI needed to interactively get an authorization token. Then call the `exchangeAuthCode` to exchange it with an authorization token.","operationId":"createAuthorizeUri","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The request of the `buildAuthorizeUri` endpoint.","properties":{"redirect_uri":{"type":"string","description":"The Redirect URI to where redirect the Client after successful authentication."}},"required":["redirect_uri"],"title":"BuildAuthorizeUriRequest"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"type":"object","description":"The response of the `buildAuthorizeUri` endpoint.","properties":{"authorize_uri":{"type":"string","description":"The Authorization URI. The Client should be redirected to this URI."}},"required":["authorize_uri"],"title":"BuildAuthorizeUriResponse"}}},"description":"Found"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"ApiKey":[]}],"tags":["Google Search Console OAuth2"],"method":"post","path":"/google-search-console/oauth2/authorize-uris","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":{"redirect_uri":"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 an Authorization URI","description":{"content":"Call this API to get an authorization URI needed to interactively get an authorization token. Then call the `exchangeAuthCode` to exchange it with an authorization token.","type":"text/plain"},"url":{"path":["google-search-console","oauth2","authorize-uris"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"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 an Authorization URI + + + +Call this API to get an authorization URI needed to interactively get an authorization token. Then call the `exchangeAuthCode` to exchange it with an authorization token. + +
    Request Body required
    + +Found + +
    Schema
    + +Authentication Failure + +
    + +Not Found + +
    + \ 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 f4010ce..d601bf4 100644 --- a/docs/api/manager/create-merchant.api.mdx +++ b/docs/api/manager/create-merchant.api.mdx @@ -5,7 +5,7 @@ description: "Create a Merchant" sidebar_label: "Create" hide_title: true hide_table_of_contents: true -api: {"description":"Create a Merchant","operationId":"createMerchant","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Merchant request","properties":{"access_token":{"type":"string","description":"Google Merchant access token"},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example \"data\")"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"Google Merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["google_merchant_id","publisher_name","refresh_token","url"],"title":"Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"post","path":"/merchants","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":"string","dataset_domain":"string","dataset_name":"string","deleted":false,"google_merchant_id":0,"publisher_name":"string","refresh_token":"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 Merchant","type":"text/plain"},"url":{"path":["merchants"],"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 Merchant","operationId":"createMerchant","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Merchant request","properties":{"access_token":{"type":"string","description":"Google Merchant access token"},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example \"data\")"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"Google Merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["google_merchant_id","publisher_name","refresh_token","url"],"title":"MerchantRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"post","path":"/merchants","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":"string","dataset_domain":"string","dataset_name":"string","deleted":false,"google_merchant_id":0,"ignore_brand":true,"ignore_image":true,"publisher_name":"string","refresh_token":"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 Merchant","type":"text/plain"},"url":{"path":["merchants"],"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 @@ -26,11 +26,11 @@ import TabItem from "@theme/TabItem"; Create a Merchant -
    Request Body required
    +
    Request Body required
    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 new file mode 100644 index 0000000..ed14c1e --- /dev/null +++ b/docs/api/manager/create-o-auth-2-authorized-client.api.mdx @@ -0,0 +1,38 @@ +--- +id: create-o-auth-2-authorized-client +title: "Create" +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":[]}}} +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 OAuth2 Authorized Client + +
    Request Body required
    + +Found + +
    Schema
    + +Authentication Failure + +
    + \ 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 new file mode 100644 index 0000000..6c1b88d --- /dev/null +++ b/docs/api/manager/create-sitemap-import.api.mdx @@ -0,0 +1,38 @@ +--- +id: create-sitemap-import +title: "Create" +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"}]}}} +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 Sitemap Import + +
    Request Body required
    + +Success + +
    Schema
    • Array [
    • ]
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/create-sync.api.mdx b/docs/api/manager/create-sync.api.mdx index 38560ac..f1ea472 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/delete-o-auth-2-authorized-client.api.mdx b/docs/api/manager/delete-o-auth-2-authorized-client.api.mdx new file mode 100644 index 0000000..9d88a75 --- /dev/null +++ b/docs/api/manager/delete-o-auth-2-authorized-client.api.mdx @@ -0,0 +1,38 @@ +--- +id: delete-o-auth-2-authorized-client +title: "Delete" +description: "Delete a OAuth2 Authorized Client given its client registration id" +sidebar_label: "Delete" +hide_title: true +hide_table_of_contents: true +api: {"description":"Delete a OAuth2 Authorized Client given its client registration id","operationId":"deleteOAuth2AuthorizedClient","parameters":[{"description":"The Id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"delete","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"}},"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":"Delete","description":{"content":"Delete 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"}]},"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete 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"; + +## Delete + + + +Delete a OAuth2 Authorized Client given its client registration id + +
    Path Parameters
    + +Found + +
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/get-me.api.mdx b/docs/api/manager/get-me.api.mdx new file mode 100644 index 0000000..55c47f0 --- /dev/null +++ b/docs/api/manager/get-me.api.mdx @@ -0,0 +1,46 @@ +--- +id: get-me +title: "Get" +description: "Get the account data for the current account identified by its key." +sidebar_label: "Get" +hide_title: true +hide_table_of_contents: true +api: {"description":"Get the account data for the current account identified by its key.","operationId":"getMe","responses":{"200":{"content":{"application/vnd.wordlift.account-info.v2+json":{"schema":{"type":"object","description":"Account Information","properties":{"accountId":{"type":"integer","format":"int64","description":"The Account Id","readOnly":true},"datasetId":{"type":"string","description":"The Dataset Id","readOnly":true},"datasetUri":{"type":"string","description":"The dataset URI","readOnly":true},"features":{"type":"object","additionalProperties":{"type":"boolean","description":"A list of features enabled or disabled for the account","readOnly":true},"description":"A list of features enabled or disabled for the account","readOnly":true},"googleSearchConsoleSiteUrl":{"type":"string","description":"Google Search Console Site URL","readOnly":true},"key":{"type":"string","description":"The Key","readOnly":true},"language":{"type":"string","description":"The language code","readOnly":true},"networks":{"type":"array","description":"A list of connected Account Information","items":{"type":"object","description":"Network Account Information","properties":{"accountId":{"type":"integer","format":"int64","description":"The Account Id","readOnly":true},"datasetId":{"type":"string","description":"The Dataset Id","readOnly":true},"datasetUri":{"type":"string","description":"The Dataset URI","readOnly":true},"url":{"type":"string","description":"The website URL","readOnly":true}},"readOnly":true,"required":["datasetUri"],"title":"NetworkAccountInfo"},"readOnly":true},"ngDatasetId":{"type":"string"},"subscriptionId":{"type":"integer","format":"int64","description":"The Subscription Id","readOnly":true},"url":{"type":"string","description":"The website URL","readOnly":true},"wpAdmin":{"type":"string","description":"If WordPress, the WP-ADMIN URL","readOnly":true},"wpJson":{"type":"string","description":"If WordPress, the WP-JSON end-point","readOnly":true}},"required":["accountId","datasetUri","networks","subscriptionId"],"title":"AccountInfo"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"tags":["Account"],"method":"get","path":"/accounts/me","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","description":{"content":"Get the account data for the current account identified by its key.","type":"text/plain"},"url":{"path":["accounts","me"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/vnd.wordlift.account-info.v2+json"}],"method":"GET"}} +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 + + + +Get the account data for the current account identified by its key. + +
    + +Found + +
    Schema
      features object
      + +A list of features enabled or disabled for the account + +
      networks object[] required
      + +A list of connected Account Information + +
    • Array [
    • ]
    + +Authentication Failure + +
    + \ 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 c16cedd..1905974 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 c520194..6345083 100644 --- a/docs/api/manager/get-merchant.api.mdx +++ b/docs/api/manager/get-merchant.api.mdx @@ -5,7 +5,7 @@ description: "Get a Merchant by its `id`." sidebar_label: "Get by id" hide_title: true hide_table_of_contents: true -api: {"description":"Get a Merchant by its `id`.","operationId":"getMerchant","parameters":[{"description":"The Merchant id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"get","path":"/merchants/{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 by id","description":{"content":"Get a Merchant by its `id`.","type":"text/plain"},"url":{"path":["merchants",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Merchant id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +api: {"description":"Get a Merchant by its `id`.","operationId":"getMerchant","parameters":[{"description":"The Merchant id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"get","path":"/merchants/{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 by id","description":{"content":"Get a Merchant by its `id`.","type":"text/plain"},"url":{"path":["merchants",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Merchant id","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 @@ -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 new file mode 100644 index 0000000..c2640f9 --- /dev/null +++ b/docs/api/manager/get-o-auth-2-authorized-client.api.mdx @@ -0,0 +1,38 @@ +--- +id: get-o-auth-2-authorized-client +title: "Get" +description: "Get a OAuth2 Authorized Client given its client registration id" +sidebar_label: "Get" +hide_title: true +hide_table_of_contents: true +api: {"description":"Get a OAuth2 Authorized Client given its client registration id","operationId":"getOAuth2AuthorizedClient","parameters":[{"description":"The Id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"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":"get","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"}},"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","description":{"content":"Get 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":"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 + + + +Get a OAuth2 Authorized Client given its client registration id + +
    Path Parameters
    + +Found + +
    Schema
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/google-search-console-o-auth-2.tag.mdx b/docs/api/manager/google-search-console-o-auth-2.tag.mdx new file mode 100644 index 0000000..8208298 --- /dev/null +++ b/docs/api/manager/google-search-console-o-auth-2.tag.mdx @@ -0,0 +1,20 @@ +--- +id: google-search-console-o-auth-2 +title: "Google Search Console OAuth2" +description: "Google Search Console OAuth2" +custom_edit_url: null +--- + + + +Configure Google Search Console OAuth2 authorized access codes. + + + +```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/google-search-console-searches.tag.mdx b/docs/api/manager/google-search-console-searches.tag.mdx new file mode 100644 index 0000000..5b437b6 --- /dev/null +++ b/docs/api/manager/google-search-console-searches.tag.mdx @@ -0,0 +1,20 @@ +--- +id: google-search-console-searches +title: "Google Search Console Searches" +description: "Google Search Console Searches" +custom_edit_url: null +--- + + + +Retrieve analytics data from Google Search Console + + + +```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/list-accounts.api.mdx b/docs/api/manager/list-accounts.api.mdx index ea814dd..73e3aff 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}},{"in":"query","name":"can_content_generation","required":false,"schema":{"type":"boolean"}}],"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"},"domain_uri":{"type":"string"},"id":{"type":"integer","format":"int64"},"key":{"type":"string"},"language":{"type":"string"},"ng_dataset_id":{"type":"string"},"package_type":{"type":"string"},"subscription_id":{"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,"key":"can_content_generation","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"}}],"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":[]}}} 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 [
  • ]
    • +
  • Array [
    • diagnostic_plugins object[]
  • Array [
  • ]
    • subscription object
  • ]
    • Authentication Failure diff --git a/docs/api/manager/list-entities.api.mdx b/docs/api/manager/list-entities.api.mdx deleted file mode 100644 index 91847f3..0000000 --- a/docs/api/manager/list-entities.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: list-entities -title: "List" -description: "List the Entities" -sidebar_label: "List" -hide_title: true -hide_table_of_contents: true -api: {"description":"List the Entities","operationId":"listEntities","parameters":[{"description":"The dataset URI to search","in":"query","name":"dataset_uri_in","required":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true},"style":"form"},{"description":"The name regex","in":"query","name":"name_match","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer","default":10}},{"description":"The sorting, only `+name` is supported","in":"query","name":"sort","required":false,"schema":{"type":"string","default":"+name"}}],"responses":{"200":{"content":{"application/json":{"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":{"structured_data":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}},"title":"Entity"}},"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":"PageEntity"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Entities"],"method":"get","path":"/entities","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 Entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The dataset URI to search","type":"text/plain"},"key":"dataset_uri_in","value":""},{"disabled":false,"description":{"content":"(Required) The name regex","type":"text/plain"},"key":"name_match","value":""},{"disabled":false,"description":{"content":"The maximum number of results","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"The sorting, only `+name` is supported","type":"text/plain"},"key":"sort","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -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"; - -## List - - - -List the Entities - -
    Query Parameters
    - -Found - -
    Schema
      items object[] required
      - -An array of objects. - -
    • Array [
    • ]
    - -Authentication Failure - -
    - \ No newline at end of file diff --git a/docs/api/manager/list-include-excludes.api.mdx b/docs/api/manager/list-include-excludes.api.mdx index fd02269..50a3ec3 100644 --- a/docs/api/manager/list-include-excludes.api.mdx +++ b/docs/api/manager/list-include-excludes.api.mdx @@ -5,7 +5,7 @@ description: "List the include and exclude configurations." sidebar_label: "List" hide_title: true hide_table_of_contents: true -api: {"description":"List the include and exclude configurations.","operationId":"listIncludeExcludes","parameters":[{"in":"query","name":"account","required":true,"schema":{"type":"object","properties":{"analyzerId":{"type":"integer","format":"int64"},"country":{"type":"string"},"datasetId":{"type":"string","deprecated":true},"domainUri":{"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Not Found"}},"tags":["Include Excludes (WordPress plugin)"],"method":"get","path":"/accounts/me/include-excludes","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 include and exclude configurations.","type":"text/plain"},"url":{"path":["accounts","me","include-excludes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"account","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"List the include and exclude configurations.","operationId":"listIncludeExcludes","parameters":[{"in":"query","name":"account","required":true,"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Not Found"}},"tags":["Include Excludes (WordPress plugin)"],"method":"get","path":"/accounts/me/include-excludes","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 include and exclude configurations.","type":"text/plain"},"url":{"path":["accounts","me","include-excludes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"account","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} 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 include and exclude configurations. -
    Query Parameters
    +
    Query Parameters
    Success diff --git a/docs/api/manager/list-merchant-syncs.api.mdx b/docs/api/manager/list-merchant-syncs.api.mdx index 0c65cf2..90db845 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 968c084..2a6fe6a 100644 --- a/docs/api/manager/list-merchants.api.mdx +++ b/docs/api/manager/list-merchants.api.mdx @@ -5,7 +5,7 @@ description: "List the Merchants, optionally filtering by the `deleted` flag" sidebar_label: "List" hide_title: true hide_table_of_contents: true -api: {"description":"List the Merchants, optionally filtering by the `deleted` flag","operationId":"listMerchants","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer","default":10}},{"description":"Filter by the `deleted` flag","in":"query","name":"deleted","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"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":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"sid":{"type":"string"},"sync_has_errors":{"type":"boolean"},"sync_id":{"type":"integer","format":"int64"},"sync_products_created":{"type":"integer","format":"int32"},"sync_products_deleted":{"type":"integer","format":"int32"},"sync_products_errored":{"type":"integer","format":"int32"},"sync_products_skipped":{"type":"integer","format":"int32"},"sync_products_total":{"type":"integer","format":"int32"},"sync_products_updated":{"type":"integer","format":"int32"},"sync_started_at":{"type":"string","format":"date-time","description":"The started date-time.","readOnly":true},"sync_stopped_at":{"type":"string","format":"date-time","description":"The stopped date-time.","readOnly":true},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"MerchantView"}},"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":"PageMerchantView"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"get","path":"/merchants","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 Merchants, optionally filtering by the `deleted` flag","type":"text/plain"},"url":{"path":["merchants"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"The maximum number of results","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filter by the `deleted` flag","type":"text/plain"},"key":"deleted","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +api: {"description":"List the Merchants, optionally filtering by the `deleted` flag","operationId":"listMerchants","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer","default":10}},{"description":"Filter by the `deleted` flag","in":"query","name":"deleted","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"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":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"sid":{"type":"string"},"sync_has_errors":{"type":"boolean"},"sync_id":{"type":"integer","format":"int64"},"sync_products_created":{"type":"integer","format":"int32"},"sync_products_deleted":{"type":"integer","format":"int32"},"sync_products_errored":{"type":"integer","format":"int32"},"sync_products_skipped":{"type":"integer","format":"int32"},"sync_products_total":{"type":"integer","format":"int32"},"sync_products_updated":{"type":"integer","format":"int32"},"sync_started_at":{"type":"string","format":"date-time","description":"The started date-time.","readOnly":true},"sync_stopped_at":{"type":"string","format":"date-time","description":"The stopped date-time.","readOnly":true},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"MerchantView"}},"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":"PageMerchantView"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"get","path":"/merchants","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 Merchants, optionally filtering by the `deleted` flag","type":"text/plain"},"url":{"path":["merchants"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"The maximum number of results","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filter by the `deleted` flag","type":"text/plain"},"key":"deleted","value":""}],"variable":[]},"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 @@ -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 new file mode 100644 index 0000000..bc16b2a --- /dev/null +++ b/docs/api/manager/list-o-auth-2-authorized-clients.api.mdx @@ -0,0 +1,42 @@ +--- +id: list-o-auth-2-authorized-clients +title: "List" +description: "List OAuth2 Authorized Clients" +sidebar_label: "List" +hide_title: true +hide_table_of_contents: true +api: {"description":"List OAuth2 Authorized Clients","operationId":"listOAuth2AuthorizedClients","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"content":{"application/json":{"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":"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"}},"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":"PageOAuth2AuthorizedClient"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"OAuth2":[]}],"tags":["OAuth2 Authorized Clients"],"method":"get","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"}},"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 OAuth2 Authorized Clients","type":"text/plain"},"url":{"path":["oauth2","authorized-clients"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"The maximum number of results","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"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"; + +## List + + + +List OAuth2 Authorized Clients + +
    Query Parameters
    + +Found + +
    Schema
      items object[] required
      + +An array of objects. + +
    • Array [
    • ]
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/list-website-search-1.api.mdx b/docs/api/manager/list-website-search-1.api.mdx new file mode 100644 index 0000000..08912e8 --- /dev/null +++ b/docs/api/manager/list-website-search-1.api.mdx @@ -0,0 +1,42 @@ +--- +id: list-website-search-1 +title: "List Website Search data" +description: "List the Website Search performance data" +sidebar_label: "List Website Search data" +hide_title: true +hide_table_of_contents: true +api: {"description":"List the Website Search performance data","operationId":"listWebsiteSearch_1","parameters":[{"description":"The cursor","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The start date, inclusive, in yyyy-MM-dd format.","in":"query","name":"since","required":true,"schema":{"type":"string"}},{"description":"The end date, inclusive, in yyyy-MM-dd format.","in":"query","name":"until","required":true,"schema":{"type":"string"}},{"description":"The dimensions, e.g. `query`, `page`. Must repeat for each dimension.","in":"query","name":"dimensions","required":true,"schema":{"type":"array","items":{"type":"string"}},"style":"form"},{"description":"If \"all\" (case-insensitive), data will include fresh data. If \"final\" (case-insensitive) or if this parameter is omitted, the returned data will include only finalized data.","in":"query","name":"data_state","required":false,"schema":{"type":"string","enum":["all","final"]}},{"description":"The maximum number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer","default":10,"maximum":25000}}],"responses":{"200":{"content":{"application/json":{"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":"Search Data","properties":{"clicks":{"type":"integer","format":"int32","description":"Number of clicks."},"ctr":{"type":"number","format":"double","description":"CTR."},"id":{"type":"integer","format":"int64","description":"The id: it's now a unique id, but a row index."},"impressions":{"type":"integer","format":"int32","description":"Number of impressions."},"keys":{"type":"array","description":"The keys for the current data, matching the provided `dimensions` in the query.","items":{"type":"string","description":"The keys for the current data, matching the provided `dimensions` in the query."}},"position":{"type":"number","format":"double","description":"Position."},"score":{"type":"number","format":"double","description":"A score to spot traffic opportunities, from 0.0 to 1.0 (the higher the better). The score is based on the traffic data."}},"required":["clicks","ctr","id","impressions","keys","position","score"],"title":"WebsiteSearch"}},"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":"PageWebsiteSearch"}}},"description":"Found"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"tags":["Google Search Console Searches"],"method":"get","path":"/accounts/me/google/searches","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 Website Search data","description":{"content":"List the Website Search performance data","type":"text/plain"},"url":{"path":["accounts","me","google","searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The cursor","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"(Required) The start date, inclusive, in yyyy-MM-dd format.","type":"text/plain"},"key":"since","value":""},{"disabled":false,"description":{"content":"(Required) The end date, inclusive, in yyyy-MM-dd format.","type":"text/plain"},"key":"until","value":""},{"disabled":false,"description":{"content":"(Required) The dimensions, e.g. `query`, `page`. Must repeat for each dimension.","type":"text/plain"},"key":"dimensions","value":""},{"disabled":false,"description":{"content":"If \"all\" (case-insensitive), data will include fresh data. If \"final\" (case-insensitive) or if this parameter is omitted, the returned data will include only finalized data.","type":"text/plain"},"key":"data_state","value":""},{"disabled":false,"description":{"content":"The maximum number of results","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +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"; + +## List Website Search data + + + +List the Website Search performance data + +
    Query Parameters
    + +Found + +
    Schema
      items object[] required
      + +An array of objects. + +
    • Array [
    • ]
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docs/api/manager/o-auth-2-authorized-clients.tag.mdx b/docs/api/manager/o-auth-2-authorized-clients.tag.mdx new file mode 100644 index 0000000..3ceb316 --- /dev/null +++ b/docs/api/manager/o-auth-2-authorized-clients.tag.mdx @@ -0,0 +1,20 @@ +--- +id: o-auth-2-authorized-clients +title: "OAuth2 Authorized Clients" +description: "OAuth2 Authorized Clients" +custom_edit_url: null +--- + + + +Manage OAuth2 Authorized Clients + + + +```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/plugin-diagnostics.tag.mdx b/docs/api/manager/plugin-diagnostics.tag.mdx new file mode 100644 index 0000000..2136894 --- /dev/null +++ b/docs/api/manager/plugin-diagnostics.tag.mdx @@ -0,0 +1,20 @@ +--- +id: plugin-diagnostics +title: "Plugin Diagnostics" +description: "Plugin Diagnostics" +custom_edit_url: null +--- + + + +Update Plugin Diagnostics data for WordPress clients. + + + +```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/redeem-code.api.mdx b/docs/api/manager/redeem-code.api.mdx index bd91ee4..ab7ef9c 100644 --- a/docs/api/manager/redeem-code.api.mdx +++ b/docs/api/manager/redeem-code.api.mdx @@ -5,7 +5,7 @@ description: "Redeem the provided code and get a key" sidebar_label: "Redeem the provided code and get a key" hide_title: true hide_table_of_contents: true -api: {"operationId":"redeemCode","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Merchant request","properties":{"access_token":{"type":"string","description":"Google Merchant access token"},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example \"data\")"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"Google Merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["google_merchant_id","publisher_name","refresh_token","url"],"title":"Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"}},"title":"Response"}}},"description":"Found."},"404":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"object","properties":{"reasonPhrase":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}},"title":"StatusType"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"Problem"}}},"description":"Not Found."},"409":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"object","properties":{"reasonPhrase":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}},"title":"StatusType"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"Problem"}}},"description":"Code already redeemed."},"500":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"object","properties":{"reasonPhrase":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}},"title":"StatusType"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"Problem"}}},"description":"Configuration error."}},"tags":["Redeem Codes"],"description":"Redeem the provided code and get a key","method":"post","path":"/redeem-codes","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":"string","dataset_domain":"string","dataset_name":"string","deleted":false,"google_merchant_id":0,"publisher_name":"string","refresh_token":"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":"Redeem the provided code and get a key","description":{"type":"text/plain"},"url":{"path":["redeem-codes"],"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":"redeemCode","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redeem_code":{"type":"string"}},"title":"Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"}},"title":"Response"}}},"description":"Found."},"404":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"ProblemDetail"}}},"description":"Not Found."},"409":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"ProblemDetail"}}},"description":"Code already redeemed."},"500":{"content":{"application/problem+json":{"schema":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string","format":"uri"}},"title":"ProblemDetail"}}},"description":"Configuration error."}},"tags":["Redeem Codes"],"description":"Redeem the provided code and get a key","method":"post","path":"/redeem-codes","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":{"redeem_code":"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":"Redeem the provided code and get a key","description":{"type":"text/plain"},"url":{"path":["redeem-codes"],"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/manager/manager custom_edit_url: null @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; Redeem the provided code and get a key -
    Request Body required
    +
    Request Body required
    Found. @@ -34,13 +34,13 @@ Found. Not Found. -
    Schema
      parameters object
      status object
    +
    Schema
      properties object
    Code already redeemed. -
    Schema
      parameters object
      status object
    +
    Schema
      properties object
    Configuration error. -
    Schema
      parameters object
      status object
    +
    Schema
      properties object
    \ No newline at end of file diff --git a/docs/api/manager/sidebar.js b/docs/api/manager/sidebar.js index 77f91e3..4b51870 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":"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":"Entities","link":{"type":"doc","id":"api/manager/entities"},"items":[{"type":"doc","id":"api/manager/list-entities","label":"List","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":"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":"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"}]}]; \ 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":"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 diff --git a/docs/api/manager/sitemap-imports.tag.mdx b/docs/api/manager/sitemap-imports.tag.mdx new file mode 100644 index 0000000..9e8d5ba --- /dev/null +++ b/docs/api/manager/sitemap-imports.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sitemap-imports +title: "Sitemap Imports" +description: "Sitemap Imports" +custom_edit_url: null +--- + + + +Import sitemaps to the 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/update-diagnostic-plugin-collection.api.mdx b/docs/api/manager/update-diagnostic-plugin-collection.api.mdx new file mode 100644 index 0000000..cfca95b --- /dev/null +++ b/docs/api/manager/update-diagnostic-plugin-collection.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-diagnostic-plugin-collection +title: "Update" +description: "Replace the list of the plugins for the current account with the one provided by the client" +sidebar_label: "Update" +hide_title: true +hide_table_of_contents: true +api: {"description":"Replace the list of the plugins for the current account with the one provided by the client","operationId":"updateDiagnosticPluginCollection","parameters":[{"in":"query","name":"account","required":true,"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"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Diagnostic Plugin Data Request","properties":{"active":{"type":"boolean","description":"Whether the plugin is active."},"name":{"type":"string","description":"The plugin name."},"version":{"type":"string","description":"The plugin version."}},"title":"DiagnosticPluginRequest"}}}},"required":true},"responses":{"200":{"description":"Found."},"204":{"description":"No Content"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"ApiKey":[]}],"tags":["Plugin Diagnostics"],"method":"put","path":"/accounts/me/plugin/diagnostics/plugins-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":[{"active":true,"name":"string","version":"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":"Replace the list of the plugins for the current account with the one provided by the client","type":"text/plain"},"url":{"path":["accounts","me","plugin","diagnostics","plugins-collection"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"account","value":""}],"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 + + + +Replace the list of the plugins for the current account with the one provided by the client + +
    Query Parameters
    Request Body array required
    • Array [
    • ]
    + +Found. + +
    + +No Content + +
    + +Authentication Failure + +
    + +Not Found + +
    + \ No newline at end of file diff --git a/docs/api/manager/update-include-excludes.api.mdx b/docs/api/manager/update-include-excludes.api.mdx index 0bdba9b..0a76af7 100644 --- a/docs/api/manager/update-include-excludes.api.mdx +++ b/docs/api/manager/update-include-excludes.api.mdx @@ -5,7 +5,7 @@ description: "Update the include and exclude configurations." sidebar_label: "Update" hide_title: true hide_table_of_contents: true -api: {"description":"Update the include and exclude configurations.","operationId":"updateIncludeExcludes","parameters":[{"in":"query","name":"account","required":true,"schema":{"type":"object","properties":{"analyzerId":{"type":"integer","format":"int64"},"country":{"type":"string"},"datasetId":{"type":"string","deprecated":true},"domainUri":{"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"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A request to create an IncludeExclude.","properties":{"Include or Exclude":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"]},"The URL":{"type":"string"}},"required":["Include or Exclude","The URL"],"title":"IncludeExcludeRequest"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Not Found"}},"tags":["Include Excludes (WordPress plugin)"],"method":"put","path":"/accounts/me/include-excludes","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":[{"Include or Exclude":"INCLUDE","The 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":"Update","description":{"content":"Update the include and exclude configurations.","type":"text/plain"},"url":{"path":["accounts","me","include-excludes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"account","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Update the include and exclude configurations.","operationId":"updateIncludeExcludes","parameters":[{"in":"query","name":"account","required":true,"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"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A request to create an IncludeExclude.","properties":{"Include or Exclude":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"]},"The URL":{"type":"string"}},"required":["Include or Exclude","The URL"],"title":"IncludeExcludeRequest"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","format":"int64","readOnly":true,"title":"Account unique identifier"},"flag":{"type":"string","description":"A flag which determines whether the URL is `INCLUDE` or `EXCLUDE`.","enum":["INCLUDE","EXCLUDE"],"title":"Include or Exclude"},"id":{"type":"integer","format":"int64","readOnly":true,"title":"Unique identifier"},"url":{"type":"string","title":"The URL"}},"required":["account_id","flag","url"],"title":"IncludeExclude"}}}},"description":"Not Found"}},"tags":["Include Excludes (WordPress plugin)"],"method":"put","path":"/accounts/me/include-excludes","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":[{"Include or Exclude":"INCLUDE","The 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":"Update","description":{"content":"Update the include and exclude configurations.","type":"text/plain"},"url":{"path":["accounts","me","include-excludes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"account","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/manager/manager custom_edit_url: null @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; Update the include and exclude configurations. -
    Query Parameters
    Request Body array required
    • Array [
    • ]
    +
    Query Parameters
    Request Body array required
    • Array [
    • ]
    Success diff --git a/docs/api/manager/update-merchant.api.mdx b/docs/api/manager/update-merchant.api.mdx index 37b2dac..18935a4 100644 --- a/docs/api/manager/update-merchant.api.mdx +++ b/docs/api/manager/update-merchant.api.mdx @@ -5,7 +5,7 @@ description: "Update a Merchant" sidebar_label: "Update" hide_title: true hide_table_of_contents: true -api: {"description":"Update a Merchant","operationId":"updateMerchant","parameters":[{"description":"The Merchant id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Merchant request","properties":{"access_token":{"type":"string","description":"Google Merchant access token"},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example \"data\")"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"Google Merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["google_merchant_id","publisher_name","refresh_token","url"],"title":"Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"put","path":"/merchants/{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":"string","dataset_domain":"string","dataset_name":"string","deleted":false,"google_merchant_id":0,"publisher_name":"string","refresh_token":"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":"Update","description":{"content":"Update a Merchant","type":"text/plain"},"url":{"path":["merchants",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Merchant 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 Merchant","operationId":"updateMerchant","parameters":[{"description":"The Merchant id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The Merchant request","properties":{"access_token":{"type":"string","description":"Google Merchant access token"},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example \"data\")"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"Google Merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["google_merchant_id","publisher_name","refresh_token","url"],"title":"MerchantRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"A Merchant project.","properties":{"access_token":{"type":"string","description":"The Google merchant access token"},"account_id":{"type":"integer","format":"int64","description":"The account id","readOnly":true},"automatic_synchronization":{"type":"boolean","description":"Whether the Merchant data will be synchronized automatically"},"created_at":{"type":"string","format":"date-time","description":"The create date-time","readOnly":true},"dataset_domain":{"type":"string","description":"The custom domain (for example data.example.org)"},"dataset_name":{"type":"string","description":"The dataset path (for example /data)"},"deleted":{"type":"boolean","default":false,"description":"True if the merchant has been deleted"},"deleted_at":{"type":"string","format":"date-time","description":"The delete date-time","readOnly":true},"google_merchant_id":{"type":"integer","format":"int64","description":"The Google Merchant id"},"id":{"type":"integer","format":"int64","description":"The unique id","readOnly":true},"ignore_brand":{"type":"boolean","description":"Whether to ignore the `brand` property during validation"},"ignore_image":{"type":"boolean","description":"Whether to ignore the `image` property during validation"},"modified_at":{"type":"string","format":"date-time","description":"The last modified date-time","readOnly":true},"publisher_name":{"type":"string","description":"The publisher name (shows in schema publisher)"},"refresh_token":{"type":"string","description":"The Google merchant refresh token"},"url":{"type":"string","description":"The website URL"}},"required":["access_token","deleted","google_merchant_id","publisher_name","refresh_token"],"title":"Merchant"}}},"description":"Success"},"401":{"description":"Authentication Failure"},"404":{"description":"Not Found"}},"security":[{"OAuth2":[]}],"tags":["Merchants"],"method":"put","path":"/merchants/{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":"string","dataset_domain":"string","dataset_name":"string","deleted":false,"google_merchant_id":0,"ignore_brand":true,"ignore_image":true,"publisher_name":"string","refresh_token":"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":"Update","description":{"content":"Update a Merchant","type":"text/plain"},"url":{"path":["merchants",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Merchant 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 @@ -26,11 +26,11 @@ import TabItem from "@theme/TabItem"; Update a Merchant -
    Path Parameters
    Request Body required
    +
    Path Parameters
    Request Body required
    Success -
    Schema
    +
    Schema
    Authentication Failure 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 new file mode 100644 index 0000000..e1497be --- /dev/null +++ b/docs/api/manager/update-o-auth-2-authorized-client.api.mdx @@ -0,0 +1,38 @@ +--- +id: update-o-auth-2-authorized-client +title: "Update" +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":[]}}} +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 a OAuth2 Authorized Client given its client registration id + +
    Path Parameters
    Request Body required
    + +Found + +
    Schema
    + +Authentication Failure + +
    + \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 2710cb3..1cc5217 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -330,6 +330,14 @@ const config = { categoryLinkSource: "tag", }, }, + "fact-check": { + specPath: "api/fact-check.yaml", // path or URL to the OpenAPI spec + outputDir: "docs/api/fact-check", // output directory for generated *.mdx and sidebar.js files + sidebarOptions: { + groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag + categoryLinkSource: "tag", + }, + }, graphql: { specPath: "api/graphql.yaml", // path or URL to the OpenAPI spec outputDir: "docs/api/graphql", // output directory for generated *.mdx and sidebar.js files diff --git a/sidebars.js b/sidebars.js index b7675b8..94e6da4 100644 --- a/sidebars.js +++ b/sidebars.js @@ -110,6 +110,11 @@ const sidebars = { label: "Content Generation", items: require("./docs/api/content-generation/sidebar.js"), }, + { + type: "category", + label: "Fact Check", + items: require("./docs/api/fact-check/sidebar.js"), + }, { type: "category", label: "GraphQL",