diff --git a/generator/konfig-docs/redirects.json b/generator/konfig-docs/redirects.json index 697a9f1d0..019ae8924 100644 --- a/generator/konfig-docs/redirects.json +++ b/generator/konfig-docs/redirects.json @@ -39,6 +39,12 @@ "/sdk/brex/webhooks/": "/sdk/brex/webhooks/typescript/", "/sdk/cornerstone-on-demand/talent-link": "/sdk/cornerstone-on-demand/talent-link/typescript/", "/sdk/cornerstone-on-demand/talent-link/": "/sdk/cornerstone-on-demand/talent-link/typescript/", + "/sdk/customer-io/data-pipelines": "/sdk/customer-io/data-pipelines/typescript/", + "/sdk/customer-io/data-pipelines/": "/sdk/customer-io/data-pipelines/typescript/", + "/sdk/customer-io/journeys-app": "/sdk/customer-io/journeys-app/typescript/", + "/sdk/customer-io/journeys-app/": "/sdk/customer-io/journeys-app/typescript/", + "/sdk/customer-io/journeys-track": "/sdk/customer-io/journeys-track/typescript/", + "/sdk/customer-io/journeys-track/": "/sdk/customer-io/journeys-track/typescript/", "/sdk/cyber-ark/conjur": "/sdk/cyber-ark/conjur/typescript/", "/sdk/cyber-ark/conjur/": "/sdk/cyber-ark/conjur/typescript/", "/sdk/dropbox/sign": "/sdk/dropbox/sign/typescript/", diff --git a/generator/konfig-docs/src/pages/sdk/bulk-sms-com/index.tsx b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/index.tsx new file mode 100644 index 000000000..07dcac91b --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/index.tsx @@ -0,0 +1,81 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "BulkSMS.com", + "numberOfMethods": 15, + "categories": [ + "messaging", + "sms", + "communications", + "sms_api", + "sms_messaging", + "personalised_sms_messaging", + "scheduled_sms_messaging", + "sms_software" + ], + "index": "bulk-sms-com/typescript", + "language": "TypeScript", + "link": "/sdk/bulk-sms-com/typescript/", + "developerDocumentation": "www.bulksms.com/developer/json/v1/#", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" + }, + { + "name": "BulkSMS.com", + "numberOfMethods": 15, + "categories": [ + "messaging", + "sms", + "communications", + "sms_api", + "sms_messaging", + "personalised_sms_messaging", + "scheduled_sms_messaging", + "sms_software" + ], + "index": "bulk-sms-com/python", + "language": "Python", + "link": "/sdk/bulk-sms-com/python/", + "developerDocumentation": "www.bulksms.com/developer/json/v1/#", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" + }, + { + "name": "BulkSMS.com", + "numberOfMethods": 15, + "categories": [ + "messaging", + "sms", + "communications", + "sms_api", + "sms_messaging", + "personalised_sms_messaging", + "scheduled_sms_messaging", + "sms_software" + ], + "index": "bulk-sms-com/java", + "language": "Java", + "link": "/sdk/bulk-sms-com/java/", + "developerDocumentation": "www.bulksms.com/developer/json/v1/#", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" + } +]; + +export default function BulkSmsCom() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_first-request.mdx new file mode 100644 index 000000000..64047ce45 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// List blocked numbers +const listRetrievalResponse = bulkSmsCom.blockedNumbers.listRetrieval() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_getting-started.mdx new file mode 100644 index 000000000..74e09d551 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_getting-started.mdx @@ -0,0 +1,33 @@ +```typescript index.ts +import { BulkSmsCom } from 'bulk-sms-com-typescript-sdk'; + +const bulkSmsCom = new BulkSmsCom({ + /* + * The API uses HTTP Basic Auth for authentication. + * + * You are requested to preemptively provide the `Authorization` header in your requests and not wait until the server has provided a `401 Unauthorized` response. + * + * Doing so will reduce the number of requests required to achieve your goal, which will improve overall performance. + * + * You authenticate using either the username you supplied when you registered with [BulkSMS](https://www.bulksms.com) or with an _API Token_. API tokens can be created by logging into your account and visiting _Settings > Developer Settings > API Tokens_. + * + * __Important:__ + * - Where possible, use an API Token instead of the username and password when writing software against the API. + * + * Whether you use a username or an API Token, the values must be [Base64 encoded](https://en.wikipedia.org/wiki/Base64) before using it in the header. + * For example, if the username is `Aladdin` and the password is `OpenSesame`, the unencoded header value is `Aladdin:OpenSesame`. After encoding, the full header becomes + * + * ``` + * Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l + * ``` + * When using an API token, the value to be encoded will be `:`. These values _before Base64 encoding_ look something like this + * + * ` + * BBDE1B476E03498AA768F66A286AABDC-01-B:9jSbVDK20!MXdfRGiIIFu#ffUE8*S + * ` + * + */ + username: "USERNAME", + password: "PASSWORD" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/index.tsx new file mode 100644 index 000000000..f5d4456b1 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/index.tsx @@ -0,0 +1,566 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function BulkSmsComTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/categories.json b/generator/konfig-docs/src/pages/sdk/categories.json index 2b067bba4..9a004de43 100644 --- a/generator/konfig-docs/src/pages/sdk/categories.json +++ b/generator/konfig-docs/src/pages/sdk/categories.json @@ -68,6 +68,11 @@ { "parentCategory": "Communication", "subCategories": [ + { + "category": "Phone & SMS", + "page": "phone-sms", + "subpath": "/sdk/category/phone-sms" + }, { "category": "Community", "page": "community", @@ -97,11 +102,6 @@ "category": "Video Conferencing", "page": "video-conferencing", "subpath": "/sdk/category/video-conferencing" - }, - { - "category": "Phone & SMS", - "page": "phone-sms", - "subpath": "/sdk/category/phone-sms" } ], "page": "communication", diff --git a/generator/konfig-docs/src/pages/sdk/companies.json b/generator/konfig-docs/src/pages/sdk/companies.json index d93ee7c5d..961630067 100644 --- a/generator/konfig-docs/src/pages/sdk/companies.json +++ b/generator/konfig-docs/src/pages/sdk/companies.json @@ -142,7 +142,7 @@ "collaboration" ], "numberOfApis": 1, - "difficultyScore": 1367.25, + "difficultyScore": 1374.75, "subpath": "/sdk/teamwork" }, { @@ -1905,6 +1905,33 @@ "difficultyScore": 233.5, "subpath": "/sdk/workday" }, + { + "parentCategories": [ + "Marketing" + ], + "subCategories": [ + "Marketing Automation" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/favicon.png", + "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io", + "services": [ + "Data Pipelines", + "Journeys App", + "Journeys Track" + ], + "company": "Customer.io", + "keywords": [ + "marketing", + "big_data_analytics", + "customer_data_platform", + "messaging", + "email", + "automation" + ], + "numberOfApis": 3, + "difficultyScore": 227.83333333333334, + "subpath": "/sdk/customer-io" + }, { "parentCategories": [ "Human Resources" @@ -4436,6 +4463,31 @@ "difficultyScore": 32.42857142857143, "subpath": "/sdk/brex" }, + { + "parentCategories": [ + "Communication" + ], + "subCategories": [ + "Phone & SMS" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/bulksms-com/favicon.png", + "metaDescription": "BulkSMS.com is a leading SMS messaging service provider offering two-way SMS communications. The BulkSMS gateway reaches across borders and connects to over 800 mobile network operators worldwide.", + "services": [], + "company": "BulkSMS.com", + "keywords": [ + "messaging", + "sms", + "communications", + "sms_api", + "sms_messaging", + "personalised_sms_messaging", + "scheduled_sms_messaging", + "sms_software" + ], + "numberOfApis": 1, + "difficultyScore": 30.25, + "subpath": "/sdk/bulk-sms-com" + }, { "parentCategories": [ "Business Intelligence", diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_first-request.mdx new file mode 100644 index 000000000..8bfd9c861 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Identify +const personTraitsAssignmentResponse = customerIoDataPipelines.identification.personTraitsAssignment() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_getting-started.mdx new file mode 100644 index 000000000..89c4f6ac4 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/_getting-started.mdx @@ -0,0 +1,12 @@ +```typescript index.ts +import { CustomerIoDataPipelines } from 'customer-io-data-pipelines-typescript-sdk'; + +const customerIoDataPipelines = new CustomerIoDataPipelines({ + /* + * The Data Pipelines API uses a basic authentication scheme with your API key. Because basic authorization typically expects a username and password combination, you'll use the API Key as the username and leave the password blank—base64 encoding your credentials in the format `API_key:`. + * + */ + username: "USERNAME", + password: "PASSWORD" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/index.tsx new file mode 100644 index 000000000..a5b718327 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/data-pipelines/typescript/index.tsx @@ -0,0 +1,201 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function CustomerIoDataPipelinesTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/index.tsx b/generator/konfig-docs/src/pages/sdk/customer-io/index.tsx new file mode 100644 index 000000000..53c9bc9ad --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/index.tsx @@ -0,0 +1,159 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Data Pipelines", + "numberOfMethods": 7, + "categories": [ + "marketing", + "big_data_analytics", + "customer_data_platform" + ], + "index": "data-pipelines/typescript", + "language": "TypeScript", + "link": "/sdk/customer-io/data-pipelines/typescript/", + "developerDocumentation": "customer.io/docs/api/cdp/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/data-pipelines/openapi.yaml" + }, + { + "name": "Data Pipelines", + "numberOfMethods": 7, + "categories": [ + "marketing", + "big_data_analytics", + "customer_data_platform" + ], + "index": "data-pipelines/python", + "language": "Python", + "link": "/sdk/customer-io/data-pipelines/python/", + "developerDocumentation": "customer.io/docs/api/cdp/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/data-pipelines/openapi.yaml" + }, + { + "name": "Data Pipelines", + "numberOfMethods": 7, + "categories": [ + "marketing", + "big_data_analytics", + "customer_data_platform" + ], + "index": "data-pipelines/java", + "language": "Java", + "link": "/sdk/customer-io/data-pipelines/java/", + "developerDocumentation": "customer.io/docs/api/cdp/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/data-pipelines/openapi.yaml" + }, + { + "name": "Journeys App", + "numberOfMethods": 111, + "categories": [ + "messaging", + "email", + "marketing" + ], + "index": "journeys-app/typescript", + "language": "TypeScript", + "link": "/sdk/customer-io/journeys-app/typescript/", + "developerDocumentation": "customer.io/docs/api/app/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml" + }, + { + "name": "Journeys App", + "numberOfMethods": 111, + "categories": [ + "messaging", + "email", + "marketing" + ], + "index": "journeys-app/python", + "language": "Python", + "link": "/sdk/customer-io/journeys-app/python/", + "developerDocumentation": "customer.io/docs/api/app/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml" + }, + { + "name": "Journeys App", + "numberOfMethods": 111, + "categories": [ + "messaging", + "email", + "marketing" + ], + "index": "journeys-app/java", + "language": "Java", + "link": "/sdk/customer-io/journeys-app/java/", + "developerDocumentation": "customer.io/docs/api/app/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml" + }, + { + "name": "Journeys Track", + "numberOfMethods": 18, + "categories": [ + "automation", + "marketing", + "messaging" + ], + "index": "journeys-track/typescript", + "language": "TypeScript", + "link": "/sdk/customer-io/journeys-track/typescript/", + "developerDocumentation": "customer.io/docs/api/track/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml" + }, + { + "name": "Journeys Track", + "numberOfMethods": 18, + "categories": [ + "automation", + "marketing", + "messaging" + ], + "index": "journeys-track/python", + "language": "Python", + "link": "/sdk/customer-io/journeys-track/python/", + "developerDocumentation": "customer.io/docs/api/track/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml" + }, + { + "name": "Journeys Track", + "numberOfMethods": 18, + "categories": [ + "automation", + "marketing", + "messaging" + ], + "index": "journeys-track/java", + "language": "Java", + "link": "/sdk/customer-io/journeys-track/java/", + "developerDocumentation": "customer.io/docs/api/track/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml" + } +]; + +export default function CustomerIo() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_first-request.mdx new file mode 100644 index 000000000..2dfb2fa29 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Trigger a broadcast +const triggerBroadcastResponse = customerIoJourneysApp.sendMessages.triggerBroadcast() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_getting-started.mdx new file mode 100644 index 000000000..7afd7afb6 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/_getting-started.mdx @@ -0,0 +1,13 @@ +```typescript index.ts +import { CustomerIoJourneysApp } from 'customer-io-journeys-app-typescript-sdk'; + +const customerIoJourneysApp = new CustomerIoJourneysApp({ + /* + * The App API uses a bearer authentication scheme. + * + * You can generate a bearer token, known as an **App API Key**, with a defined scope in [your account settings](https://fly.customer.io/settings/api_credentials?keyType=app). [Learn more about bearer authorization in Customer.io](https://customer.io/docs/api/app/). + * + */ + bearerAuth: "BEARER_AUTH" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/index.tsx new file mode 100644 index 000000000..e13c05ee2 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-app/typescript/index.tsx @@ -0,0 +1,3454 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function CustomerIoJourneysAppTypeScriptSdk() { + return ( + {{ content }}" + }, + { + "name": "body", + "schema": "string", + "description": "", + "example": "Hello from the API" + }, + { + "name": "body_amp", + "schema": "string", + "description": "" + }, + { + "name": "language", + "schema": "string", + "description": "", + "example": "fr" + }, + { + "name": "type", + "schema": "string", + "description": "", + "example": "email" + }, + { + "name": "from", + "schema": "string", + "description": "", + "example": "sentFrom@example.com" + }, + { + "name": "from_id", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "reply_to", + "schema": "string", + "description": "", + "example": "replyto@example.com" + }, + { + "name": "reply_to_id", + "schema": "integer", + "description": "", + "example": 38 + }, + { + "name": "preprocessor", + "schema": "string", + "description": "" + }, + { + "name": "recipient", + "schema": "string", + "description": "", + "example": "{{customer.email}}" + }, + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Did you get that thing I sent you?" + }, + { + "name": "bcc", + "schema": "string", + "description": "" + }, + { + "name": "fake_bcc", + "schema": "boolean", + "description": "" + }, + { + "name": "preheader_text", + "schema": "string", + "description": "" + }, + { + "name": "headers", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request is malformed." + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/language/{language}", + "method": "getTranslation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get a translation of a newsletter variant", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The `language` does not exist." + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/language/{language}", + "method": "updateTranslation", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Update a translation of a newsletter variant", + "parameters": [ + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "newsletter_id", + "schema": "integer", + "description": "", + "example": 10 + }, + { + "name": "deduplicate_id", + "schema": "string", + "description": "", + "example": "15:1492548073" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "newsletter variant A" + }, + { + "name": "layout", + "schema": "string", + "description": "", + "example": "{{ content }}" + }, + { + "name": "body", + "schema": "string", + "description": "", + "example": "Hello from the API" + }, + { + "name": "body_amp", + "schema": "string", + "description": "" + }, + { + "name": "language", + "schema": "string", + "description": "", + "example": "fr" + }, + { + "name": "type", + "schema": "string", + "description": "", + "example": "email" + }, + { + "name": "from", + "schema": "string", + "description": "", + "example": "sentFrom@example.com" + }, + { + "name": "from_id", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "reply_to", + "schema": "string", + "description": "", + "example": "replyto@example.com" + }, + { + "name": "reply_to_id", + "schema": "integer", + "description": "", + "example": 38 + }, + { + "name": "preprocessor", + "schema": "string", + "description": "" + }, + { + "name": "recipient", + "schema": "string", + "description": "", + "example": "{{customer.email}}" + }, + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Did you get that thing I sent you?" + }, + { + "name": "bcc", + "schema": "string", + "description": "" + }, + { + "name": "fake_bcc", + "schema": "boolean", + "description": "" + }, + { + "name": "preheader_text", + "schema": "string", + "description": "" + }, + { + "name": "headers", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The `language` does not exist." + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/test_groups", + "method": "listTestGroups", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "List A/B test groups in a newsletter", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/test_group/{test_group_id}/language/{language}", + "method": "getTranslationInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get a translation in a newsletter test group", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The `language` does not exist." + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/test_group/{test_group_id}/language/{language}", + "method": "updateTranslation", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Update a translation in a newsletter test group", + "parameters": [ + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "newsletter_id", + "schema": "integer", + "description": "", + "example": 10 + }, + { + "name": "deduplicate_id", + "schema": "string", + "description": "", + "example": "15:1492548073" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "newsletter variant A" + }, + { + "name": "layout", + "schema": "string", + "description": "", + "example": "{{ content }}" + }, + { + "name": "body", + "schema": "string", + "description": "", + "example": "Hello from the API" + }, + { + "name": "body_amp", + "schema": "string", + "description": "" + }, + { + "name": "language", + "schema": "string", + "description": "", + "example": "fr" + }, + { + "name": "type", + "schema": "string", + "description": "", + "example": "email" + }, + { + "name": "from", + "schema": "string", + "description": "", + "example": "sentFrom@example.com" + }, + { + "name": "from_id", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "reply_to", + "schema": "string", + "description": "", + "example": "replyto@example.com" + }, + { + "name": "reply_to_id", + "schema": "integer", + "description": "", + "example": 38 + }, + { + "name": "preprocessor", + "schema": "string", + "description": "" + }, + { + "name": "recipient", + "schema": "string", + "description": "", + "example": "{{customer.email}}" + }, + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Did you get that thing I sent you?" + }, + { + "name": "bcc", + "schema": "string", + "description": "" + }, + { + "name": "fake_bcc", + "schema": "boolean", + "description": "" + }, + { + "name": "preheader_text", + "schema": "string", + "description": "" + }, + { + "name": "headers", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The `language` does not exist." + }, + { + "statusCode": "404", + "description": "The newsletter or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics", + "method": "getVariantMetrics", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get metrics for a variant", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The newsletter and/or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics/links", + "method": "getNewsletterVariantLinkMetrics", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get newsletter variant link metrics", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The newsletter and/or variant does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/object_types", + "method": "getAllObjectTypes", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Objects", + "typeScriptTag": "objects", + "description": "List object types", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/objects", + "method": "findObjectsFilter", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Objects", + "typeScriptTag": "objects", + "description": "Find objects", + "parameters": [ + { + "name": "start", + "schema": "string", + "required": false, + "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results." + }, + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The maximum number of results you want to retrieve per page." + }, + { + "name": "object_type_id", + "schema": "string", + "required": true, + "description": "", + "example": "1" + }, + { + "name": "filter", + "schema": "undefined", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/objects/{object_type_id}/{object_id}/relationships", + "method": "getObjectRelationships", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Objects", + "typeScriptTag": "objects", + "description": "Get Object Relationships", + "parameters": [ + { + "name": "objectTypeId", + "schema": "integer", + "required": true, + "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type.", + "example": 1 + }, + { + "name": "objectId", + "schema": "string", + "required": true, + "description": "The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`.", + "example": "abc123" + }, + { + "name": "start", + "schema": "string", + "required": false, + "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results." + }, + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The maximum number of results you want to retrieve per page." + }, + { + "name": "idType", + "schema": "string", + "required": false, + "description": "", + "default": "object_id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/objects/{object_type_id}/{object_id}/attributes", + "method": "getAttributes", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Objects", + "typeScriptTag": "objects", + "description": "Get Object Attributes", + "parameters": [ + { + "name": "objectTypeId", + "schema": "integer", + "required": true, + "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type.", + "example": 1 + }, + { + "name": "objectId", + "schema": "string", + "required": true, + "description": "The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`.", + "example": "abc123" + }, + { + "name": "idType", + "schema": "string", + "required": false, + "description": "", + "default": "object_id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/reporting_webhooks", + "method": "listReportingWebhooks", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Reporting Webhooks", + "typeScriptTag": "reportingWebhooks", + "description": "List reporting webhooks", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/reporting_webhooks", + "method": "createWebhookConfig", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Reporting Webhooks", + "typeScriptTag": "reportingWebhooks", + "description": "Create a reporting webhook", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "my cool webhook" + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "", + "example": 4 + }, + { + "name": "endpoint", + "schema": "string", + "required": true, + "description": "", + "example": "http://example.com/webhook" + }, + { + "name": "disabled", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "full_resolution", + "schema": "boolean", + "required": false, + "description": "", + "example": true, + "default": false + }, + { + "name": "with_content", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "events", + "schema": "array", + "required": true, + "description": "", + "example": [ + "email_failed", + "webhook_failed" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request was malformed." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/reporting_webhooks/{webhook_id}", + "method": "deleteWebhookConfiguration", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Reporting Webhooks", + "typeScriptTag": "reportingWebhooks", + "description": "Delete a reporting webhook", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "A successful request has no response." + }, + { + "statusCode": "404", + "description": "The webhook ID does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/reporting_webhooks/{webhook_id}", + "method": "getWebhookInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Reporting Webhooks", + "typeScriptTag": "reportingWebhooks", + "description": "Get a reporting webhook", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The webhook ID does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/reporting_webhooks/{webhook_id}", + "method": "updateConfiguration", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Reporting Webhooks", + "typeScriptTag": "reportingWebhooks", + "description": "Update a webhook configuration", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "my cool webhook" + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "", + "example": 4 + }, + { + "name": "endpoint", + "schema": "string", + "required": true, + "description": "", + "example": "http://example.com/webhook" + }, + { + "name": "disabled", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "full_resolution", + "schema": "boolean", + "required": false, + "description": "", + "example": true, + "default": false + }, + { + "name": "with_content", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "events", + "schema": "array", + "required": true, + "description": "", + "example": [ + "email_failed", + "webhook_failed" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request was malformed." + }, + { + "statusCode": "404", + "description": "The webhook ID does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "List segments", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments", + "method": "createManualSegment", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "Create a manual segment", + "parameters": [ + { + "name": "segment", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request was malformed." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments/{segment_id}", + "method": "deleteManualSegment", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "Delete a segment", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "The segment is deleted." + }, + { + "statusCode": "404", + "description": "The `segment_id` does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments/{segment_id}", + "method": "getSegmentInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "Get a segment", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The `segment_id` does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments/{segment_id}/used_by", + "method": "getDependencies", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "Get a segment's dependencies", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The `segment_id` does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments/{segment_id}/customer_count", + "method": "getCustomerCount", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "Get a segment customer count", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The `segment_id` does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/segments/{segment_id}/membership", + "method": "listMembership", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Segments", + "typeScriptTag": "segments", + "description": "List customers in a segment", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The `segment_id` does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/sender_identities", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sender Identities", + "typeScriptTag": "senderIdentities", + "description": "List sender identities", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/sender_identities/{sender_id}", + "method": "getSenderInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sender Identities", + "typeScriptTag": "senderIdentities", + "description": "Get a sender", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The sender does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/sender_identities/{sender_id}/used_by", + "method": "getUsageData", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sender Identities", + "typeScriptTag": "senderIdentities", + "description": "Get sender usage data", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The sender does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/snippets", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Snippets", + "typeScriptTag": "snippets", + "description": "List snippets", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/v1/snippets", + "method": "createOrUpdate", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Snippets", + "typeScriptTag": "snippets", + "description": "Create or update snippets", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "value", + "schema": "string", + "required": true, + "description": "", + "example": "VALUE" + }, + { + "name": "updated_at", + "schema": "integer", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request is malformed." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/snippets/{snippet_name}", + "method": "removeSnippet", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Snippets", + "typeScriptTag": "snippets", + "description": "Delete a snippet", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "A successful delete operation returns no content." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "The snippet does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/subscription_topics", + "method": "listTopics", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Subscription Center", + "typeScriptTag": "subscriptionCenter", + "description": "List subscription topics", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional", + "method": "listMessages", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "List transactional messages", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}", + "method": "getMessageInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Get a transactional message", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The transactional message does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/contents", + "method": "listContentVariants", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "List all variants of a transactional message", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "The `transactional_id` or `content_id` in your request do not exist." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/content/{content_id}", + "method": "updateMessageContent", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Update a transactional message", + "parameters": [ + { + "name": "id", + "schema": "integer", + "description": "", + "example": 96 + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "Receipt" + }, + { + "name": "created", + "schema": "integer", + "description": "", + "example": 1552341937 + }, + { + "name": "updated", + "schema": "integer", + "description": "", + "example": 1552341937 + }, + { + "name": "body", + "schema": "string", + "description": "" + }, + { + "name": "language", + "schema": "string", + "description": "", + "example": "fr" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "from", + "schema": "string", + "description": "", + "example": "sentFrom@example.com" + }, + { + "name": "from_id", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "reply_to", + "schema": "string", + "description": "", + "example": "replyto@example.com" + }, + { + "name": "reply_to_id", + "schema": "integer", + "description": "", + "example": 38 + }, + { + "name": "preprocessor", + "schema": "string", + "description": "" + }, + { + "name": "recipient", + "schema": "string", + "description": "", + "example": "{{customer.email}}" + }, + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Did you get that thing I sent you?" + }, + { + "name": "bcc", + "schema": "string", + "description": "" + }, + { + "name": "fake_bcc", + "schema": "boolean", + "description": "" + }, + { + "name": "preheader_text", + "schema": "string", + "description": "" + }, + { + "name": "headers", + "schema": "array", + "description": "" + }, + { + "name": "body_amp", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "The `transactional_id` or `content_id` in your request do not exist" + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/language/{language}", + "method": "getMessageTranslation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Get a translation of a transactional message", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The `language` in your request does not exist." + }, + { + "statusCode": "404", + "description": "The transactional message does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/language/{language}", + "method": "updateTranslation", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Update a translation of a transactional message", + "parameters": [ + { + "name": "id", + "schema": "integer", + "description": "", + "example": 96 + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "Receipt" + }, + { + "name": "created", + "schema": "integer", + "description": "", + "example": 1552341937 + }, + { + "name": "updated", + "schema": "integer", + "description": "", + "example": 1552341937 + }, + { + "name": "body", + "schema": "string", + "description": "" + }, + { + "name": "language", + "schema": "string", + "description": "", + "example": "fr" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "from", + "schema": "string", + "description": "", + "example": "sentFrom@example.com" + }, + { + "name": "from_id", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "reply_to", + "schema": "string", + "description": "", + "example": "replyto@example.com" + }, + { + "name": "reply_to_id", + "schema": "integer", + "description": "", + "example": 38 + }, + { + "name": "preprocessor", + "schema": "string", + "description": "" + }, + { + "name": "recipient", + "schema": "string", + "description": "", + "example": "{{customer.email}}" + }, + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Did you get that thing I sent you?" + }, + { + "name": "bcc", + "schema": "string", + "description": "" + }, + { + "name": "fake_bcc", + "schema": "boolean", + "description": "" + }, + { + "name": "preheader_text", + "schema": "string", + "description": "" + }, + { + "name": "headers", + "schema": "array", + "description": "" + }, + { + "name": "body_amp", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/metrics", + "method": "getMessageMetrics", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Get transactional message metrics", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The transactional message you requested does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/metrics/links", + "method": "getMessageLinkMetrics", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Get transactional message link metrics", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The transactional message you requested does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/transactional/{transactional_id}/messages", + "method": "getMessageDeliveries", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactional", + "typeScriptTag": "transactional", + "description": "Get transactional message deliveries", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "The transactional message you requested does not exist." + }, + { + "statusCode": "429", + "description": "Your request is over the 10-per-second limit." + } + ] + }, + { + "url": "/v1/workspaces", + "method": "listWorkspaces", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Workspaces", + "typeScriptTag": "workspaces", + "description": "List workspaces", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + } +] + } + language="TypeScript" + apiTitle="Journeys App API" + apiBaseUrl="https://api.customer.io" + apiVersion="1.0.0" + endpoints={91} + sdkMethods={268} + schemas={439} + parameters={143} + difficulty="Hard" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml" + developerDocumentation="customer.io/docs/api/app/" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_first-request.mdx new file mode 100644 index 000000000..a723e3a99 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Find your account region +const findAccountRegionResponse = customerIoJourneysTrack.trackRegion.findAccountRegion() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_getting-started.mdx new file mode 100644 index 000000000..d1d73f173 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/_getting-started.mdx @@ -0,0 +1,14 @@ +```typescript index.ts +import { CustomerIoJourneysTrack } from 'customer-io-journeys-track-typescript-sdk'; + +const customerIoJourneysTrack = new CustomerIoJourneysTrack({ + /* + * The Track API uses a basic authentication scheme. Your credentials are your **Site ID** and your **API key**, **Base-64 encoded** in the format `site_id:api_key`. + * + * You can find your Site ID and API key on the [Track API Keys page](https://fly.customer.io/settings/api_credentials). + * + */ + username: "USERNAME", + password: "PASSWORD" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/index.tsx new file mode 100644 index 000000000..47006805e --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/customer-io/journeys-track/typescript/index.tsx @@ -0,0 +1,560 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function CustomerIoJourneysTrackTypeScriptSdk() { + return ( + *Forms* page). Use a value that makes sense to you, or something that you can trace to your backend system.", + "example": "FORM_ID" + }, + { + "name": "data", + "schema": "undefined", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful requests do not return anything." + }, + { + "statusCode": "400", + "description": "" + } + ] + }, + { + "url": "/api/v1/merge_customers", + "method": "mergePeople", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Track Customers", + "typeScriptTag": "trackCustomers", + "description": "Merge duplicate people", + "parameters": [ + { + "name": "primary", + "schema": "undefined", + "required": true, + "description": "" + }, + { + "name": "secondary", + "schema": "undefined", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A successful request returns an empty object response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + } + ] + }, + { + "url": "/api/v1/metrics", + "method": "reportMetrics", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Track Events", + "typeScriptTag": "trackEvents", + "description": "Report metrics", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "The request was received." + } + ] + }, + { + "url": "/api/v1/push/events", + "method": "reportPushMetrics", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Track Events", + "typeScriptTag": "trackEvents", + "description": "Report push metrics", + "parameters": [ + { + "name": "delivery_id", + "schema": "string", + "description": "", + "example": "RPILAgUBcRhIBqSfeiIwdIYJKxTY" + }, + { + "name": "event", + "schema": "string", + "description": "" + }, + { + "name": "device_id", + "schema": "string", + "description": "", + "example": "CIO-Delivery-Token from the notification" + }, + { + "name": "timestamp", + "schema": "integer", + "description": "", + "example": 1613063089 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "The request was received." + } + ] + }, + { + "url": "/api/v1/segments/{segment_id}/add_customers", + "method": "addCustomersToManualSegment", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Track Segments", + "typeScriptTag": "trackSegments", + "description": "Add people to a manual segment", + "parameters": [ + { + "name": "ids", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A successful request returns an empty object response." + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/v1/segments/{segment_id}/remove_customers", + "method": "removeCustomers", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Track Segments", + "typeScriptTag": "trackSegments", + "description": "Remove people from a manual segment", + "parameters": [ + { + "name": "ids", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A successful request returns an empty object response." + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/v2/entity", + "method": "createEntity", + "httpMethod": HttpMethodsEnum.POST, + "tag": "track_v2", + "typeScriptTag": "trackV2", + "description": "Make a single request", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "A successful request returns an empty object response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + } + ] + }, + { + "url": "/api/v2/batch", + "method": "sendMultipleRequests", + "httpMethod": HttpMethodsEnum.POST, + "tag": "track_v2", + "typeScriptTag": "trackV2", + "description": "Send multiple requests", + "parameters": [ + { + "name": "batch", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A successful request returns an empty object response." + }, + { + "statusCode": "207", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unauthorized request. Make sure that you provided the right credentials." + } + ] + } +] + } + language="TypeScript" + apiTitle="Journeys Track API" + apiBaseUrl="https://track.customer.io" + apiVersion="1.0.0" + endpoints={17} + sdkMethods={26} + schemas={236} + parameters={23} + difficulty="Medium" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml" + developerDocumentation="customer.io/docs/api/track/" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/peach-payments/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/peach-payments/typescript/index.tsx index 5195154b5..ad8d1a5c1 100644 --- a/generator/konfig-docs/src/pages/sdk/peach-payments/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/peach-payments/typescript/index.tsx @@ -21,7 +21,7 @@ Peach Payments currently powers businesses in South Africa, Kenya and Mauritius. companyKebabCase="peach-payments" clientNameCamelCase="peachPayments" homepage="www.peachpayments.com/" - lastUpdated={new Date("2024-03-28T19:01:23.743Z")} + lastUpdated={new Date("2024-03-28T20:41:27.489Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/favicon.png" contactUrl="https://support.peachpayments.com/support/home" contactEmail="support@peachpayments.com" @@ -2106,7 +2106,7 @@ Peach Payments currently powers businesses in South Africa, Kenya and Mauritius. sdkMethods={21} schemas={92} parameters={221} - difficulty="Easy" + difficulty="Medium" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/peach-payments/openapi.yaml" developerDocumentation="developer.peachpayments.com/reference" diff --git a/generator/konfig-docs/src/pages/sdk/sdk-links.json b/generator/konfig-docs/src/pages/sdk/sdk-links.json index 1d9d239ff..9129a3282 100644 --- a/generator/konfig-docs/src/pages/sdk/sdk-links.json +++ b/generator/konfig-docs/src/pages/sdk/sdk-links.json @@ -11,6 +11,25 @@ "subCategory": "Developer Tools", "apiVersion": "1.1.0" }, + { + "index": "bulk-sms-com/typescript", + "link": "/sdk/bulk-sms-com/typescript/", + "homepage": "www.bulksms.com/", + "categories": [ + "messaging", + "sms", + "communications", + "sms_api", + "sms_messaging", + "personalised_sms_messaging", + "scheduled_sms_messaging", + "sms_software" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/bulksms-com/favicon.png", + "parentCategory": "Communication", + "subCategory": "Phone & SMS", + "apiVersion": "1.0.0" + }, { "index": "flickr/typescript", "link": "/sdk/flickr/typescript/", @@ -1036,6 +1055,48 @@ "subCategory": "Customer Appreciation", "apiVersion": "3.0" }, + { + "index": "customer-io/data-pipelines/typescript", + "link": "/sdk/customer-io/data-pipelines/typescript/", + "homepage": "customer.io/", + "categories": [ + "marketing", + "big_data_analytics", + "customer_data_platform" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/favicon.png", + "parentCategory": "Marketing", + "subCategory": "Marketing Automation", + "apiVersion": "1.0.0" + }, + { + "index": "customer-io/journeys-app/typescript", + "link": "/sdk/customer-io/journeys-app/typescript/", + "homepage": "customer.io", + "categories": [ + "messaging", + "email", + "marketing" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/favicon.png", + "parentCategory": "Marketing", + "subCategory": "Marketing Automation", + "apiVersion": "1.0.0" + }, + { + "index": "customer-io/journeys-track/typescript", + "link": "/sdk/customer-io/journeys-track/typescript/", + "homepage": "customer.io", + "categories": [ + "automation", + "marketing", + "messaging" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/favicon.png", + "parentCategory": "Marketing", + "subCategory": "Marketing Automation", + "apiVersion": "1.0.0" + }, { "index": "cyber-ark/conjur/typescript", "link": "/sdk/cyber-ark/conjur/typescript/", diff --git a/generator/konfig-docs/src/pages/sdk/teamwork/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/teamwork/typescript/index.tsx index cda1b5f06..2af4308b5 100644 --- a/generator/konfig-docs/src/pages/sdk/teamwork/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/teamwork/typescript/index.tsx @@ -21,7 +21,7 @@ Learn more at teamwork.com.`} companyKebabCase="teamwork" clientNameCamelCase="teamwork" homepage="teamwork.com" - lastUpdated={new Date("2024-03-27T21:04:44.911Z")} + lastUpdated={new Date("2024-03-28T21:25:19.896Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/teamwork/favicon.png" // Missing contactUrl // Missing contactEmail @@ -49,7 +49,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -61,7 +61,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -140,12 +140,12 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -264,7 +264,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -402,7 +402,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -414,7 +414,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -454,7 +454,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -577,7 +577,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -662,7 +662,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -747,7 +747,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -832,7 +832,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -851,7 +851,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -894,7 +894,7 @@ Learn more at teamwork.com.`} { "name": "createdAfterDate", "schema": "string", - "description": "filter by created after date (https://apidocs.teamwork.com/" + "description": "filter by created after date (deprecated, use createdAfter)" }, { "name": "createdAfter", @@ -923,6 +923,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "order by custom field id when orderBy is equal to customfield" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -1204,12 +1209,12 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -1321,7 +1326,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -1459,7 +1464,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -1471,7 +1476,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -1486,7 +1491,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -1529,7 +1534,7 @@ Learn more at teamwork.com.`} { "name": "createdAfterDate", "schema": "string", - "description": "filter by created after date (https://apidocs.teamwork.com/" + "description": "filter by created after date (deprecated, use createdAfter)" }, { "name": "createdAfter", @@ -1565,6 +1570,11 @@ Learn more at teamwork.com.`} "description": "", "example": 0 }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -1782,7 +1792,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -1827,6 +1837,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by company id" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -1924,7 +1939,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -1936,7 +1951,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -1976,7 +1991,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -2010,7 +2025,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -2022,7 +2037,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2060,7 +2075,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2107,7 +2122,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -2167,6 +2182,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -2319,7 +2339,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -2331,7 +2351,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2354,7 +2374,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -2366,7 +2386,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2429,6 +2449,11 @@ Learn more at teamwork.com.`} "description": "", "example": 0 }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -2535,7 +2560,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2575,7 +2600,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -2619,7 +2644,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -2788,7 +2813,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -2803,7 +2828,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -2813,7 +2838,7 @@ Learn more at teamwork.com.`} { "name": "searchTerm", "schema": "string", - "description": "filter by comment content (https://apidocs.teamwork.com/" + "description": "filter by comment content (like v1 filterText param)" }, { "name": "publishedStartDate", @@ -2908,7 +2933,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3196,7 +3221,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3236,7 +3261,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3259,7 +3284,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "403", @@ -3267,7 +3292,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3298,7 +3323,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3338,7 +3363,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -3373,7 +3398,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3409,7 +3434,7 @@ Learn more at teamwork.com.`} "httpMethod": HttpMethodsEnum.GET, "tag": "Activity", "typeScriptTag": "activity", - "description": "Latest activity (https://apidocs.teamwork.com/", + "description": "Latest activity (all projects)", "parameters": [ { "name": "updatedAfter", @@ -3424,7 +3449,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/" + "description": "sort by (deprecated, use orderBy)" }, { "name": "projectStatus", @@ -3449,7 +3474,7 @@ Learn more at teamwork.com.`} { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -3598,7 +3623,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -3748,7 +3773,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -3760,7 +3785,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3800,7 +3825,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3839,7 +3864,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3874,7 +3899,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3913,7 +3938,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -3936,7 +3961,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -3948,7 +3973,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -4397,7 +4422,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -4416,7 +4441,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -4459,7 +4484,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -4469,7 +4494,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -4518,7 +4543,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -4578,7 +4603,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -4675,7 +4700,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -4805,7 +4830,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -4848,7 +4873,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -4858,7 +4883,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -4914,7 +4939,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -4974,7 +4999,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -5071,7 +5096,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -5191,7 +5216,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5206,7 +5231,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -5244,7 +5269,7 @@ Learn more at teamwork.com.`} { "name": "createdAfterDate", "schema": "string", - "description": "filter by created after date (https://apidocs.teamwork.com/" + "description": "filter by created after date (deprecated, use createdAfter)" }, { "name": "createdAfter", @@ -5414,7 +5439,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5437,7 +5462,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -5449,7 +5474,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5464,7 +5489,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -5551,7 +5576,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5637,7 +5662,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5672,7 +5697,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5713,7 +5738,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5736,7 +5761,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -5748,7 +5773,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5771,7 +5796,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -5783,7 +5808,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5806,7 +5831,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -5818,7 +5843,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5859,7 +5884,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5907,7 +5932,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -5954,13 +5979,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -6028,7 +6053,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -6149,7 +6174,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/", + "description": "sort by (deprecated, use orderBy)", "default": "name" }, { @@ -6276,7 +6301,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -6299,7 +6324,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -6311,7 +6336,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -6365,13 +6390,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -6439,7 +6464,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -6682,13 +6707,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -6706,6 +6731,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -6877,7 +6907,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -7127,7 +7157,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -7278,7 +7308,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -7696,13 +7726,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -7720,6 +7750,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -7891,7 +7926,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -8038,13 +8073,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -8163,13 +8198,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -8187,6 +8222,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -8358,7 +8398,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -8616,7 +8656,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by project health (https://apidocs.teamwork.com/" + "description": "filter by project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -8786,7 +8826,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by project health (https://apidocs.teamwork.com/" + "description": "filter by project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -8917,13 +8957,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -8941,6 +8981,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -9112,7 +9157,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -9220,7 +9265,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -9243,7 +9288,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -9255,7 +9300,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -9296,6 +9341,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -9393,7 +9443,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -9405,7 +9455,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -9445,7 +9495,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -9479,7 +9529,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -9491,7 +9541,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -9529,7 +9579,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -9576,7 +9626,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -9673,7 +9723,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/" + "description": "sort by (deprecated, use orderBy)" }, { "name": "projectStatus", @@ -9705,7 +9755,7 @@ Learn more at teamwork.com.`} { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -9854,7 +9904,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -9897,7 +9947,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -9907,7 +9957,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -9963,7 +10013,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -10023,7 +10073,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -10120,7 +10170,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -10345,13 +10395,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -10425,7 +10475,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -10581,13 +10631,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -10655,7 +10705,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -10724,7 +10774,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by risks updated after specified date (https://apidocs.teamwork.com/" + "description": "filter by risks updated after specified date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -10734,12 +10784,12 @@ Learn more at teamwork.com.`} { "name": "sortOrder", "schema": "string", - "description": "sort order (https://apidocs.teamwork.com/" + "description": "sort order (deprecated, use orderMode)" }, { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/" + "description": "sort by (deprecated, use orderBy)" }, { "name": "searchTerm", @@ -10953,7 +11003,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -10965,7 +11015,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -11000,7 +11050,7 @@ Learn more at teamwork.com.`} { "name": "status", "schema": "string", - "description": "project status (https://apidocs.teamwork.com/" + "description": "project status (deprecated, use projectStatuses)" }, { "name": "projectStatus", @@ -11048,7 +11098,7 @@ Learn more at teamwork.com.`} { "name": "matchAllTags", "schema": "boolean", - "description": "enforce all tag ids must be matched (https://apidocs.teamwork.com/" + "description": "enforce all tag ids must be matched (deprecated, use matchAllProjectTags)" }, { "name": "matchAllProjectTags", @@ -11073,7 +11123,7 @@ Learn more at teamwork.com.`} { "name": "applyTaskAssigneeUsersToSince", "schema": "boolean", - "description": "the since section will only use taskAssigneeUserIds if this flag is true\n(https://apidocs.teamwork.com/" + "description": "the since section will only use taskAssigneeUserIds if this flag is true\n(keeps backward compatibility)" }, { "name": "applySinceOnUnread", @@ -11124,7 +11174,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "project health (https://apidocs.teamwork.com/\n\n0: not set\n1: bad\n2: ok\n3: good" + "description": "project health (deprecated, use projectHealths)\n\n0: not set\n1: bad\n2: ok\n3: good" }, { "name": "projectCompanyIds", @@ -11144,12 +11194,12 @@ Learn more at teamwork.com.`} { "name": "health", "schema": "array", - "description": "project healths (https://apidocs.teamwork.com/\n\n0: not set\n1: bad\n2: ok\n3: good" + "description": "project healths (deprecated, use projectHealths)\n\n0: not set\n1: bad\n2: ok\n3: good" }, { "name": "filterTagIds", "schema": "array", - "description": "filter by project tag ids (https://apidocs.teamwork.com/" + "description": "filter by project tag ids (deprecated, use projectTagIds)" }, { "name": "fields[unread]", @@ -11199,7 +11249,7 @@ Learn more at teamwork.com.`} { "name": "companyIds", "schema": "array", - "description": "filter by company ids (https://apidocs.teamwork.com/" + "description": "filter by company ids (deprecated, use projectCompanyIds)" }, { "name": "assigneeUserIds", @@ -11278,6 +11328,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "sortActiveListsFirst", "schema": "boolean", @@ -11459,6 +11514,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by project" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "onlyCompletedTasks", "schema": "boolean", @@ -11577,7 +11637,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -11653,6 +11713,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by project" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "onlyCompletedTasks", "schema": "boolean", @@ -11771,7 +11836,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -11847,6 +11912,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by project" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "onlyCompletedTasks", "schema": "boolean", @@ -11965,7 +12035,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -12041,6 +12111,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by project" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "onlyCompletedTasks", "schema": "boolean", @@ -12159,7 +12234,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -12347,6 +12422,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -12923,7 +13003,7 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", @@ -12935,7 +13015,7 @@ Learn more at teamwork.com.`} { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -13047,7 +13127,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -13243,7 +13323,7 @@ Learn more at teamwork.com.`} { "name": "userId", "schema": "integer", - "description": "filter by user id (https://apidocs.teamwork.com/" + "description": "filter by user id (deprecated, use assignedToUserIds)" }, { "name": "tasklistId", @@ -13253,7 +13333,7 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", @@ -13296,7 +13376,7 @@ Learn more at teamwork.com.`} { "name": "userIds", "schema": "array", - "description": "filter by user ids (https://apidocs.teamwork.com/" + "description": "filter by user ids (deprecated, use assignedToUserIds)" }, { "name": "taskIds", @@ -13456,12 +13536,12 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -13573,7 +13653,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -13772,13 +13852,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -13796,6 +13876,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -13967,7 +14052,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -14063,7 +14148,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -14155,13 +14240,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -14179,6 +14264,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -14350,7 +14440,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -14446,7 +14536,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -14538,13 +14628,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -14562,6 +14652,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -14733,7 +14828,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -14829,7 +14924,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -14921,13 +15016,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -14945,6 +15040,11 @@ Learn more at teamwork.com.`} "schema": "integer", "description": "filter by maximum budget capacity used" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -15116,7 +15216,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "fields[workflows]", @@ -15212,7 +15312,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -15235,7 +15335,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -15278,7 +15378,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -15288,7 +15388,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -15337,7 +15437,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -15397,7 +15497,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -15494,7 +15594,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -15575,7 +15675,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -15594,7 +15694,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -15637,7 +15737,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -15647,7 +15747,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -15696,7 +15796,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -15756,7 +15856,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -15853,7 +15953,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -15934,7 +16034,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -15953,7 +16053,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -15996,7 +16096,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -16006,7 +16106,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -16055,7 +16155,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -16115,7 +16215,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -16212,7 +16312,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -16293,7 +16393,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -16312,7 +16412,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -16355,7 +16455,7 @@ Learn more at teamwork.com.`} { "name": "dueBeforeDate", "schema": "string", - "description": "filter by due before date (https://apidocs.teamwork.com/" + "description": "filter by due before date (deprecated, use dueBefore)" }, { "name": "dueBefore", @@ -16365,7 +16465,7 @@ Learn more at teamwork.com.`} { "name": "dueAfterDate", "schema": "string", - "description": "filter by due after date (https://apidocs.teamwork.com/" + "description": "filter by due after date (deprecated, use dueAfter)" }, { "name": "dueAfter", @@ -16414,7 +16514,7 @@ Learn more at teamwork.com.`} { "name": "progress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -16474,7 +16574,7 @@ Learn more at teamwork.com.`} { "name": "includeProgress", "schema": "boolean", - "description": "include percentage of tasks completed for all linked tasklists (https://apidocs.teamwork.com/", + "description": "include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete)", "default": "false" }, { @@ -16571,7 +16671,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "filter by list of project health (https://apidocs.teamwork.com/" + "description": "filter by list of project health (deprecated, use projectHealths)" }, { "name": "projectCompanyIds", @@ -16652,7 +16752,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -16829,6 +16929,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -17322,7 +17427,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -17499,6 +17604,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -17992,7 +18102,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -18169,6 +18279,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -18662,7 +18777,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -18839,6 +18954,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -19332,7 +19452,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -19398,13 +19518,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -19482,7 +19602,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -19605,13 +19725,13 @@ Learn more at teamwork.com.`} { "name": "pageSize", "schema": "integer", - "description": "number of items in a page (https://apidocs.teamwork.com/", + "description": "number of items in a page (not used when generating reports)", "default": "50" }, { "name": "page", "schema": "integer", - "description": "page number (https://apidocs.teamwork.com/", + "description": "page number (not used when generating reports)", "default": "1" }, { @@ -19689,7 +19809,7 @@ Learn more at teamwork.com.`} { "name": "include", "schema": "array", - "description": "include (https://apidocs.teamwork.com/" + "description": "include (not used when generating reports)" }, { "name": "ids", @@ -19774,7 +19894,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/", + "description": "sort by (deprecated, use orderBy)", "default": "name" }, { @@ -19893,7 +20013,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -19928,7 +20048,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/", + "description": "sort by (deprecated, use orderBy)", "default": "name" }, { @@ -20047,7 +20167,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -20082,7 +20202,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/", + "description": "sort by (deprecated, use orderBy)", "default": "name" }, { @@ -20201,7 +20321,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -20236,7 +20356,7 @@ Learn more at teamwork.com.`} { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/", + "description": "sort by (deprecated, use orderBy)", "default": "name" }, { @@ -20355,7 +20475,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "200", - "description": "200 OK (https://apidocs.teamwork.com/" + "description": "200 OK (no data)" }, { "statusCode": "400", @@ -20374,7 +20494,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by risks updated after specified date (https://apidocs.teamwork.com/" + "description": "filter by risks updated after specified date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -20384,12 +20504,12 @@ Learn more at teamwork.com.`} { "name": "sortOrder", "schema": "string", - "description": "sort order (https://apidocs.teamwork.com/" + "description": "sort order (deprecated, use orderMode)" }, { "name": "sort", "schema": "string", - "description": "sort by (https://apidocs.teamwork.com/" + "description": "sort by (deprecated, use orderBy)" }, { "name": "searchTerm", @@ -20759,7 +20879,7 @@ Learn more at teamwork.com.`} { "name": "status", "schema": "string", - "description": "project status (https://apidocs.teamwork.com/" + "description": "project status (deprecated, use projectStatuses)" }, { "name": "projectStatus", @@ -20800,7 +20920,7 @@ Learn more at teamwork.com.`} { "name": "matchAllTags", "schema": "boolean", - "description": "enforce all tag ids must be matched (https://apidocs.teamwork.com/" + "description": "enforce all tag ids must be matched (deprecated, use matchAllProjectTags)" }, { "name": "matchAllProjectTags", @@ -20825,7 +20945,7 @@ Learn more at teamwork.com.`} { "name": "applyTaskAssigneeUsersToSince", "schema": "boolean", - "description": "the since section will only use taskAssigneeUserIds if this flag is true\n(https://apidocs.teamwork.com/" + "description": "the since section will only use taskAssigneeUserIds if this flag is true\n(keeps backward compatibility)" }, { "name": "applySinceOnUnread", @@ -20876,7 +20996,7 @@ Learn more at teamwork.com.`} { "name": "projectHealth", "schema": "array", - "description": "project healths (https://apidocs.teamwork.com/\n\n0: not set\n1: bad\n2: ok\n3: good" + "description": "project healths (deprecated, use projectHealths)\n\n0: not set\n1: bad\n2: ok\n3: good" }, { "name": "projectCompanyIds", @@ -20896,7 +21016,7 @@ Learn more at teamwork.com.`} { "name": "filterTagIds", "schema": "array", - "description": "filter by project tag ids (https://apidocs.teamwork.com/" + "description": "filter by project tag ids (deprecated, use projectTagIds)" }, { "name": "fields[unread]", @@ -20946,7 +21066,7 @@ Learn more at teamwork.com.`} { "name": "companyIds", "schema": "array", - "description": "filter by company ids (https://apidocs.teamwork.com/" + "description": "filter by company ids (deprecated, use projectCompanyIds)" }, { "name": "assigneeUserIds", @@ -21133,7 +21253,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -21145,7 +21265,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -21168,7 +21288,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -21180,7 +21300,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -21211,7 +21331,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -21251,7 +21371,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -21312,6 +21432,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "sortActiveListsFirst", "schema": "boolean", @@ -21485,6 +21610,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "sortActiveListsFirst", "schema": "boolean", @@ -21617,7 +21747,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -21629,7 +21759,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -21809,6 +21939,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -22577,6 +22712,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -23135,7 +23275,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -23147,7 +23287,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23178,7 +23318,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23253,7 +23393,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -23272,7 +23412,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -23282,7 +23422,7 @@ Learn more at teamwork.com.`} { "name": "searchTerm", "schema": "string", - "description": "filter by comment content (https://apidocs.teamwork.com/" + "description": "filter by comment content (like v1 filterText param)" }, { "name": "publishedStartDate", @@ -23377,7 +23517,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23418,6 +23558,11 @@ Learn more at teamwork.com.`} "description": "page number", "default": "1" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "skipCounts", "schema": "boolean", @@ -23515,7 +23660,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -23527,7 +23672,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23567,7 +23712,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -23601,7 +23746,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -23613,7 +23758,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23651,7 +23796,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -23698,7 +23843,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -23882,6 +24027,11 @@ Learn more at teamwork.com.`} "schema": "boolean", "description": "use start dates for todays tasks" }, + { + "name": "useFormulaFields", + "schema": "boolean", + "description": "use formula fields" + }, { "name": "useAllProjects", "schema": "boolean", @@ -24536,12 +24686,12 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -24653,7 +24803,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -24995,12 +25145,12 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", "schema": "integer", - "description": "filter by project id (https://apidocs.teamwork.com/" + "description": "filter by project id (deprecated, use projectIds)" }, { "name": "pageSize", @@ -25112,7 +25262,7 @@ Learn more at teamwork.com.`} { "name": "projectsFromCompanyId", "schema": "array", - "description": "filter by project company ids (https://apidocs.teamwork.com/" + "description": "filter by project company ids (deprecated, use projectCompanyIds)" }, { "name": "projectTagIds", @@ -25262,7 +25412,7 @@ Learn more at teamwork.com.`} { "name": "userId", "schema": "integer", - "description": "filter by user id (https://apidocs.teamwork.com/" + "description": "filter by user id (deprecated, use assignedToUserIds)" }, { "name": "tasklistId", @@ -25272,7 +25422,7 @@ Learn more at teamwork.com.`} { "name": "taskId", "schema": "integer", - "description": "filter by task id (https://apidocs.teamwork.com/" + "description": "filter by task id (deprecated, use taskIds)" }, { "name": "projectId", @@ -25308,7 +25458,7 @@ Learn more at teamwork.com.`} { "name": "userIds", "schema": "array", - "description": "filter by user ids (https://apidocs.teamwork.com/" + "description": "filter by user ids (deprecated, use assignedToUserIds)" }, { "name": "taskIds", @@ -25412,7 +25562,7 @@ Learn more at teamwork.com.`} "responses": [ { "statusCode": "204", - "description": "204 No Content (https://apidocs.teamwork.com/" + "description": "204 No Content (no data)" }, { "statusCode": "400", @@ -25424,7 +25574,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -25455,7 +25605,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -25505,7 +25655,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" }, { "statusCode": "409", @@ -25524,7 +25674,7 @@ Learn more at teamwork.com.`} { "name": "updatedAfterDate", "schema": "string", - "description": "filter by updated after date (https://apidocs.teamwork.com/" + "description": "filter by updated after date (deprecated, use updatedAfter)" }, { "name": "updatedAfter", @@ -25684,7 +25834,7 @@ Learn more at teamwork.com.`} }, { "statusCode": "404", - "description": "404 Not Found (https://apidocs.teamwork.com/" + "description": "404 Not Found (no data)" } ] }, @@ -26299,7 +26449,7 @@ Learn more at teamwork.com.`} endpoints={147} sdkMethods={188} schemas={296} - parameters={4125} + parameters={4155} difficulty="Very Hard" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/teamwork/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/teamwork/openapi.yaml"